{"info":{"_postman_id":"12b778dd-8572-4eac-831f-73e8479a46d2","name":"os.construction REST API","description":"2549 implemented operations, generated from tools/openapi/os-construction.openapi.json by tools/postman/generate.mjs.\n\nSet the collection variables: baseUrl (default https://app.os.construction), token (personal API token, service account token or OAuth access token), companyId, projectId. Writes send Idempotency-Key: {{$guid}}. Guides: https://os.construction/developers","schema":"https://schema.getpostman.com/json/collection/v2.1.0/collection.json"},"auth":{"type":"bearer","bearer":[{"key":"token","value":"{{token}}","type":"string"}]},"variable":[{"key":"baseUrl","value":"https://app.os.construction"},{"key":"token","value":""},{"key":"companyId","value":""},{"key":"projectId","value":""}],"item":[{"name":"Accounting","description":"Module: accounting","item":[{"id":"877f6a3b-f53b-4f02-8de3-2f395998c0c9","name":"listCompanyAccountingAccessReviews — List access review campaigns","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/access_reviews","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","access_reviews"],"query":[{"key":"status","value":"","disabled":true},{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true}],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"List access review campaigns\n\nCampaigns newest first with decision counts. An entity-limited grant sees only its entities' campaigns. Filter with status (open, completed, cancelled). Paginated (page, per_page). Needs manage_grants. Requires accounting:read."}},{"id":"83a60dc4-9cce-4a6e-8742-53f417ae20af","name":"createCompanyAccountingAccessReview — Open an access review campaign","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/access_reviews","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","access_reviews"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Open an access review campaign\n\nSnapshots, immutably, every accounting grant in scope (the company, or the grants that reach one entity; expired grants and inactive members included) and every company administrator: flags, entity and project scope, delegations given and received, live API tokens with an accounting scope (never the token), MFA, last accounting activity, dormancy (no activity for dormant_days, default 90) and the SoD conflicts of the person's effective duties. Every reviewer needs manage_grants over the whole scope; when a reviewer's own access is in scope a second reviewer is required. A quarterly campaign names its period (one per scope and quarter, else 409). Needs manage_grants (unrestricted for a company-wide campaign). Honors Idempotency-Key. Requires accounting:write.","body":{"mode":"raw","raw":"{\n  \"access_review\": {\n    \"due_on\": \"2026-01-31\",\n    \"kind\": \"quarterly\",\n    \"reviewer_ids\": [\n      0\n    ]\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"8ae41b6c-c4ae-4f13-8791-9dc6b5b1b3a5","name":"getCompanyAccountingAccessReview — Get an access review campaign with its snapshot","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/access_reviews/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","access_reviews",":id"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Get an access review campaign with its snapshot\n\nThe campaign, its counts and every snapshotted item with the decision recorded so far. Needs manage_grants over the campaign's scope. Requires accounting:read."}},{"id":"d93d90db-2757-4278-8a5f-a490405f1baa","name":"cancelCompanyAccountingAccessReview — Cancel an access review campaign","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/access_reviews/:id/cancel","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","access_reviews",":id","cancel"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Cancel an access review campaign\n\nCancels an open campaign with a reason; decisions already applied stand. The campaign's creator or a designated reviewer. Needs manage_grants. Requires accounting:write.","body":{"mode":"raw","raw":"{\n  \"cancel\": {\n    \"reason\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"5de3fb02-9013-4412-8eac-2a8eec114021","name":"completeCompanyAccountingAccessReview — Complete an access review campaign","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/access_reviews/:id/complete","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","access_reviews",":id","complete"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Complete an access review campaign\n\nCloses the campaign once every item is decided (422 access_review_incomplete otherwise) and stores the decision counts. The completed campaign is evidence for control objective CO-1. A designated reviewer only. Needs manage_grants. Requires accounting:write.","body":{"mode":"raw","raw":"{\n  \"complete\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"2b73a05f-ec8f-447f-8243-17d1f913b5eb","name":"decisionCompanyAccountingAccessReviewItem — Decide one access review item","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/access_reviews/:id/items/:item_id/decision","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","access_reviews",":id","items",":item_id","decision"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""},{"key":"item_id","value":"","description":"Item id"}]},"description":"Decide one access review item\n\nRecords keep, modify or revoke with a reason, once. Only a designated reviewer may decide, and never the item's own holder (403). Revoke and modify apply through the grant-change path (step-up, entity limits, no flags the reviewer lacks, segregation of duties, its own grant_changed or grant_revoked audit row) and the item records that audit event; keep stamps the grant certified when it still matches the snapshot. A company administrator's item can only be kept. drift_at_decision records that the live grant differed from the snapshot. Needs manage_grants and step-up (a token needs accounting:step_up). Requires accounting:write.","body":{"mode":"raw","raw":"{\n  \"decision\": {\n    \"decision\": \"keep\",\n    \"reason\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"fc751636-56b1-442e-86e2-b710906a3d12","name":"listCompanyAccountingAccounts — List GL accounts","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/accounts","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","accounts"],"query":[{"key":"search","value":"","disabled":true,"description":"Account number prefix or name fragment"},{"key":"filters[type]","value":"","disabled":true,"description":"Comma-separated account types"},{"key":"filters[is_active]","value":"","disabled":true,"description":"Active accounts only, or inactive only"},{"key":"filters[is_postable]","value":"","disabled":true,"description":"Postable or header accounts"},{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true},{"key":"updated_since","value":"","disabled":true,"description":"Delta sync: only rows created or changed at or after this time (ISO 8601 with offset). Switches the list to ascending (updated_at, id) order; page is ignored and Next-Cursor continues it. Re-read with a small overlap (a few seconds) and dedupe by id."},{"key":"cursor","value":"","disabled":true,"description":"Opaque keyset cursor from a previous response's Next-Cursor header; each page costs the same however deep it is."}],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"List GL accounts\n\nThe chart of accounts in number order. Filter with `filters[type]`, `filters[is_active]`, `filters[is_postable]`, or `search` (number prefix or name). Delta sync: updated_since and/or cursor return changes in ascending (updated_at, id) order with Next-Cursor. Requires the accounting:read scope."}},{"id":"6c95fa41-5d5b-4670-8446-8ab085c98f3f","name":"createCompanyAccountingAccount — Create a GL account","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/accounts","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","accounts"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Create a GL account\n\nAdds an account. Normal balance and cash-flow category default from the type. Header accounts (`is_postable: false`) group others in the tree and never take postings. Job-cost accounts set `job_cost_type` so lines with a project also write the job cost subledger. Needs manage_coa. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"account\": {\n    \"name\": \"\",\n    \"number\": \"\",\n    \"type\": \"bank\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"e8c0548b-fafd-4825-8c6e-26780263f703","name":"createCompanyAccountingAccountsApplyTemplate — Apply the construction chart of accounts","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/accounts/apply_template","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","accounts","apply_template"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Apply the construction chart of accounts\n\nAdds the numbered construction template (cash, retainage, contract assets and liabilities for under/over billings, job cost by cost type, payroll liabilities, accumulated depreciation, equity and system roles). Only missing account numbers are added, so it is safe to repeat. Needs manage_coa. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"template\": {\n    \"name\": \"construction\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"c85dc750-7c5f-40a6-8011-f00ba611b441","name":"listCompanyAccountingAccountsPacks — List industry chart-of-accounts packs","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/accounts/packs","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","accounts","packs"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"List industry chart-of-accounts packs\n\nGeneral contractor, specialty contractor, home builder, heavy civil and construction management packs: the accounts each adds to the construction template, suggested dimensions and default job cost accounts, plus the pack this company last applied. Requires the accounting:read scope."}},{"id":"065b4cac-5033-4f1c-821d-3f7dca4dc932","name":"createCompanyAccountingAccountsPacksApply — Apply a pack","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/accounts/packs/apply","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","accounts","packs","apply"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Apply a pack\n\nCreates the pack's accounts the company does not have; never renumbers, renames, retypes, remaps or removes an existing account. A company with accounts must send the preview's confirm_hash (422 pack_preview_required without it, 409 pack_preview_stale when the chart changed). create_dimensions adds the suggested dimensions as optional. Audited (pack_applied). Needs manage_coa on an unrestricted grant. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"pack\": {\n    \"key\": \"general_contractor\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"673b4f65-01eb-4f40-874b-4b2c58f3d6b6","name":"listCompanyAccountingAccountsPacksPreview — Preview a pack merge","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/accounts/packs/preview","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","accounts","packs","preview"],"query":[{"key":"pack","value":"","disabled":true}],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Preview a pack merge\n\nThe non-destructive merge of `pack` into this company's chart: accounts to create (numbers it does not have), existing accounts kept unchanged (posted or not), role mappings kept, assigned or left for manual mapping, dimensions to create, and the hash to confirm with. Needs manage_coa. Requires the accounting:read scope."}},{"id":"79f96ed6-8b32-4c90-8ffe-ded7ba10b047","name":"listCompanyAccountingAccountsTree — Chart of accounts tree","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/accounts/tree","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","accounts","tree"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Chart of accounts tree\n\nEvery account nested under its parent header account, roots in number order. Requires the accounting:read scope."}},{"id":"ab75f256-604f-4677-828f-c189cb6bb08c","name":"getCompanyAccountingAccount — Show a GL account","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/accounts/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","accounts",":id"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Show a GL account\n\nOne account of this company. Requires the accounting:read scope."}},{"id":"4c4684ab-34d9-4752-8189-1c404d8d01aa","name":"updateCompanyAccountingAccount — Update a GL account","request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/accounts/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","accounts",":id"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Update a GL account\n\nEdits an account. Once it has journal activity its type, normal balance and postable flag are fixed (reclassify with a journal entry instead). Needs manage_coa. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"account\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"e7072cb3-7b4b-46d6-8cb7-c2251d3a311b","name":"listCompanyAccountingAchMonitoring — ACH fraud-monitoring evidence","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ach/monitoring","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ach","monitoring"],"query":[{"key":"from","value":"","disabled":false},{"key":"to","value":"","disabled":false}],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"ACH fraud-monitoring evidence\n\nNeeds manage_vendor_banking. Evidence for Nacha's risk-based fraud monitoring (non-consumer Originators, effective 2026-06-22) over a window: controls in force, vendor and employee bank-account changes and NOC applications, prenote and block records, returns by code (unauthorized R05/R07/R10/R29 counted), NOC timeliness and the notices. Masks only. Requires the accounting:read scope. Entity-wide: a project-scoped (project_manager_view) grant gets 403."}},{"id":"ace54cd4-bacf-4a24-8926-ca95a2005ae0","name":"listCompanyAccountingAchNotices — ACH returns and NOCs","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ach/notices","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ach","notices"],"query":[{"key":"status","value":"","disabled":true,"description":"Only notices in this status; any other value is 422."},{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true}],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"ACH returns and NOCs\n\nNeeds manage_vendor_banking. Newest first, up to 500; filter with status (open, applied, manual, unmatched). Corrected NOC data stays encrypted and is never returned. Newest first, paged in the database with the caller's entity scope applied (Total, Per-Page and Link headers). Requires the accounting:read scope. Entity-wide: a project-scoped (project_manager_view) grant gets 403."}},{"id":"d54b5ea7-7e47-4ff4-8ae0-bc73f573077a","name":"createCompanyAccountingAchNotice — Import an ACH return/NOC file","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ach/notices","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ach","notices"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Import an ACH return/NOC file\n\nNeeds manage_vendor_banking (plus release_payments for AP returns, payroll_run for payroll returns). A NACHA return/COR file (entries with addenda 99/98) or a bank CSV (code, original_trace, id_number, amount, corrected_data, optional trace_number). A return on an AP payment reverses it dated received_date (closed period refused), reopens its bills with an ach_returned hold and, for R02/R03/R04/R07/R10/R12/R14/R15/R16/R20/R23/R29, blocks that bank account; a return on a paycheck posts Dr payroll cash / Cr payroll clearing (net pay owed again); a returned prenote blocks the account. NOCs are queued with their six-banking-day due date. Idempotent: notices already imported are counted in skipped. Requires the accounting:write scope. Entity-wide: a project-scoped (project_manager_view) grant gets 403. A grant with neither manage_vendor_banking nor payroll_run (for example a view-only role) gets 403 before anything is written, even for a file whose notices were all imported already, and so does a read-only workspace.","body":{"mode":"raw","raw":"{\n  \"ach_import\": {\n    \"content\": \"\",\n    \"format\": \"nacha\",\n    \"received_date\": \"2026-01-31\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"2e45deb7-fbe5-4c8d-87a1-ae8a48f393ef","name":"createCompanyAccountingAchNoticesApplyNoc — Apply NOCs","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ach/notices/apply_nocs","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ach","notices","apply_nocs"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Apply NOCs\n\nNeeds manage_vendor_banking (payroll_run for employee NOCs). Applies the open C01/C02/C03/C05 NOCs named in ids (required, at least one: there is no apply-all; an empty list is 422 noc_ids_required) to the vendor or employee bank record and records the corrected account as verified, so the next file pays it. Needs step-up (a token needs the accounting:step_up scope, 403 step_up_required). The importer can't apply (403 sod_noc). Audited per notice (noc_applied) with masks only; the response carries each notice's masked old -> new routing and account last 4 (changes). Requires the accounting:write scope. Entity-wide: a project-scoped (project_manager_view) grant gets 403. A grant with neither manage_vendor_banking nor payroll_run (for example a view-only role) gets 403 before anything is written, even for a file whose notices were all imported already, and so does a read-only workspace.","body":{"mode":"raw","raw":"{\n  \"apply\": {\n    \"ids\": [\n      0\n    ]\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"2ff7fce6-f3b5-4097-8814-33c7abe1d89e","name":"resolveCompanyAccountingAchNotice — Resolve a manual NOC","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ach/notices/:id/resolve","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ach","notices",":id","resolve"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Resolve a manual NOC\n\nNeeds manage_vendor_banking. Marks a C04/C06/C07 NOC (status manual) applied after the bank record was corrected by hand; the importer can't resolve it (403 sod_noc). Needs step-up (a token needs the accounting:step_up scope, 403 step_up_required). Requires the accounting:write scope. Entity-wide: a project-scoped (project_manager_view) grant gets 403. A grant with neither manage_vendor_banking nor payroll_run (for example a view-only role) gets 403 before anything is written, even for a file whose notices were all imported already, and so does a read-only workspace.","body":{"mode":"raw","raw":"{\n  \"resolve\": {\n    \"reason\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"9a13af07-45df-4c3d-8a61-06a2de873f8b","name":"createCompanyAccountingAchPrenote — Generate a prenote file","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ach/prenotes","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ach","prenotes"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Generate a prenote file\n\nVendors need manage_vendor_banking and bank_account_id (the ODFI); employees need payroll_run and view_payroll_pii over every entity. Zero-dollar prenote entries (transaction code 23/33) for every ACH vendor or direct-deposit employee whose current account has no prenote, verification or block; vendor batches use the SEC code from bank_account_ownership. Records the settlement date and the earliest live date (third banking day after, Nacha Rules 2.6). 422 nothing_to_prenote when none is due. Returns the NACHA text with X-Prenote-Count and X-Earliest-Live-Date headers. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"prenote\": {\n    \"effective_date\": \"2026-01-31\",\n    \"kind\": \"vendor\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"bd1960ef-6e2d-464a-847e-f5972722be8c","name":"createCompanyAccountingAllocationRun — Post an allocation run","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/allocation_runs","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","allocation_runs"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Post an allocation run\n\nSpreads `amount` (the pool) across job targets by `basis` with largest-remainder rounding, so the shares always add up to the pool. Posts one balanced `JC` entry (source `allocation_run`): a debit per target on its `account_id` (else `target_account_id`) tagged with the target project and optional cost code, and a credit to `pool_account_id`. A negative pool swaps the sides. Job-cost accounts write job cost rows. `fixed_pct` bases must total 100. Control accounts are refused. The pool account must be an expense, cost of revenue or other expense account and every target account a job cost account (422 otherwise). At or above the approval threshold (settings require_approval_above; null = every amount), or when an active journal_entry approval rule matches, the run is not posted: it is saved as a pending_approval journal entry with its approval route and answered 202. A second person approves it (journal_entries/{id}/approve; the preparer cannot) and a close_period holder posts it (journal_entries/{id}/post). Needs close_period. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"amount\": \"\",\n  \"auto_reverse_date\": \"2026-01-31\",\n  \"basis\": \"labor_hours\",\n  \"date\": \"2026-01-31\",\n  \"entity_id\": 0,\n  \"memo\": \"\",\n  \"pool_account_id\": 0,\n  \"pool_dimension_value_ids\": [\n    0\n  ],\n  \"target_account_id\": 0,\n  \"targets\": [\n    {\n      \"basis\": \"\",\n      \"project_id\": 0\n    }\n  ]\n}","options":{"raw":{"language":"json"}}}}},{"id":"852f58ab-18b5-425d-8d84-b6d069aede01","name":"reverseCompanyAccountingAllocationRun — Reverse an allocation run","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/allocation_runs/:id/reverse","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","allocation_runs",":id","reverse"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Reverse an allocation run\n\n`id` is the allocation run's journal entry id (`journal_entry.id` from POST allocation_runs). Posts the mirror entry on `date`; the reversal writes negating job cost rows. Repeating the call returns the same reversal. Needs post_journal and close_period; at or above the approval threshold the reverser must hold approve_journal and must not have prepared the run. An entry of any other source is 404. Emits `accounting.journal_entry.reversed`. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"reversal\": {\n    \"date\": \"2026-01-31\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"504d3e78-4e72-4dbb-8fce-dfa7c6352caa","name":"listCompanyAccountingApAging — AP aging as of a date","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ap/aging","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ap","aging"],"query":[{"key":"as_of","value":"","disabled":true},{"key":"basis","value":"","disabled":true}],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"AP aging as of a date\n\nRebuilt from documents and dated applications, so a past aging re-performs exactly. Retainage is aged separately. Requires the accounting:read scope. Entity-wide: a project-scoped (project_manager_view) grant gets 403."}},{"id":"76afbfe3-91b5-4beb-868b-2a96ac79c1f6","name":"listCompanyAccountingApAutomationSettings — Get AP automation settings","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ap/automation/settings","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ap","automation","settings"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Get AP automation settings\n\nCapture address and allow list, vendor portal, remittance and virtual card settings. A project-scoped grant gets 403. Requires the accounting:read scope."}},{"id":"862fe5db-aea2-4b65-833a-6ace8be856e8","name":"updateCompanyAccountingApAutomationSettings — Update AP automation settings","request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ap/automation/settings","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ap","automation","settings"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Update AP automation settings\n\nNeeds manage_coa. Virtual card fields also need release_payments and step-up; enabling virtual cards needs a non-control liability clearing account and an active bank (not card) funding account. rotate_capture_address issues a new capture address at once. Audited with the values before and after. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"automation_settings\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"0d06f94d-39ea-43b1-8082-17739c605097","name":"listCompanyAccountingApBackupNotices — List CP2100 B notices","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ap/backup_notices","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ap","backup_notices"],"query":[{"key":"vendor_id","value":"","disabled":true}],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"List CP2100 B notices\n\nB notice records, newest first. Filter with vendor_id. Requires the accounting:read scope."}},{"id":"10912406-81b7-4739-8ea7-455df1ca877c","name":"createCompanyAccountingApBackupNotice — Record a CP2100 B notice","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ap/backup_notices","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ap","backup_notices"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Record a CP2100 B notice\n\nRecords a vendor listed on an IRS CP2100/CP2100A notice. notice_date is the CP2100 date or the date received, whichever is later. The letter is due within 15 business days, and 24% backup withholding applies to AP payments dated on or after notice_date + 30 IRS business days until the notice is cured (Pub 1281). notice_number defaults to 2 when the vendor already had a notice in the same or the two preceding calendar years. Needs ap_enter; audited. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"backup_notice\": {\n    \"notice_date\": \"2026-01-31\",\n    \"vendor_id\": 0\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"cae6cba1-81f1-4d68-8a65-506caf8e6ea8","name":"updateCompanyAccountingApBackupNotice — Mark a B notice letter sent or record the cure","request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ap/backup_notices/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ap","backup_notices",":id"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Mark a B notice letter sent or record the cure\n\nletter_sent_at records the mailing date (ap_enter). cured_at with cure_kind stops backup withholding from that date and needs manage_vendor_banking: a first notice is cured only by a signed W-9 (w9); a second notice only by SSA or IRS validation (ssa_card, letter_147c, letter_685c, letter_096c), otherwise 422 cure_not_allowed. A cure is final (409 already_cured). Audited. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"backup_notice\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"0870a760-c2e1-4ebd-8c31-aa33f6497b4e","name":"listCompanyAccountingApBackupNoticeLetter — B notice letter","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ap/backup_notices/:id/letter","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ap","backup_notices",":id","letter"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"B notice letter\n\nThe first or second B notice letter header for the vendor (reply-by date, account number, name, masked TIN, 24% rate) and the opening paragraph of the IRS text (Pub 1281 Rev. 12-2023, Part 4). Enclose the rest of the IRS notice text (and Form W-9 for a first notice); mail it in an envelope marked IMPORTANT TAX INFORMATION ENCLOSED. Requires the accounting:read scope."}},{"id":"41c50328-6a87-4f0c-8c5a-5e663774d7c1","name":"listCompanyAccountingApBills — List bills and vendor credits","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ap/bills","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ap","bills"],"query":[{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true},{"key":"filters[status]","value":"","disabled":true},{"key":"filters[kind]","value":"","disabled":true},{"key":"vendor_id","value":"","disabled":true},{"key":"project_id","value":"","disabled":true},{"key":"due_by","value":"","disabled":true},{"key":"search","value":"","disabled":true},{"key":"updated_since","value":"","disabled":true,"description":"Delta sync: only rows created or changed at or after this time (ISO 8601 with offset). Switches the list to ascending (updated_at, id) order; page is ignored and Next-Cursor continues it. Re-read with a small overlap (a few seconds) and dedupe by id."},{"key":"cursor","value":"","disabled":true,"description":"Opaque keyset cursor from a previous response's Next-Cursor header; each page costs the same however deep it is."}],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"List bills and vendor credits\n\nFilters: filters[status], filters[kind], vendor_id, project_id, due_by, search. Paginated (Total, Per-Page headers). Requires the accounting:read scope. Entity-wide: a project-scoped (project_manager_view) grant gets 403."}},{"id":"7f82ce61-00cd-45f6-8845-b3739ee33132","name":"createCompanyAccountingApBill — Create a draft bill or vendor credit","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ap/bills","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ap","bills"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Create a draft bill or vendor credit\n\nNeeds ap_enter. Retainage defaults from the commitment, then the vendor profile; due and discount dates from terms. A suspected duplicate (same vendor, normalized invoice number) returns 409 duplicate_suspected unless an ap_approve user sends duplicate_override_reason (audited). A vendor inactive in the directory returns 409 vendor_inactive unless an ap_approve user sends inactive_vendor_override_reason (audited). Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"bill\": {\n    \"invoice_date\": \"2026-01-31\",\n    \"lines\": [\n      {\n        \"account_id\": 0,\n        \"amount\": \"\"\n      }\n    ],\n    \"vendor_id\": 0\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"4a4afcc3-1b4c-497f-8c06-0d227eb4faa1","name":"createCompanyAccountingApBillsFromSource — Draft a bill from a requisition or direct cost","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ap/bills/from_source","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ap","bills","from_source"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Draft a bill from a requisition or direct cost\n\nApproved subcontract requisition → draft bill for the period delta (never the cumulative claim), coded to the subcontract job cost account; approved direct cost → draft bill by line type. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"source\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"6e04bd26-ce56-4799-8576-93eaaa8b79b8","name":"getCompanyAccountingApBill — Show a bill","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ap/bills/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ap","bills",":id"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Show a bill\n\nLines, approvals for the current revision, applications, retainage releases, current payment holds and the approval route preview. Requires the accounting:read scope."}},{"id":"7c642ded-6714-4a94-8791-55f9f571acba","name":"updateCompanyAccountingApBill — Edit a draft or pending bill","request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ap/bills/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ap","bills",":id"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Edit a draft or pending bill\n\nEvery PATCH, including a partial header-only edit, requires bill.expected_revision from the last read. Missing or invalid tokens return 422; a stale token returns 409 stale_revision without changing the bill. Reload and review before retrying. Any edit bumps the revision and returns the bill to draft; approvals of earlier revisions no longer count. Replacing lines or changing tax_code_id recalculates use_tax_amount; tax_code_id null while a line has use_tax returns 422. Needs ap_enter. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"bill\": {\n    \"expected_revision\": 0\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"9aa16fb3-6363-40ec-8f5f-44e03d3c28fd","name":"deleteCompanyAccountingApBill — Delete a draft bill","request":{"method":"DELETE","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ap/bills/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ap","bills",":id"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Delete a draft bill\n\nNeeds ap_enter. Requires the accounting:write scope."}},{"id":"233e471f-9eaf-47e5-8b27-51ab9ffdd0ca","name":"applyCreditCompanyAccountingApBill — Apply a vendor credit to a bill","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ap/bills/:id/apply_credit","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ap","bills",":id","apply_credit"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Apply a vendor credit to a bill\n\nThe path id is the credit. Same vendor, both posted; no GL effect. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"application\": {\n    \"amount\": \"\",\n    \"bill_id\": 0,\n    \"date\": \"2026-01-31\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"a1ba1a7b-0ecd-4398-8af0-5e172a0f4ed5","name":"approveCompanyAccountingApBill — Approve a bill","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ap/bills/:id/approve","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ap","bills",":id","approve"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Approve a bill\n\nNeeds ap_approve. Segregation of duties: the preparer or last editor cannot approve (403 sod_maker_checker); one vote per user per revision (409 already_approved). The route comes from the lowest-priority active ap_bill approval rule matching the bill (amount, entity, project, vendor risk); with none, amount bands set the number of approvals and the final approver role. The route is snapshotted at submit. A caller not on the current step gets 403 approver_role_required unless an active delegation lets them act for someone who is. The final approval posts the bill (Dr cost / Cr AP / Cr retainage payable, use tax accrual) in the same transaction; a match exception returns 409 match_exception. In small-team SoD mode (settings sod_mode) a maker may approve their own document by sending approve.reason; the event is audited as self_approved and listed by approvals/self_approved. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"approve\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"a4142c50-047b-4f82-8fef-edd67e994619","name":"listCompanyAccountingApBillAttachments — List attachments on a bill","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ap/bills/:id/attachments","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ap","bills",":id","attachments"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"List attachments on a bill\n\nOldest first. Needs view_ledger and the parent's entity scope. Requires the accounting:read scope."}},{"id":"b65508f4-3ec1-4227-84c8-2fe809fdb581","name":"createCompanyAccountingApBillAttachment — Attach a file to a bill","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ap/bills/:id/attachments","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ap","bills",":id","attachments"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Attach a file to a bill\n\nMultipart upload (one `file` part, allow-listed type, up to MAX_UPLOAD_BYTES). Allowed after posting: attachments are not ledger data. Writes an attachment_added audit event on the parent in the same transaction. Needs ap_enter and the parent's entity scope. Requires the accounting:write scope.","body":{"mode":"formdata","formdata":[{"key":"file","type":"file","src":[]}]}}},{"id":"f1188bcb-fad4-4abb-8965-1e1749b02e3f","name":"overrideHoldCompanyAccountingApBill — Override a hold","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ap/bills/:id/override_hold","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ap","bills",":id","override_hold"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Override a hold\n\nNeeds ap_approve (and release_payments for payment holds). Audited with the reason. The preparer cannot override; the bank-change cool-off cannot be overridden. Requires the accounting:write scope. expires_at (optional date) limits the override to pay dates on or before it, so a later lapse holds again. Code match_exception also overrides every open three-way match exception on the bill (each audited with the reason).","body":{"mode":"raw","raw":"{\n  \"override\": {\n    \"code\": \"\",\n    \"reason\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"2e496922-e93f-498e-8bf5-190bd9298a56","name":"rejectCompanyAccountingApBill — Reject a bill (return to the preparer)","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ap/bills/:id/reject","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ap","bills",":id","reject"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Reject a bill (return to the preparer)\n\nNeeds ap_approve and the bill's entity. A pending_approval bill returns to draft with a new revision, so votes on the rejected revision are spent and resubmission routes afresh. The reason is required and audited (action rejected); the preparer sees it in their approvals inbox. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"reject\": {\n    \"reason\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"dbae4a8d-c5bd-4886-810f-dc8c26f68191","name":"releaseRetainageCompanyAccountingApBill — Release retainage payable","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ap/bills/:id/release_retainage","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ap","bills",":id","release_retainage"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Release retainage payable\n\nNeeds ap_approve. Posts Dr retainage payable / Cr AP. A final release needs the vendor's conditional final, prior unconditional progress and every lower tier's unconditional final waiver (422 missing_closeout_docs); pay-when-paid bills need owner_released. Send an Idempotency-Key: a retried partial release otherwise releases twice. Void a release with POST ap/retainage_releases/{id}/void. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"release\": {\n    \"date\": \"2026-01-31\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"41676157-30a0-4232-85df-d51438a072bf","name":"rematchCompanyAccountingApBill — Re-run the three-way match","request":{"method":"POST","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ap/bills/:id/rematch","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ap","bills",":id","rematch"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Re-run the three-way match\n\nRe-evaluates a bill pending approval on live figures (receipts, other posted bills, approved change orders, the current match policy): exceptions no longer found are resolved (re_evaluated), new ones open and hold the bill. Receipts, bill posts and voids on the same commitment do this automatically. Needs ap_enter. 422 not_pending for any other status. Requires the accounting:write scope."}},{"id":"bd1b33e5-c91a-4e8f-8881-8beee72d7457","name":"submitCompanyAccountingApBill — Submit a bill for approval","request":{"method":"POST","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ap/bills/:id/submit","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ap","bills",":id","submit"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Submit a bill for approval\n\nRuns the commitment / three-way match and stores the result; over-commitment with action block returns 409. Resolves and snapshots the approval route (409 approver_unresolved when no project-team member for a project-role step can approve, or a named user approver prepared the bill or lacks the approve grant). Requires the accounting:write scope."}},{"id":"4e803c9e-6c5f-4de3-8300-db58c9abcfd2","name":"unapplyCreditCompanyAccountingApBill — Undo a vendor credit application","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ap/bills/:id/unapply_credit","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ap","bills",":id","unapply_credit"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Undo a vendor credit application\n\nThe path id is the credit. Reopens the credit and the bill as of `date` (on or after the application date), so either can be voided; as-of aging before that date still shows the application. No GL effect. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"application\": {\n    \"application_id\": 0,\n    \"date\": \"2026-01-31\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"7686a831-e9b4-47ff-8d25-d42172f9e878","name":"voidCompanyAccountingApBill — Void a posted bill","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ap/bills/:id/void","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ap","bills",":id","void"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Void a posted bill\n\nNeeds ap_approve. Posts a reversing entry on the given date (must be in an open period). Bills with payments, credit applications or retainage releases return 409. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"void\": {\n    \"date\": \"2026-01-31\",\n    \"reason\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"2d675ff9-0bf1-4987-8346-01dc14faae99","name":"listCompanyAccountingApCaptureDocuments — List the capture inbox","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ap/capture/documents","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ap","capture","documents"],"query":[{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true},{"key":"status","value":"","disabled":true},{"key":"source","value":"","disabled":true},{"key":"search","value":"","disabled":true},{"key":"vendor_id","value":"","disabled":true},{"key":"assigned_to_id","value":"","disabled":true},{"key":"unassigned","value":"","disabled":true}],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"List the capture inbox\n\nCaptured bill documents, oldest first. Filters: status (comma-separated new, in_progress, drafted, rejected), source (upload, email, portal), vendor_id (keyed or suggested), assigned_to_id, unassigned=true, search (number, invoice number, sender, file name). Paginated (Total, Per-Page, Link). Requires the accounting:read scope."}},{"id":"56c66521-7b61-4736-8067-03d4178a6567","name":"createCompanyAccountingApCaptureDocument — Upload a bill document to the capture inbox","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ap/capture/documents","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ap","capture","documents"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Upload a bill document to the capture inbox\n\nOne file (multipart field file; optional kind invoice | pay_app and notes) under the accounting attachment size and type rules. Needs ap_enter. The document is checked for duplicates by file hash at once (and by vendor + invoice number once keyed). Nothing is read out of the file: there is no OCR or AI extraction. Requires the accounting:write scope.","body":{"mode":"formdata","formdata":[{"key":"file","type":"file","src":[]},{"key":"kind","value":"","type":"text"},{"key":"notes","value":"","type":"text"}]}}},{"id":"fbb3977e-4c16-4129-8feb-bca08a045822","name":"getCompanyAccountingApCaptureDocument — Get a captured document","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ap/capture/documents/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ap","capture","documents",":id"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Get a captured document\n\nWith its duplicate findings, keyed header, assignment and the bill drafted from it. Requires the accounting:read scope."}},{"id":"940a4efe-bd58-49c7-8046-64b3f67c35ab","name":"updateCompanyAccountingApCaptureDocument — Key, assign or progress a captured document","request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ap/capture/documents/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ap","capture","documents",":id"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Key, assign or progress a captured document\n\nNeeds ap_enter. Keying vendor, invoice number, date or amount moves a new document to in_progress and re-runs the duplicate check. The assignee must be an active user who can enter AP bills. A drafted or rejected document is final (409 capture_closed). Audited with the values before and after. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"captured_document\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"7192fed0-2929-4ed5-8654-5bc6444ef878","name":"draftBillCompanyAccountingApCaptureDocument — Draft a bill from a captured document","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ap/capture/documents/:id/draft_bill","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ap","capture","documents",":id","draft_bill"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Draft a bill from a captured document\n\nNeeds ap_enter. The AP bill body with the clerk's manual coding; vendor_id and invoice_date default to the keyed header, invoice_number too. The bill must name the keyed vendor (422 vendor_mismatch) and, when an amount was keyed, its lines must total it (422 amount_mismatch). The usual vendor + invoice number duplicate check applies (409 duplicate_suspected unless an AP approver overrides). Creates an unapproved draft bill with a copy of the file, closes the document as drafted, and audits both; the drafter is a maker of the bill and cannot approve it. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"bill\": {\n    \"lines\": [\n      {\n        \"account_id\": 0,\n        \"amount\": \"\"\n      }\n    ]\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"468be566-336d-4f9c-8f8f-ae82d09e5a43","name":"listCompanyAccountingApCaptureDocumentFile — Download a captured file","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ap/capture/documents/:id/file","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ap","capture","documents",":id","file"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Download a captured file\n\nAlways sent as an attachment (application/octet-stream), never rendered inline. Requires the accounting:read scope."}},{"id":"a10a1159-7568-4c9b-8993-3e17787d73f3","name":"rejectCompanyAccountingApCaptureDocument — Reject a captured document","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ap/capture/documents/:id/reject","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ap","capture","documents",":id","reject"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Reject a captured document\n\nNeeds ap_enter and a reason (3-500 characters). Final; audited. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"reject\": {\n    \"reason\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"6125c67e-ed81-41a2-8af4-7990622e9206","name":"listCompanyAccountingApCaptureDocumentSuggestions — Coding suggestions for a captured document","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ap/capture/documents/:id/suggestions","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ap","capture","documents",":id","suggestions"],"query":[{"key":"vendor_id","value":"","disabled":true}],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Coding suggestions for a captured document\n\nFixed rules only (no model): the vendor (keyed, the portal grant's vendor, or the sender rule), the coding of its last 50 posted bills in the caller's entities ranked by bills that used it then recency, its default expense account, and its open purchase order and subcontract lines (amount less posted billing). vendor_id overrides the vendor. Requires the accounting:read scope."}},{"id":"0fe33263-c12a-4b3c-8cdc-cbaf481516c6","name":"reprintCompanyAccountingApCheck — Reprint a check under a new number","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ap/checks/:id/reprint","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ap","checks",":id","reprint"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Reprint a check under a new number\n\nNeeds release_payments. Voids the AP check's register row (positive pay sends the void when the issue was sent) and registers the same check under the bank account's next check number; the payment and its journal entry are unchanged. Audited. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"reprint\": {\n    \"reason\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"61fcd6d8-1f04-4688-8d39-5adfafd19fcc","name":"listCompanyAccountingApComplianceRequirements — List compliance requirements","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ap/compliance_requirements","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ap","compliance_requirements"],"query":[{"key":"vendor_id","value":"","disabled":true}],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"List compliance requirements\n\nRequirements that apply to every vendor, one vendor or one commitment. vendor_id narrows to that vendor's and the company-wide ones. Requires the accounting:read scope."}},{"id":"6cdfef20-4818-4023-81e0-ae0815447017","name":"createCompanyAccountingApComplianceRequirement — Require a compliance document","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ap/compliance_requirements","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ap","compliance_requirements"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Require a compliance document\n\nNeeds ap_approve. A vendor (or every vendor when vendor_id is null, or the vendor on a commitment) must keep a current, active record of this kind; otherwise its bills carry the compliance_missing payment hold. Audited. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"compliance_requirement\": {\n    \"kind\": \"coi\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"b6a6c93d-28ad-4039-8526-9f673a245c0c","name":"deleteCompanyAccountingApComplianceRequirement — Drop a compliance requirement","request":{"method":"DELETE","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ap/compliance_requirements/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ap","compliance_requirements",":id"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Drop a compliance requirement\n\nNeeds ap_approve. Audited. Requires the accounting:write scope."}},{"id":"e8dc66a0-3865-4728-83da-2bfe962e681c","name":"listCompanyAccountingApForm1099 — 1099 review","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ap/form_1099","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ap","form_1099"],"query":[{"key":"year","value":"","disabled":true},{"key":"entity_id","value":"","disabled":true,"description":"Only this payer entity. Each entity is its own payer: forms are per (entity, vendor) with the threshold per payer."}],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"1099 review\n\nPayments to 1099 vendors by payment date: AP payments plus posted banking checks and withdrawals to 1099 vendors (expense-coded lines with reportable_1099; card charges are 1099-K and excluded), line-level reportable overrides, the 2026 $2,000 NEC threshold, backup withholding in box 4. Forms are grouped per payer entity and vendor. Requires the accounting:read scope. Corporations and exempt payees (W-9 tax_classification) get no NEC/MISC; owner-direct payments are excluded. explain names each source document."}},{"id":"4d8df8be-30b9-47eb-8c9c-9d946c15b0df","name":"listCompanyAccountingApForm1099CopyB — 1099 recipient Copy B","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ap/form_1099/copy_b","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ap","form_1099","copy_b"],"query":[{"key":"year","value":"","disabled":false},{"key":"entity_id","value":"","disabled":false},{"key":"vendor_id","value":"","disabled":false}],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"1099 recipient Copy B\n\nPDF statement for one vendor from one payer entity: the payer's full EIN and the recipient's truncated TIN, marked CORRECTED when the live amounts differ from what was filed. manage_vendor_banking; audited. Requires the accounting:read scope."}},{"id":"4dc3fdd6-ea96-4b3b-898f-ab024a2b4c75","name":"createCompanyAccountingApForm1099Iri — Export 1099s as IRIS Taxpayer Portal CSV files","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ap/form_1099/iris","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ap","form_1099","iris"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Export 1099s as IRIS Taxpayer Portal CSV files\n\nBuilds the IRIS Taxpayer Portal CSV upload (IRS Pub 5717 Rev. 9-2026) for one form type from the year's 1099 data (W-9 tax classification applied; owner-direct payments excluded). Pass the header row of the CSV template downloaded from the portal for that tax year and form; it is written back byte for byte and each column is filled by name. Returns are split into files of at most 250 (Pub 5717 §3.5.1). A missing payee TIN (tin_missing), an unknown required template column, or corrected: true (portal corrections go through Make a Correction, iris_correction_portal_only) is refused with 422. Payee TINs are decrypted, so it needs manage_vendor_banking; every export is audited. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"iris\": {\n    \"form\": \"NEC\",\n    \"template\": \"\",\n    \"year\": 0\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"a039a6ad-83e1-4959-8235-323e89ab662d","name":"createCompanyAccountingApForm1099Pub1220 — Export 1099s as an IRS Pub 1220 file","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ap/form_1099/pub1220","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ap","form_1099","pub1220"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Export 1099s as an IRS Pub 1220 file\n\nBuilds the FIRE file for one form type from the year's 1099 data (W-9 tax classification applied; owner-direct payments excluded). Payee TINs are decrypted, so it needs manage_vendor_banking; every export is audited. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"pub1220\": {\n    \"form\": \"NEC\",\n    \"transmitter\": {\n      \"address\": \"\",\n      \"city\": \"\",\n      \"company_name\": \"\",\n      \"contact_email\": \"\",\n      \"contact_name\": \"\",\n      \"contact_phone\": \"\",\n      \"name\": \"\",\n      \"state\": \"\",\n      \"tcc\": \"\",\n      \"tin\": \"\",\n      \"zip\": \"\"\n    },\n    \"year\": 0\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"514c6252-a999-4fe5-840a-1ea413eef0dd","name":"listCompanyAccountingApForm945 — Form 945 data","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ap/form_945","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ap","form_945"],"query":[{"key":"year","value":"","disabled":true},{"key":"entity_id","value":"","disabled":false},{"key":"lookback_liability","value":"","disabled":true}],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Form 945 data\n\nForm 945 for one entity (each EIN files its own; entity_id is required). Line 2 is the backup withholding on posted AP payments dated in the year (the liability date is the payment date); line 4 is the debits to the backup withholding account outside reversals (deposits). The deposit schedule comes from line 3 of the second preceding year (computed from the same data, or pass lookback_liability): monthly if 50,000.00 or less, otherwise semiweekly, with the 100,000.00 next-day rule (26 CFR 31.6302-4). Under 2,500.00 for the year no deposits are listed (pay with the return). ledger_withheld is the account's withholding credits less reversals; a difference from line 2 is reported in warnings as withholding_account_mismatch. Requires the accounting:read scope."}},{"id":"f6d6d955-433b-42e5-8383-1a98bbab495d","name":"createCompanyAccountingApForm945Eftp — EFTPS 945 deposits","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ap/form_945/eftps","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ap","form_945","eftps"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"EFTPS 945 deposits\n\nEFTPS ACH-credit deposit records for the computed Form 945 deposits: tax type 09455, tax period end December 31, TXP addenda with the total. 422 entity_ein_missing when the entity has no EIN; 422 no_945_deposits when nothing is due (under 2,500.00: pay with the return). The entity EIN is decrypted, so it needs manage_vendor_banking; every export is audited (eftps_945_exported). Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"form_945\": {\n    \"entity_id\": 0,\n    \"year\": 0\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"07b91fc3-d655-4aaf-8834-18e0ab60a60f","name":"listCompanyAccountingApMatchExceptions — List three-way match exceptions","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ap/match_exceptions","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ap","match_exceptions"],"query":[{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true},{"key":"status","value":"","disabled":true,"description":"open, resolved, overridden (comma-separated)"},{"key":"type","value":"","disabled":true,"description":"qty_over, price_over, no_receipt, no_po, over_commitment (comma-separated)"},{"key":"vendor_id","value":"","disabled":true},{"key":"project_id","value":"","disabled":true},{"key":"entity_id","value":"","disabled":true},{"key":"bill_id","value":"","disabled":true},{"key":"min_age","value":"","disabled":true,"description":"Days since detection, at least"},{"key":"max_age","value":"","disabled":true,"description":"Days since detection, at most"}],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"List three-way match exceptions\n\nThe exception workbench: bill lines (and whole bills) failing the PO, receipt and bill match, oldest first. status and type take comma-separated values (status defaults to open). min_age and max_age are whole days since detection, inclusive. Limited to the caller's entities; a project-scoped grant gets 403. Paginated (Total, Per-Page, Link headers). Requires the accounting:read scope."}},{"id":"4891f7c6-7835-41d8-8904-317a5eaa0ea2","name":"getCompanyAccountingApMatchException — Show a match exception","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ap/match_exceptions/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ap","match_exceptions",":id"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Show a match exception\n\nThe exception with its PO line, the receipts on that line, other bills on it and the bill line, side by side. Requires the accounting:read scope."}},{"id":"c1170315-35ab-40c0-8780-97af6e7cf034","name":"overrideCompanyAccountingApMatchException — Override a match exception","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ap/match_exceptions/:id/override","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ap","match_exceptions",":id","override"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Override a match exception\n\nAccepts an open exception with a reason (3-500 characters); all_on_bill overrides every open exception on the same bill. Needs ap_approve in the bill's entity; a maker of the bill (preparer, editor or contributor) gets 403 sod_maker_checker. Each overridden exception and the bill get an audit row with the reason. When no open exception is left the bill's match hold is released. 409 not_open when the exception is already resolved or overridden. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"override\": {\n    \"reason\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"0cfcc57e-5652-40c2-8bbf-04cabbcdee47","name":"listCompanyAccountingApPaymentRuns — List payment runs","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ap/payment_runs","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ap","payment_runs"],"query":[{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true}],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"List payment runs\n\nPaginated. Requires the accounting:read scope. Entity-wide: a project-scoped (project_manager_view) grant gets 403."}},{"id":"07404a48-536b-4f2c-8b10-9f87b8431e6a","name":"createCompanyAccountingApPaymentRun — Create a draft payment run","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ap/payment_runs","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ap","payment_runs"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Create a draft payment run\n\nNeeds ap_enter. Explicit payments (method, joint payees, owner-direct) or every unheld bill due by due_by. Held bills are listed and never paid; backup withholding (24%) applies to 1099 vendors with no TIN. Requires the accounting:write scope. The owner_direct method is refused (422 owner_direct_unavailable) until it posts through AR.","body":{"mode":"raw","raw":"{\n  \"payment_run\": {\n    \"pay_date\": \"2026-01-31\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"4fbf1cc6-7d77-4fba-8a0c-f17209c3f417","name":"getCompanyAccountingApPaymentRun — Show a payment run","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ap/payment_runs/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ap","payment_runs",":id"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Show a payment run\n\nPayments with their bill applications. Requires the accounting:read scope."}},{"id":"c96f81ce-0ae0-451b-8dbb-fd0426ce08a5","name":"deleteCompanyAccountingApPaymentRun — Delete a draft run","request":{"method":"DELETE","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ap/payment_runs/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ap","payment_runs",":id"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Delete a draft run\n\nNeeds ap_enter. Requires the accounting:write scope."}},{"id":"a671707c-6603-47ad-807d-6253c7378a51","name":"listCompanyAccountingApPaymentRunChecks — Check print data","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ap/payment_runs/:id/checks","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ap","payment_runs",":id","checks"],"query":[{"key":"format","value":"","disabled":true,"description":"pdf returns printable checks (one Letter page per check: check on top, two stubs, the MICR line in font-mapped form for a MICR toner printer or overlay)"}],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Check print data\n\nNeeds release_payments. Generated on demand, never stored; a joint check prints both payees. Check numbers come from the shared check register; voided checks are left out. Contains the MICR line (routing and account number), so it requires the accounting:write scope. A released check missing from the register returns 409 check_not_registered. Audited."}},{"id":"042bff98-68a1-40ee-83fe-28c13134ee0a","name":"listCompanyAccountingApPaymentRunNacha — ACH (NACHA) file","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ap/payment_runs/:id/nacha","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ap","payment_runs",":id","nacha"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"ACH (NACHA) file\n\nNeeds release_payments. Vendor credits for the run's ACH payments, batched by SEC code from the vendor's bank_account_ownership (CCD+ to business accounts, PPD to consumer accounts), originating from the pay-from bank account's routing. Generated once (file id modifier A); the generation time, modifier and each payment's trace number are recorded and audited. A second generation is refused with 409 ach_already_generated: use POST to re-send. ACH payments pay the vendor bank details snapshotted at release; if the vendor profile changed since, 409 bank_changed_since_release (void the payment and pay it in a new run). An account blocked by an ACH return is refused (409 ach_account_blocked); an account whose prenote has not settled three banking days before the pay date is refused (409 ach_prenote_pending); with ach_prenote_required on, an account never prenoted is refused (409 ach_prenote_required). Requires the accounting:write scope. A file generated after the pay date carries the next Fed banking day as its effective entry date (X-Ach-Effective-Date, X-Ach-Warning). The pay-from bank is revalidated under lock at generation and resend: inactive or credit-card accounts return 422 not_a_bank_account; a bank assigned to a different payment entity returns 422 bank_entity_mismatch. Refusal leaves generation, trace and resend state unchanged."}},{"id":"82784bc8-af79-4791-8072-bac5be8ab60b","name":"nachaCompanyAccountingApPaymentRun — Re-send the ACH (NACHA) file","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ap/payment_runs/:id/nacha","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ap","payment_runs",":id","nacha"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Re-send the ACH (NACHA) file\n\nExplicit two-person re-send: resend.action=request records the request (202, no file); resend.action=confirm by an independent releaser returns the new file. Both require resend.previous_file_id_modifier equal to the current payment-run ach_file_id_modifier. Missing fields are 422; a stale modifier, request when one is already pending, or confirmation without a pending request is 409. Refresh GET payment_runs/{id} to inspect ach_resend_requested_by_id and ach_resend_reason before confirming. Reason-only legacy requests are no longer accepted. Needs release_payments and two people. The first call records the re-send request and its reason (202, no file). A second call by a different release_payments user, who is neither the requester nor the run preparer (403 sod_resend otherwise), regenerates the run's NACHA file with the next file id modifier (B, C…) so the bank sees a distinct file, records the new trace numbers and writes an ach_resent audit row with both reasons. At most 2 re-sends per run (409 ach_resend_limit). Refused (422) before the first generation. ACH payments pay the vendor bank details snapshotted at release; if the vendor profile changed since, 409 bank_changed_since_release (void the payment and pay it in a new run). Requires the accounting:write scope. A file generated after the pay date carries the next Fed banking day as its effective entry date (X-Ach-Effective-Date, X-Ach-Warning). The pay-from bank is revalidated under lock at generation and resend: inactive or credit-card accounts return 422 not_a_bank_account; a bank assigned to a different payment entity returns 422 bank_entity_mismatch. Refusal leaves generation, trace and resend state unchanged.","body":{"mode":"raw","raw":"{\n  \"resend\": {\n    \"action\": \"request\",\n    \"previous_file_id_modifier\": \"\",\n    \"reason\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"18729e95-41b9-48fc-866e-d6eff23fb9b8","name":"listCompanyAccountingApPaymentRunPositivePay — Positive pay file (CSV)","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ap/payment_runs/:id/positive_pay","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ap","payment_runs",":id","positive_pay"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Positive pay file (CSV)\n\nNeeds release_payments. The run's checks from the shared check register (the same register banking positive pay reads): issued checks, plus a void record for a check voided after its issue record was sent; a void never sent is left out. Account number from the pay-from bank account. Marks the checks sent; audited. Requires the accounting:write scope."}},{"id":"0080e112-7eb9-4d20-8588-bb1044d18af1","name":"rejectCompanyAccountingApPaymentRun — Reject a payment run release","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ap/payment_runs/:id/reject","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ap","payment_runs",":id","reject"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Reject a payment run release\n\nNeeds release_payments and every payment's entity. Spends the release votes recorded so far on a draft run (the run stays a draft for its preparer to fix or delete). The reason is required and audited (action rejected). Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"reject\": {\n    \"reason\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"bcc8095c-5146-4f72-877c-35bedd681746","name":"releaseCompanyAccountingApPaymentRun — Release (approve) and post a payment run","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ap/payment_runs/:id/release","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ap","payment_runs",":id","release"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Release (approve) and post a payment run\n\nNeeds release_payments. The releaser must not be the run's preparer nor have entered any bill in it (403 sod_release). Release is the payment_batch approval: with no matching approval rule one release posts the run; when a rule routes the batch (for example 2 of 3 named releasers), each call fills one slot of the current step (403 approver_role_required when the caller is not on it, 409 already_approved on a second vote) and the run stays draft until the route completes. The call that completes the route re-checks holds and open amounts, numbers checks and posts each payment (Dr AP / Cr cash, discounts, backup withholding). In small-team SoD mode (settings sod_mode) a maker may approve their own document by sending approve.reason; the event is audited as self_approved and listed by approvals/self_approved. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"approve\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"d2ea812f-59d9-4550-82d7-a206ca22c462","name":"listCompanyAccountingApPaymentSelection — Payment selection","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ap/payment_selection","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ap","payment_selection"],"query":[{"key":"pay_date","value":"","disabled":true},{"key":"due_by","value":"","disabled":true}],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Payment selection\n\nOpen posted bills due by due_by with their holds, the amount payable now (pay-when-paid aware) and any early-pay discount on pay_date. Requires the accounting:read scope."}},{"id":"60feabac-1e01-40c3-84f5-cf84dace9244","name":"listCompanyAccountingApPayments — List payments","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ap/payments","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ap","payments"],"query":[{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true},{"key":"vendor_id","value":"","disabled":true},{"key":"filters[status]","value":"","disabled":true},{"key":"updated_since","value":"","disabled":true,"description":"Delta sync: only rows created or changed at or after this time (ISO 8601 with offset). Switches the list to ascending (updated_at, id) order; page is ignored and Next-Cursor continues it. Re-read with a small overlap (a few seconds) and dedupe by id."},{"key":"cursor","value":"","disabled":true,"description":"Opaque keyset cursor from a previous response's Next-Cursor header; each page costs the same however deep it is."}],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"List payments\n\nFilters: vendor_id, filters[status]. Paginated. Delta sync: updated_since and/or cursor return changes in ascending (updated_at, id) order with Next-Cursor. Requires the accounting:read scope. Entity-wide: a project-scoped (project_manager_view) grant gets 403."}},{"id":"6e5c5fef-f800-43cf-8468-dd1a2f843f58","name":"createCompanyAccountingApPayment — Create one manual payment","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ap/payments","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ap","payments"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Create one manual payment\n\nNeeds ap_enter. One vendor payment against explicit bills, created as a single-payment draft run (the response is the run). A different user releases it with POST .../payment_runs/{id}/release, which numbers checks and posts. Holds, discounts and backup withholding apply as for runs. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"payment\": {\n    \"bills\": [\n      {\n        \"bill_id\": 0\n      }\n    ],\n    \"pay_date\": \"2026-01-31\",\n    \"vendor_id\": 0\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"ed8658ce-5da6-48ed-8746-8723b1257ff5","name":"getCompanyAccountingApPayment — Show a payment","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ap/payments/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ap","payments",":id"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Show a payment\n\n Requires the accounting:read scope."}},{"id":"badee797-9a4f-4393-8244-96e12c9d5571","name":"listCompanyAccountingApPaymentRemittance — Get a payment's remittance advice","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ap/payments/:id/remittance","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ap","payments",":id","remittance"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Get a payment's remittance advice\n\nThe itemized advice (bills paid with invoice numbers, amounts applied, discounts, backup withholding and retainage still held; net equals the payment) and every send of it. Limited to the caller's entities. Requires the accounting:read scope."}},{"id":"cfe0085a-bb2f-4a74-8ab8-71b6a1b2b0b3","name":"createCompanyAccountingApPaymentRemittanceSend — Email a payment's remittance advice","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ap/payments/:id/remittance/send","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ap","payments",":id","remittance","send"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Email a payment's remittance advice\n\nNeeds ap_enter. Sends through the email transport (the outbox by default) to `to`, or to the vendor's remittance email and active portal users. Posted payments only. Audited. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"remittance\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"68f42ff0-a0f4-4181-8957-2ad5df7c3715","name":"createCompanyAccountingApPaymentVirtualCardIssue — Retry a virtual card issue","request":{"method":"POST","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ap/payments/:id/virtual_card/issue","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ap","payments",":id","virtual_card","issue"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Retry a virtual card issue\n\nNeeds release_payments and step-up. Issues (again) the payment's card locked to the payment amount; the provider returns the same card for the same payment, so a retry never makes a second card. A card whose limit differs from the payment is canceled (issue_failed). 409 when already issued, settled or canceled. Requires the accounting:write scope."}},{"id":"8a3cbbce-6665-40a1-89c7-cf5a18c7971b","name":"voidCompanyAccountingApPayment — Void a payment","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ap/payments/:id/void","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ap","payments",":id","void"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Void a payment\n\nNeeds release_payments. Reversal dated in an open period; its bills reopen. A reconciled payment returns 409 reconciled. An ACH payment already sent in a NACHA file (trace number set) returns 422 ach_recall_unconfirmed unless confirm_ach_recalled is true; its bills then carry an ach_return_pending hold until an override records the bank return. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"void\": {\n    \"date\": \"2026-01-31\",\n    \"reason\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"ebc4d450-a132-4db2-8680-9349f3b579cd","name":"listCompanyAccountingApReceipts — List PO receipts","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ap/receipts","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ap","receipts"],"query":[{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true},{"key":"commitment_id","value":"","disabled":true}],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"List PO receipts\n\nFilter by commitment_id. Limited to the caller's entities. Paginated. Requires the accounting:read scope."}},{"id":"ac0af919-bba7-48a7-8bf1-3a5a02fe1539","name":"createCompanyAccountingApReceipt — Receive against a purchase order","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ap/receipts","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ap","receipts"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Receive against a purchase order\n\nQuantities at PO unit cost, posted in the PO project's entity. With receipt accrual posts Dr cost / Cr received-not-invoiced. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"receipt\": {\n    \"commitment_id\": 0,\n    \"lines\": [\n      {\n        \"commitment_line_item_id\": 0,\n        \"quantity\": \"\"\n      }\n    ],\n    \"receipt_date\": \"2026-01-31\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"e20511c9-d12a-48f3-806d-5a4112fc4c43","name":"voidCompanyAccountingApReceipt — Void a PO receipt","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ap/receipts/:id/void","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ap","receipts",":id","void"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Void a PO receipt\n\nReverses its accrual on the given date (an open period); its quantities no longer count as received. Refused while posted bills have invoiced those quantities. Requires ap_approve and the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"void\": {\n    \"date\": \"2026-01-31\",\n    \"reason\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"5292694f-82cb-4bcb-8ed3-8f876b07c11f","name":"voidCompanyAccountingApRetainageRelease — Void a retainage release","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ap/retainage_releases/:id/void","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ap","retainage_releases",":id","void"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Void a retainage release\n\nNeeds ap_approve. The path id is the retainage release. Reverses its entry on the given date (open AP period, on or after the release date), sets voided_at and puts the amount back in retainage held, so the bill can be voided. 409 release_paid once the released amount has been paid, 409 bill_in_draft_run while the bill is in a draft payment run. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"void\": {\n    \"date\": \"2026-01-31\",\n    \"reason\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"1d0bf7c0-0ff2-421e-8e59-b09310353709","name":"listCompanyAccountingApSettings — AP settings","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ap/settings","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ap","settings"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"AP settings\n\nMatching tolerances, over-commitment action, discount posting, approval bands, hold settings and the default pay-from cash account. Requires the accounting:read scope."}},{"id":"db3c4bfc-b604-4fec-835b-1e098c9fc49e","name":"updateCompanyAccountingApSettings — Update AP settings","request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ap/settings","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ap","settings"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Update AP settings\n\nNeeds manage_coa. Changing a payment control (approval_bands, bank_change_hold_days, ach_company_id, ach_destination_routing) also needs manage_grants (an accounting owner); otherwise 403 control_setting. Resending a control's current value is not a change. Control changes are audited with before and after values. bank_change_hold_days is at least 3. cash_account_id must be the GL account of an active, non-card bank account; routing, account number and check numbers live on that bank account. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"ap_settings\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"2f80333e-fcf0-4f79-891a-50dd113f49f8","name":"listCompanyAccountingApTieOut — AP subledger tie-out","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ap/tie_out","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ap","tie_out"],"query":[{"key":"as_of","value":"","disabled":true},{"key":"entity_id","value":"","disabled":true,"description":"One entity inside the caller's grant; default every entity the grant allows."}],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"AP subledger tie-out\n\nAP open items and retainage held vs every accounts payable and retainage payable account (the same controls the ap_aging report and period close use), for one entity_id inside the grant (404 outside it) or every entity the grant allows. Reports differences; never repairs. Requires the accounting:read scope. Entity-wide: a project-scoped (project_manager_view) grant gets 403."}},{"id":"522dcf39-4ea9-4589-8863-d03fd33d790d","name":"createCompanyAccountingApTinMatchingExport — Export an IRS bulk TIN Matching request file","request":{"method":"POST","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ap/tin_matching/export","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ap","tin_matching","export"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Export an IRS bulk TIN Matching request file\n\nBuilds the IRS e-Services bulk TIN Matching .txt file (Pub 2108 Section 11: TIN TYPE;TIN;NAME;ACCOUNT NUMBER, TIN type 1 = EIN, 2 = SSN, 3 = unknown, at most 100,000 pairs) for every 1099 vendor with a TIN. The account number field is the vendor id so the result file maps back. Vendors without a TIN are listed in skipped. TINs are decrypted, so it needs manage_vendor_banking; exports are rate-limited and audited (tin_match_exported). Requires the accounting:write scope."}},{"id":"59bbfed3-52ed-46e2-833a-b8dc18d3b061","name":"createCompanyAccountingApTinMatchingImport — Import IRS bulk TIN Matching results","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ap/tin_matching/import","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ap","tin_matching","import"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Import IRS bulk TIN Matching results\n\nReads the IRS result file (each request record with its indicator 0-8 appended) and stores the indicator on the vendor (tin_match_code). Codes 1 (missing or not 9 digits), 2 (not issued) and 3 (name/TIN mismatch) put the vendor's bills on a tin_mismatch payment hold; 0, 6, 7 and 8 are matches; 4 and 5 mean resubmit. A record whose TIN no longer ends like the vendor's TIN on file is skipped as stale_tin; an unknown account is skipped as unknown_vendor. Any unreadable line rejects the whole file with 422 invalid_tin_match_file. Needs manage_vendor_banking; each result is audited (tin_match_result). Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"tin_matching\": {\n    \"matched_at\": \"2026-01-31\",\n    \"text\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"5df46918-c3f0-4418-8d43-6ad16a6079ff","name":"listCompanyAccountingApVendorPortalBankChangeRequests — List portal bank change requests","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ap/vendor_portal/bank_change_requests","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ap","vendor_portal","bank_change_requests"],"query":[{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true},{"key":"status","value":"","disabled":true}],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"List portal bank change requests\n\nNeeds manage_vendor_banking. Last four digits only. Filter status (pending_review, forwarded, rejected). Paginated. Requires the accounting:read scope."}},{"id":"df454650-f0e8-45cd-8694-895580081f2f","name":"forwardCompanyAccountingApVendorPortalBankChangeRequest — Forward a bank change request for approval","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ap/vendor_portal/bank_change_requests/:id/forward","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ap","vendor_portal","bank_change_requests",":id","forward"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Forward a bank change request for approval\n\nNeeds manage_vendor_banking and step-up. Puts the vendor's numbers into the party profile's pending sensitive change with the caller as requester (the existing two-person bank change approval): a different manage_vendor_banking user must approve it with step-up (POST party_profiles/{id}/sensitive_change), the forwarder cannot. The vendor needs an accounting profile (409 no_profile). The request's sealed numbers are cleared. 409 not_pending. Audited. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"review\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"6ab5916f-9fb0-4fa2-8132-f18e702c6c9e","name":"rejectCompanyAccountingApVendorPortalBankChangeRequest — Reject a bank change request","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ap/vendor_portal/bank_change_requests/:id/reject","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ap","vendor_portal","bank_change_requests",":id","reject"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Reject a bank change request\n\nNeeds manage_vendor_banking and a note. The sealed numbers are discarded. Audited. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"review\": {\n    \"note\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"b4dcf6d2-b245-4194-8298-1be2ce13f2a4","name":"listCompanyAccountingApVendorPortalGrants — List vendor portal users","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ap/vendor_portal/grants","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ap","vendor_portal","grants"],"query":[{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true},{"key":"vendor_id","value":"","disabled":true}],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"List vendor portal users\n\nActive and revoked grants. Filter vendor_id. Paginated. Requires the accounting:read scope."}},{"id":"5455dd44-faa4-4915-8b20-01ded95cd191","name":"revokeCompanyAccountingApVendorPortalGrant — Revoke a vendor portal user's access","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ap/vendor_portal/grants/:id/revoke","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ap","vendor_portal","grants",":id","revoke"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Revoke a vendor portal user's access\n\nNeeds ap_approve and a note. Every later portal request of that grant is refused. Audited. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"revoke\": {\n    \"note\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"140ebe36-955e-4329-8b62-fdbc73f880a2","name":"listCompanyAccountingApVendorPortalInvitations — List vendor portal invitations","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ap/vendor_portal/invitations","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ap","vendor_portal","invitations"],"query":[{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true},{"key":"vendor_id","value":"","disabled":true}],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"List vendor portal invitations\n\nFilter vendor_id. Paginated. Requires the accounting:read scope."}},{"id":"c5e1cf22-5647-4fb2-8293-6f401ff9d7ea","name":"createCompanyAccountingApVendorPortalInvitation — Invite a user to a vendor's portal","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ap/vendor_portal/invitations","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ap","vendor_portal","invitations"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Invite a user to a vendor's portal\n\nNeeds ap_approve; an admin role (may request bank changes) also needs manage_vendor_banking and step-up. The portal must be enabled (409 portal_disabled). The response carries the one-time secret (43 characters, single use, 7 days); it is stored only as a hash and never shown again. Audited. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"invitation\": {\n    \"email\": \"\",\n    \"name\": \"\",\n    \"vendor_id\": 0\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"225f952f-7267-42a1-8c90-9d0435c03e06","name":"revokeCompanyAccountingApVendorPortalInvitation — Revoke a pending invitation","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ap/vendor_portal/invitations/:id/revoke","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ap","vendor_portal","invitations",":id","revoke"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Revoke a pending invitation\n\nNeeds ap_approve and a note. Audited. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"revoke\": {\n    \"note\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"d17394be-0d9d-4ff2-81e7-efae16da0879","name":"listCompanyAccountingApVendorPortalSubmissions — List portal compliance submissions","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ap/vendor_portal/submissions","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ap","vendor_portal","submissions"],"query":[{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true},{"key":"status","value":"","disabled":true}],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"List portal compliance submissions\n\nCOIs and lien waivers uploaded through the portal. Filter status (pending, accepted, rejected). Paginated. Requires the accounting:read scope."}},{"id":"d15a359a-5560-4e78-8d86-96e8ce77d80b","name":"acceptCompanyAccountingApVendorPortalSubmission — Accept a portal compliance submission","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ap/vendor_portal/submissions/:id/accept","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ap","vendor_portal","submissions",":id","accept"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Accept a portal compliance submission\n\nNeeds ap_enter. Creates the COI compliance record or the lien waiver from the vendor's statement (a waiver's project, payment and received date may be corrected), copies the file onto it and closes the submission. Until then it counts toward nothing. 409 not_pending. Audited. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"review\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"6427f006-0e92-4f4e-8568-409c0ff0548f","name":"rejectCompanyAccountingApVendorPortalSubmission — Reject a portal compliance submission","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ap/vendor_portal/submissions/:id/reject","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ap","vendor_portal","submissions",":id","reject"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Reject a portal compliance submission\n\nNeeds ap_enter and a note the vendor sees. 409 not_pending. Audited. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"review\": {\n    \"note\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"6ac38789-64a3-4200-862d-65c3cbf35dde","name":"listCompanyAccountingApVendors — List AP vendors","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ap/vendors","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ap","vendors"],"query":[{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true},{"key":"search","value":"","disabled":true}],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"List AP vendors\n\nVendors with an accounting profile: compliance status, open balance and retainage held. Requires the accounting:read scope. Entity-wide: a project-scoped (project_manager_view) grant gets 403."}},{"id":"31d68085-6c4d-4932-81cf-aaeb55a1c016","name":"getCompanyAccountingApVendor — Show an AP vendor","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ap/vendors/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ap","vendors",":id"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Show an AP vendor\n\nThe path id is the core vendor id. Requires the accounting:read scope."}},{"id":"586b1845-1ada-4082-8baf-41bcf4309dd0","name":"listCompanyAccountingApVendorAttachments — List attachments on a vendor","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ap/vendors/:id/attachments","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ap","vendors",":id","attachments"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"List attachments on a vendor\n\nOldest first. Needs view_ledger and the parent's entity scope. Requires the accounting:read scope."}},{"id":"18aa58d2-55ea-4000-8d27-101aecc3ecbb","name":"createCompanyAccountingApVendorAttachment — Attach a file to a vendor","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ap/vendors/:id/attachments","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ap","vendors",":id","attachments"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Attach a file to a vendor\n\nMultipart upload (one `file` part, allow-listed type, up to MAX_UPLOAD_BYTES). Allowed after posting: attachments are not ledger data. Writes an attachment_added audit event on the parent in the same transaction. Needs ap_enter and the parent's entity scope. Requires the accounting:write scope.","body":{"mode":"formdata","formdata":[{"key":"file","type":"file","src":[]}]}}},{"id":"7211b63d-888a-485e-8f2f-6c32fe6c91d7","name":"listCompanyAccountingApVendorAutomation — Get a vendor's remittance and capture settings","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ap/vendors/:id/automation","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ap","vendors",":id","automation"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Get a vendor's remittance and capture settings\n\nThe remittance advice email and the sender addresses that identify the vendor in the capture inbox. Requires the accounting:read scope."}},{"id":"3bba50be-4b4c-4cdc-836a-1d2af0c100fd","name":"automationCompanyAccountingApVendor — Update a vendor's remittance and capture settings","request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ap/vendors/:id/automation","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ap","vendors",":id","automation"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Update a vendor's remittance and capture settings\n\nNeeds ap_enter. Audited. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"vendor_automation\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"c0bab2f9-9837-4f6e-8478-d82cdb42e8e5","name":"complianceCompanyAccountingApVendor — Record a compliance document","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ap/vendors/:id/compliance","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ap","vendors",":id","compliance"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Record a compliance document\n\nCOI, W-9, license, prequalification or stop-pay (stop-pay needs ap_approve). A newer COI clears an expired-COI hold. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"compliance\": {\n    \"kind\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"4c22011d-05f0-4f7c-8e5c-2a80dbb2bf43","name":"updateCompanyAccountingApVendorCompliance — Lift or reinstate a compliance record","request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ap/vendors/:id/compliance/:compliance_id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ap","vendors",":id","compliance",":compliance_id"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""},{"key":"compliance_id","value":""}]},"description":"Lift or reinstate a compliance record\n\nNeeds ap_approve. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"compliance\": {\n    \"active\": false\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"979a1fda-b544-4cd2-8fb1-c18e53a9f3c1","name":"listCompanyAccountingApVendorComplianceAttachments — List attachments on a vendor compliance record (COI, W-9, license)","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ap/vendors/:id/compliance/:compliance_id/attachments","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ap","vendors",":id","compliance",":compliance_id","attachments"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""},{"key":"compliance_id","value":""}]},"description":"List attachments on a vendor compliance record (COI, W-9, license)\n\nOldest first. Needs view_ledger and the parent's entity scope. Requires the accounting:read scope."}},{"id":"64e7c5a1-bd74-430d-8f75-a37e3a24d904","name":"createCompanyAccountingApVendorComplianceAttachment — Attach a file to a vendor compliance record (COI, W-9, license)","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ap/vendors/:id/compliance/:compliance_id/attachments","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ap","vendors",":id","compliance",":compliance_id","attachments"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""},{"key":"compliance_id","value":""}]},"description":"Attach a file to a vendor compliance record (COI, W-9, license)\n\nMultipart upload (one `file` part, allow-listed type, up to MAX_UPLOAD_BYTES). Allowed after posting: attachments are not ledger data. Writes an attachment_added audit event on the parent in the same transaction. Needs ap_enter and the parent's entity scope. Requires the accounting:write scope.","body":{"mode":"formdata","formdata":[{"key":"file","type":"file","src":[]}]}}},{"id":"b84d80c8-aea4-48ea-8586-503903f48dd4","name":"createCompanyAccountingApVendorLienWaiver — Record a lien waiver received","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ap/vendors/:id/lien_waivers","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ap","vendors",":id","lien_waivers"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Record a lien waiver received\n\nparty is 'vendor' or a lower-tier party name; payment_no is the vendor's payment sequence on the project. Give payment_id (a posted AP payment to this vendor) for an unconditional waiver: the waiver then covers that payment only (a voided payment never shifts it), payment_no is derived when omitted, and a waiver whose amount is below the payment's net amount on the project is recorded but does not clear the lien-waiver hold. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"lien_waiver\": {\n    \"kind\": \"\",\n    \"received_at\": \"2026-01-31\",\n    \"scope\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"d2fa838f-1642-456f-8be2-e3d10588c6bc","name":"listCompanyAccountingApVendorLienWaiverAttachments — List attachments on a lien waiver","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ap/vendors/:id/lien_waivers/:waiver_id/attachments","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ap","vendors",":id","lien_waivers",":waiver_id","attachments"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""},{"key":"waiver_id","value":""}]},"description":"List attachments on a lien waiver\n\nOldest first. Needs view_ledger and the parent's entity scope. Requires the accounting:read scope."}},{"id":"7fda149f-8b52-408c-8b6c-3cc52797099c","name":"createCompanyAccountingApVendorLienWaiverAttachment — Attach a file to a lien waiver","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ap/vendors/:id/lien_waivers/:waiver_id/attachments","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ap","vendors",":id","lien_waivers",":waiver_id","attachments"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""},{"key":"waiver_id","value":""}]},"description":"Attach a file to a lien waiver\n\nMultipart upload (one `file` part, allow-listed type, up to MAX_UPLOAD_BYTES). Allowed after posting: attachments are not ledger data. Writes an attachment_added audit event on the parent in the same transaction. Needs ap_enter and the parent's entity scope. Requires the accounting:write scope.","body":{"mode":"formdata","formdata":[{"key":"file","type":"file","src":[]}]}}},{"id":"eb4ce889-cab7-4e69-8ee8-3794a2781622","name":"listCompanyAccountingApVirtualCards — List virtual card payments","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ap/virtual_cards","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ap","virtual_cards"],"query":[{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true},{"key":"status","value":"","disabled":true}],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"List virtual card payments\n\nOne single-use card per virtual card payment (last four digits only; card numbers are never stored), with issue and settlement state. Limited to the caller's entities. Filter status (comma-separated). Paginated. Requires the accounting:read scope."}},{"id":"1f8413c0-57de-4c7e-87f9-2a9e68e3ffdb","name":"createCompanyAccountingApVirtualCardsSyncSettlement — Sync virtual card settlements","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ap/virtual_cards/sync_settlements","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ap","virtual_cards","sync_settlements"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Sync virtual card settlements\n\nNeeds bank_reconcile. Pulls the provider's settlements and posts each once (the settlement id is unique): a withdrawal on the funding bank account, Dr clearing / Cr bank, matched to the one unmatched imported statement line of that amount within 5 days when there is one. A settlement of a different amount, or of a canceled card, is recorded as settlement_mismatch and not posted. Only a fake provider exists (no network call; refused in production). Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"sync\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"c949972e-6686-4ac3-8426-1be9d615bfaf","name":"listCompanyAccountingApprovalDelegations — List approval delegations","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/approval_delegations","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","approval_delegations"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"List approval delegations\n\nDelegations from or to the caller; every delegation with manage_grants. Requires the accounting:read scope."}},{"id":"1d09c128-42b3-443a-8f93-11cf17cdd667","name":"createCompanyAccountingApprovalDelegation — Create an approval delegation","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/approval_delegations","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","approval_delegations"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Create an approval delegation\n\nLets to_user fill from_user's approval slots between starts_at and ends_at for the listed doc types, up to max_amount and within entity_ids (empty = all). The delegate needs the same approve flag and entity scope, never approves a document they or the delegator prepared, and the step records who they acted for. Delegating your own approvals needs each doc type's approve flag; from_user_id for someone else needs manage_grants and can't name yourself as to_user_id (403 self_delegation); a delegation someone created to themselves never fills a slot. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"delegation\": {\n    \"doc_types\": [\n      \"ap_bill\"\n    ],\n    \"ends_at\": \"2026-01-31T12:00:00Z\",\n    \"reason\": \"\",\n    \"starts_at\": \"2026-01-31T12:00:00Z\",\n    \"to_user_id\": 0\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"41d546f8-5d85-432a-8bd8-b36ee9b6f580","name":"deleteCompanyAccountingApprovalDelegation — Revoke an approval delegation","request":{"method":"DELETE","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/approval_delegations/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","approval_delegations",":id"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Revoke an approval delegation\n\nThe delegator or manage_grants. Requires the accounting:write scope."}},{"id":"fd057630-ee5b-4067-8cf5-ed2f10d3aa82","name":"listCompanyAccountingApprovalRules — List approval rules","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/approval_rules","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","approval_rules"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"List approval rules\n\nApproval routing rules for ap_bill and payment_batch (WORKFLOWS §2), active first by priority. Requires the accounting:read scope."}},{"id":"18b5b9f6-c51e-4945-8cc6-c0fba2e6a3ee","name":"createCompanyAccountingApprovalRule — Create an approval rule","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/approval_rules","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","approval_rules"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Create an approval rule\n\nNeeds manage_grants. Among active rules for a doc type whose every non-empty condition matches (amount in [min_amount, max_amount), any entity, any line project, any vendor risk), the lowest priority routes the document; no match uses the AP approval bands (bills) or a single releaser (payment runs). Steps run in order; each step's approvers are grant:any (anyone with the doc type's approve flag), grant:<role>, project:<team role> (resolved from the project team when the route is snapshotted, leaving out the document's makers and members without the approve flag) or user:<id> (must hold the doc type's approve flag, else 422); quorum defaults to all of them (N-of-M otherwise) and shrinks to the approvers left after resolution. An equal priority among active rules of the doc type is 409 priority_taken. Rules are not edited in place: deactivate and create. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"approval_rule\": {\n    \"doc_type\": \"ap_bill\",\n    \"name\": \"\",\n    \"priority\": 0,\n    \"steps\": [\n      {\n        \"approvers\": [\n          \"\"\n        ]\n      }\n    ]\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"1d4d2bf1-9236-44bc-8ded-2bf93a2e8e44","name":"deleteCompanyAccountingApprovalRule — Deactivate an approval rule","request":{"method":"DELETE","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/approval_rules/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","approval_rules",":id"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Deactivate an approval rule\n\nNeeds manage_grants. Documents already routed keep the steps they snapshotted. Requires the accounting:write scope."}},{"id":"5bfc00eb-6543-4ee4-815a-0253e71951cf","name":"listCompanyAccountingApprovalsEscalationHistory — Approval escalation history of an item","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/approvals/escalation/history","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","approvals","escalation","history"],"query":[{"key":"doc_type","value":"","disabled":false},{"key":"doc_id","value":"","disabled":false}],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Approval escalation history of an item\n\nEvery reminder and escalation of one approval item (all revisions), newest first, with recipients, re-routed steps and who was left out and why. Needs view_ledger and the item's entities in scope (404 otherwise); refused to project-scoped grants. Requires the accounting:read scope."}},{"id":"85b2ecb7-566f-458b-8f59-bea6cdbe5963","name":"listCompanyAccountingApprovalsEscalationPolicies — List approval escalation policies","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/approvals/escalation/policies","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","approvals","escalation","policies"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"List approval escalation policies\n\nOne policy per item kind. Needs view_ledger; refused to project-scoped grants. Requires the accounting:read scope."}},{"id":"dde6952d-584c-4737-81ae-5877240dfeb3","name":"createCompanyAccountingApprovalsEscalationPolicy — Save an approval escalation policy","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/approvals/escalation/policies","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","approvals","escalation","policies"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Save an approval escalation policy\n\nCreate or replace the policy of one item kind (natural key: doc_type; 201 when created, 200 when replaced). target: next_role, principal, role:controller, role:owner or user:<id> (a user target must hold the kind's approve grant). Needs manage_grants and step-up. Audited. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"escalation_policy\": {\n    \"doc_type\": \"ap_bill\",\n    \"escalate_after_days\": 0,\n    \"reminder_every_days\": 0\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"a80c4407-137d-4bd9-840e-31550d162a51","name":"createCompanyAccountingApprovalsEscalationRun — Run reminders and escalation now","request":{"method":"POST","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/approvals/escalation/run","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","approvals","escalation","run"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Run reminders and escalation now\n\nThe same run as the daily job, as of the company's today: due escalations (re-routing named steps to eligible targets) and due reminders. Idempotent: a reminder or escalation already sent is never sent again. Needs manage_grants. Requires the accounting:write scope."}},{"id":"ed2a0290-aed9-467e-8a96-7eb7059004c0","name":"listCompanyAccountingApprovalsEscalationSettings — Approval escalation settings","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/approvals/escalation/settings","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","approvals","escalation","settings"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Approval escalation settings\n\nWhether reminders and escalation run, the business-day calendar and the policy of each item kind. Needs view_ledger; refused to project-scoped grants. Requires the accounting:read scope."}},{"id":"d5e3a327-44a5-4352-8da6-329deaa5e48d","name":"replaceCompanyAccountingApprovalsEscalationSettings — Save approval escalation settings","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/approvals/escalation/settings","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","approvals","escalation","settings"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Save approval escalation settings\n\nTurn reminders and escalation on or off and set the business days (ISO weekdays) and holidays. Needs manage_grants and step-up (routing is a control, like approval rules). Audited. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"escalation_settings\": {\n    \"business_days\": [\n      0\n    ],\n    \"enabled\": false,\n    \"holidays\": [\n      \"2026-01-31\"\n    ]\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"4f3a04dc-dfbc-4454-8b61-09522fc9d1de","name":"listCompanyAccountingApprovalsInbox — Approvals inbox","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/approvals/inbox","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","approvals","inbox"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Approvals inbox\n\nThe caller's open approval slots across journal entries, AP bills and payment runs (directly, or as the delegate of a user within an active delegation), plus pending vendor bank/TIN changes for manage_vendor_banking users, and the caller's own documents an approver returned in the last 30 days (returned). Only documents the approve call would accept are listed. Requires the accounting:read scope."}},{"id":"c6f3d069-6a9a-4d63-897d-a7fec2d36622","name":"listCompanyAccountingApprovalsOverdue — Overdue approvals","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/approvals/overdue","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","approvals","overdue"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Overdue approvals\n\nApproval items waiting at least their kind's escalation threshold in business days (the reminder cadence when the policy does not escalate; 3 without a policy), longest first, in the viewer's entity scope, with who they wait on and their escalation level. Needs view_ledger; refused to project-scoped grants. Requires the accounting:read scope."}},{"id":"47fc745e-32a9-4673-8a4f-c48db6bcb9cd","name":"listCompanyAccountingApprovalsSelfApproved — Self-approved documents","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/approvals/self_approved","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","approvals","self_approved"],"query":[{"key":"from","value":"","disabled":true},{"key":"to","value":"","disabled":true}],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Self-approved documents\n\nApprovals a maker made on their own document in small-team SoD mode, with the reason (close-checklist review). Needs close_period (403 otherwise); entity-scoped grants get an empty list. Requires the accounting:read scope."}},{"id":"5d2a5225-e524-494a-8690-fed1f52d261b","name":"listCompanyAccountingArCollectionsDisputes — Disputes","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ar/collections/disputes","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ar","collections","disputes"],"query":[{"key":"status","value":"","disabled":true},{"key":"customer_id","value":"","disabled":true},{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true}],"variable":[{"key":"company_id","value":"{{companyId}}"}]},"description":"Disputes\n\nDisputes in permitted entities, newest first; filter by status and customer_id. Requires the accounting:read scope."}},{"id":"a4923c53-77cf-4c84-8219-477c5aee588f","name":"createCompanyAccountingArCollectionsDispute — Open a dispute on a posted invoice (arEnter)","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ar/collections/disputes","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ar","collections","disputes"],"variable":[{"key":"company_id","value":"{{companyId}}"}]},"description":"Open a dispute on a posted invoice (arEnter)\n\nReason code and amount disputed (open disputes cannot exceed the invoice total). Flags the invoice disputed: aging shows it in the Disputed column and dunning and finance charges skip it. Idempotent on request_key. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"dispute\": {\n    \"amount\": \"\",\n    \"invoice_id\": 0,\n    \"reason_code\": \"pricing\"\n  },\n  \"request_key\": \"\"\n}","options":{"raw":{"language":"json"}}}}},{"id":"8e88e623-0c34-42e2-8b6e-0631075a6338","name":"getCompanyAccountingArCollectionsDispute — A dispute","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ar/collections/disputes/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ar","collections","disputes",":id"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"A dispute\n\nOne dispute in permitted entities. Requires the accounting:read scope."}},{"id":"6e3383ff-ff52-45c8-8e7b-0648495aaa4c","name":"resolveCompanyAccountingArCollectionsDispute — Resolve or withdraw a dispute (arEnter)","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ar/collections/disputes/:id/resolve","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ar","collections","disputes",":id","resolve"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Resolve or withdraw a dispute (arEnter)\n\nClosing the last open dispute on an invoice clears its disputed flag. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"action\": \"resolve\",\n  \"resolution\": \"\"\n}","options":{"raw":{"language":"json"}}}}},{"id":"23d51d3a-07c5-4c96-8d30-2250ad7f56bd","name":"listCompanyAccountingArCollectionsPayments — Online payments","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ar/collections/payments","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ar","collections","payments"],"query":[{"key":"status","value":"","disabled":true},{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true}],"variable":[{"key":"company_id","value":"{{companyId}}"}]},"description":"Online payments\n\nCustomer portal payments in permitted entities: pending until the provider confirms, then succeeded (receipt posted to the clearing account), failed, or settled at payout; held (nothing posted, the reason in failure_reason) when the provider's captured or paid-out figures, or the pending receipt's state, disagree with the books. Requires the accounting:read scope."}},{"id":"7f2d5ade-0fde-44f4-82d7-a4c1a11617d0","name":"getCompanyAccountingArCollectionsPayment — An online payment","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ar/collections/payments/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ar","collections","payments",":id"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"An online payment\n\nOne customer portal payment in permitted entities. Requires the accounting:read scope."}},{"id":"40036167-3b90-4b7d-85ed-0801ee8c4a61","name":"listCompanyAccountingArCollectionsPolicies — Dunning policies","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ar/collections/policies","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ar","collections","policies"],"query":[{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true}],"variable":[{"key":"company_id","value":"{{companyId}}"}]},"description":"Dunning policies\n\nOne reminder cadence per customer class, with steps relative to the due date. Requires the accounting:read scope."}},{"id":"1d48e18a-fd69-44f3-8f8f-d542f6948df0","name":"createCompanyAccountingArCollectionsPolicy — Create a dunning policy (arApprove)","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ar/collections/policies","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ar","collections","policies"],"variable":[{"key":"company_id","value":"{{companyId}}"}]},"description":"Create a dunning policy (arApprove)\n\nOne policy per customer class (409 otherwise). Steps: offset days relative to the due date (rolled forward to a business day), email subject and body templates ({{invoice_number}}, {{due_date}}, {{open_amount}}, {{days_past_due}}, {{customer_name}}, {{company_name}}), and escalation to the internal owner. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"policy\": {\n    \"customer_class\": \"\",\n    \"name\": \"\",\n    \"steps\": [\n      {\n        \"body\": \"\",\n        \"offset_days\": 0,\n        \"subject\": \"\"\n      }\n    ]\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"c4946c66-3983-48f6-88dd-ffa9f04e21ce","name":"updateCompanyAccountingArCollectionsPolicy — Replace a dunning policy's cadence (arApprove)","request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ar/collections/policies/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ar","collections","policies",":id"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Replace a dunning policy's cadence (arApprove)\n\nSteps keep their identity by offset, so a re-saved step never re-sends; dropped offsets are deactivated. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"policy\": {\n    \"customer_class\": \"\",\n    \"name\": \"\",\n    \"steps\": [\n      {\n        \"body\": \"\",\n        \"offset_days\": 0,\n        \"subject\": \"\"\n      }\n    ]\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"0978322f-d484-4a10-8fc7-beffc533b31e","name":"listCompanyAccountingArCollectionsPortalAccess — Customer portal billing links","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ar/collections/portal_access","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ar","collections","portal_access"],"query":[{"key":"customer_id","value":"","disabled":true},{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true}],"variable":[{"key":"company_id","value":"{{companyId}}"}]},"description":"Customer portal billing links\n\nLinks from customer portal grants to AR customers. Requires the accounting:read scope."}},{"id":"b679c3b3-947a-42a5-8d38-cdae6f6dfe4c","name":"createCompanyAccountingArCollectionsPortalAccess — Link a customer portal grant to an AR customer (arApprove)","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ar/collections/portal_access","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ar","collections","portal_access"],"variable":[{"key":"company_id","value":"{{companyId}}"}]},"description":"Link a customer portal grant to an AR customer (arApprove)\n\nThe grant's principal then sees that customer's posted invoices on the grant's project, and may pay online when allow_payments is true. Needs a grant over every entity. One active link per grant. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"portal_access\": {\n    \"customer_id\": 0,\n    \"grant_id\": 0\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"78e6f4cd-c9d9-4949-8187-ec9c9352166b","name":"revokeCompanyAccountingArCollectionsPortalAccess — Revoke a billing link (arApprove)","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ar/collections/portal_access/:id/revoke","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ar","collections","portal_access",":id","revoke"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Revoke a billing link (arApprove)\n\nThe portal stops showing billing for the grant at once. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"reason\": \"\"\n}","options":{"raw":{"language":"json"}}}}},{"id":"109e17d9-086f-4067-891b-90b985b0e442","name":"listCompanyAccountingArCollectionsPromises — Promises to pay","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ar/collections/promises","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ar","collections","promises"],"query":[{"key":"status","value":"","disabled":true},{"key":"customer_id","value":"","disabled":true},{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true}],"variable":[{"key":"company_id","value":"{{companyId}}"}]},"description":"Promises to pay\n\nPromises in permitted entities; status kept or broken is recorded by the daily collections job from posted receipts. Requires the accounting:read scope."}},{"id":"8415a213-5097-492f-84d0-0333ba7fdce9","name":"createCompanyAccountingArCollectionsPromise — Record a promise to pay (arEnter)","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ar/collections/promises","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ar","collections","promises"],"variable":[{"key":"company_id","value":"{{companyId}}"}]},"description":"Record a promise to pay (arEnter)\n\nDate and amount, optionally for named invoices. While open it pauses dunning for those invoices (or the customer). Idempotent on request_key. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"promise\": {\n    \"amount\": \"\",\n    \"customer_id\": 0,\n    \"entity_id\": 0,\n    \"promised_date\": \"2026-01-31\"\n  },\n  \"request_key\": \"\"\n}","options":{"raw":{"language":"json"}}}}},{"id":"bb86a9cd-39c2-4f41-823d-acd8961bbc6c","name":"cancelCompanyAccountingArCollectionsPromise — Cancel an open promise (arEnter)","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ar/collections/promises/:id/cancel","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ar","collections","promises",":id","cancel"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Cancel an open promise (arEnter)\n\nA cancelled promise no longer pauses dunning and is left out of the kept rate. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"reason\": \"\"\n}","options":{"raw":{"language":"json"}}}}},{"id":"ba4b7a47-66bb-4e25-8202-5da8e079f2bb","name":"createCompanyAccountingArCollectionsRun — Run collections now (arEnter)","request":{"method":"POST","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ar/collections/run","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ar","collections","run"],"variable":[{"key":"company_id","value":"{{companyId}}"}]},"description":"Run collections now (arEnter)\n\nRecords kept/broken promises and sends due dunning steps, exactly as the daily job: business days and outside quiet hours only, at most once per invoice and step. Requires the accounting:write scope."}},{"id":"cc347d35-e1fb-4fb6-864b-6b23172ab7f5","name":"listCompanyAccountingArCollectionsSettings — Collections and online payment settings","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ar/collections/settings","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ar","collections","settings"],"variable":[{"key":"company_id","value":"{{companyId}}"}]},"description":"Collections and online payment settings\n\nDunning calendar (quiet hours, business days, holidays), promise grace days and the online payment setup (provider, clearing, payout and fee accounts; surcharge and convenience fee, both off by default). Any AR reader. Requires the accounting:read scope."}},{"id":"ec147c20-7273-4e76-83ad-8c18df07c72f","name":"updateCompanyAccountingArCollectionsSettings — Update collections settings (arApprove)","request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ar/collections/settings","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ar","collections","settings"],"variable":[{"key":"company_id","value":"{{companyId}}"}]},"description":"Update collections settings (arApprove)\n\nPartial update. Online payments need clearing, payout and processor fee accounts; surcharges and convenience fees need a fee income account (their legality varies by jurisdiction and card network). revision guards concurrent edits (409). Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"settings\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"b2129331-c4c1-47fe-86f3-249cd350765b","name":"listCompanyAccountingArCollectionsWorklist — Prioritized collections worklist","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ar/collections/worklist","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ar","collections","worklist"],"query":[{"key":"as_of","value":"","disabled":true},{"key":"collector_id","value":"","disabled":true},{"key":"entity_id","value":"","disabled":true},{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true}],"variable":[{"key":"company_id","value":"{{companyId}}"}]},"description":"Prioritized collections worklist\n\nCustomers with open current AR in permitted entities, ordered by score = Σ open × age weight × risk (deterministic; docs/accounting/COLLECTIONS-PORTAL.md). Disputed invoices are excluded from the score and shown separately. Paginated. Requires the accounting:read scope."}},{"id":"3fa66aec-3101-4f8d-82f2-7d630c86acb0","name":"listCompanyAccountingArCustomers — List AR customers","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ar/customers","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ar","customers"],"query":[{"key":"search","value":"","disabled":true},{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true}],"variable":[{"key":"company_id","value":"{{companyId}}"}]},"description":"List AR customers\n\nActive parties usable as AR customers (no accounting profile, or a profile marked customer), ordered by name. Paginated with Total and Link headers. Party names only; billing activity stays behind the entity-scoped customer detail. Refused (403) to project-scoped grants. Requires the accounting:read scope."}},{"id":"f4071f45-86b6-4504-8011-b6626cc0aa6b","name":"getCompanyAccountingArCustomer — Customer open balances net of posted receipts and reversals; paginated invoice history","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ar/customers/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ar","customers",":id"],"query":[{"key":"page","value":"1","disabled":true}],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Customer open balances net of posted receipts and reversals; paginated invoice history\n\nReturns customer billing information scoped to the company and permitted invoice entities. This is current workflow information, not an as-of AR control reconciliation. Requires the accounting:read scope."}},{"id":"30bb5b41-1359-4665-8049-fa4e06bc1c66","name":"listCompanyAccountingArCustomerCollectionNotes — Latest 100 collection notes for the customer in permitted entities.","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ar/customers/:id/collection_notes","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ar","customers",":id","collection_notes"],"query":[{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true}],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Latest 100 collection notes for the customer in permitted entities.\n\nNewest first. Paginated (page/per_page; Total and Link headers). Latest 100 collection notes for the customer in permitted entities. Requires the accounting:read scope."}},{"id":"3435d09a-a029-4c6b-8d5b-70ed6a9bb9eb","name":"createCompanyAccountingArCustomerCollectionNote — Add a collection note (optional invoice and promise to pay). arEnter.","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ar/customers/:id/collection_notes","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ar","customers",":id","collection_notes"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Add a collection note (optional invoice and promise to pay). arEnter.\n\nAdd a collection note (optional invoice and promise to pay). arEnter. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"entity_id\": 0,\n  \"note\": \"\"\n}","options":{"raw":{"language":"json"}}}}},{"id":"8e8a4a36-3297-4d2f-8979-f1f4bcbdb71e","name":"listCompanyAccountingArCustomerCollections — A customer's collections view","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ar/customers/:id/collections","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ar","customers",":id","collections"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"A customer's collections view\n\nProfile (class, collector, hold, follow-up), days to pay (amount-weighted, last 365 days), disputes, promises (live status) and dunning history in permitted entities. Requires the accounting:read scope."}},{"id":"64130622-dafa-43ec-8162-6e37dda962d9","name":"updateCompanyAccountingArCustomerCollections — Update a customer's collections profile (arEnter)","request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ar/customers/:id/collections","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ar","customers",":id","collections"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Update a customer's collections profile (arEnter)\n\nCustomer class (selects the dunning policy), collector assignment, hold (pauses dunning; needs a reason) and follow-up date. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"profile\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"459ff579-b37a-4a01-8874-189759658d7c","name":"listCompanyAccountingArCustomerStatement — Customer statement: open posted invoices, unapplied cash and balance due, with the billing contact.","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ar/customers/:id/statement","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ar","customers",":id","statement"],"query":[{"key":"as_of","value":"","disabled":true,"description":"Statement date (default today): as-of open amounts, receipts and applications dated on or before it."}],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Customer statement: open posted invoices, unapplied cash and balance due, with the billing contact.\n\nCustomer statement: open posted invoices, unapplied cash and balance due, with the billing contact. Requires the accounting:read scope."}},{"id":"d48afbea-c3b8-4b34-89d4-73ce5a18076f","name":"createCompanyAccountingArDeposit — Deposit posted receipts held in UNDEPOSITED_FUNDS to a bank account as one journal (Dr bank / Cr undeposited funds). arApprove; idempotent by request_key.","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ar/deposits","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ar","deposits"],"variable":[{"key":"company_id","value":"{{companyId}}"}]},"description":"Deposit posted receipts held in UNDEPOSITED_FUNDS to a bank account as one journal (Dr bank / Cr undeposited funds). arApprove; idempotent by request_key.\n\nDeposit posted receipts held in UNDEPOSITED_FUNDS to a bank account as one journal (Dr bank / Cr undeposited funds). arApprove; idempotent by request_key. A preparer or contributor of any deposited receipt cannot make the deposit (403, segregation of duties). Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"bank_account_id\": 0,\n  \"entity_id\": 0,\n  \"posting_date\": \"2026-01-31\",\n  \"receipt_ids\": [\n    0\n  ],\n  \"request_key\": \"\"\n}","options":{"raw":{"language":"json"}}}}},{"id":"26be71ed-11f3-4a1a-88f8-7e7da81353c3","name":"listCompanyAccountingArGmpStatus — GMP status of a project","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ar/gmp/status","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ar","gmp","status"],"query":[{"key":"project_id","value":"","disabled":false}],"variable":[{"key":"company_id","value":"{{companyId}}"}]},"description":"GMP status of a project\n\nFor each prime contract on the project with an approved GMP: mode (cost_of_work: applications; sov: progress contract certified through Payment Applications), original and revised GMP, approved changes, committed and actual cost and forecast at completion (job forecast; forecast_error when unavailable), reimbursable and disallowed cost, fee earned, billed to date (posted), retainage held, remaining GMP, contingency and allowance balances, projected savings and the contractor/owner split, last application. Project-scoped grants may read their projects. Requires the accounting:read scope."}},{"id":"4c5a94d3-bf50-495e-84e0-4d9c23660c81","name":"getCompanyAccountingArGmpApplication — Get a GMP application","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ar/gmp_applications/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ar","gmp_applications",":id"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Get a GMP application\n\nThe application with its computed result and its invoice, if billed. Refused (403) to project-scoped grants. Requires the accounting:read scope."}},{"id":"60203dee-b42c-466e-876b-e0c0fbe63a1c","name":"updateCompanyAccountingArGmpApplication — Edit a GMP application","request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ar/gmp_applications/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ar","gmp_applications",":id"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Edit a GMP application\n\nNeeds ar_enter. Draft or returned applications only, at the given revision (409 when stale). exclusions replaces the disallowed job cost entries of the period (entry id -> reason); stored is the cumulative materials presently stored. An edit with only revision refreshes the application from current job cost, terms, change orders and contingency transfers. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"exclusions\": {},\n  \"final\": false,\n  \"period_end\": \"2026-01-31\",\n  \"revision\": 0,\n  \"stored\": [\n    {\n      \"amount\": \"\",\n      \"cost_code_id\": 0,\n      \"description\": \"\"\n    }\n  ]\n}","options":{"raw":{"language":"json"}}}}},{"id":"4871dada-5fb4-4405-86b2-f559d9eafc07","name":"billCompanyAccountingArGmpApplication — Bill a GMP application","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ar/gmp_applications/:id/bill","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ar","gmp_applications",":id","bill"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Bill a GMP application\n\nNeeds ar_enter. Drafts the AR invoice of a certified application on the contract (customer: the contract owner; entity: the application's): one line per component billed this period (cost of the work, stored materials, general conditions, markups, fee, shared savings), or one net line when a component nets down; lines carry the job and the billing ref gmp_app:{id}; retainage is the period's retainage spread pro rata. The invoice then follows the normal submit, approve and post workflow (Dr AR, Dr retainage receivable, Cr contract revenue). 409 when already billed with a live invoice or the previous application has none. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"due_date\": \"2026-01-31\",\n  \"invoice_date\": \"2026-01-31\",\n  \"posting_date\": \"2026-01-31\",\n  \"revenue_account_id\": 0\n}","options":{"raw":{"language":"json"}}}}},{"id":"c05709b4-60ee-4605-8d4c-6ecf539811de","name":"certifyCompanyAccountingArGmpApplication — Certify a GMP application","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ar/gmp_applications/:id/certify","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ar","gmp_applications",":id","certify"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Certify a GMP application\n\nNeeds ar_approve, by a user who neither prepared nor changed the application. Records the owner's or architect's reviewer and date. Recomputes from the frozen entries: the result must equal what was submitted and certified_amount the current payment due (409 otherwise). Claims its job cost entries (each entry once across applications) and locks the application. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"certified_amount\": \"\",\n  \"note\": \"\",\n  \"reviewer_date\": \"2026-01-31\",\n  \"reviewer_name\": \"\",\n  \"reviewer_role\": \"owner\",\n  \"revision\": 0\n}","options":{"raw":{"language":"json"}}}}},{"id":"414e6570-7948-4f05-81bf-cde0ee2e35ad","name":"listCompanyAccountingArGmpApplicationPackage — GMP application owner package","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ar/gmp_applications/:id/package","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ar","gmp_applications",":id","package"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"GMP application owner package\n\nThe owner backup package as one PDF: summary, continuation by cost code, the period's cost register, labor report, disallowed costs, category limits, contingency and allowance position and usage log, stored materials, certification, then the period's AP invoice attachments (PDF pages, PNG/JPEG images). Requires the accounting:read scope."}},{"id":"68874e89-795b-4e0f-837d-fc09db96ac59","name":"listCompanyAccountingArGmpApplicationRegister — GMP application cost register","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ar/gmp_applications/:id/register","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ar","gmp_applications",":id","register"],"query":[{"key":"scope","value":"","disabled":true},{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true},{"key":"format","value":"","disabled":true}],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"GMP application cost register\n\nThe cost detail register: job cost entries of the period (scope=period, default) or to date (scope=to_date), with source document (AP bill, payroll run, journal), cost code, type, amount and disallowed status; paged (page, per_page up to 5000). format=csv returns the to-date register as CSV. Requires the accounting:read scope."}},{"id":"85802972-72a2-4ee0-8400-e26fdd451969","name":"returnCompanyAccountingArGmpApplication — Return a GMP application","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ar/gmp_applications/:id/return","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ar","gmp_applications",":id","return"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Return a GMP application\n\nNeeds ar_enter. Records that the owner/architect returned a submitted application, with the reason; it is edited and submitted again. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"reason\": \"\",\n  \"revision\": 0\n}","options":{"raw":{"language":"json"}}}}},{"id":"560fbceb-a858-4405-8a4b-42566448889f","name":"submitCompanyAccountingArGmpApplication — Submit a GMP application","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ar/gmp_applications/:id/submit","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ar","gmp_applications",":id","submit"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Submit a GMP application\n\nNeeds ar_enter. Recomputes the application (422 on calc errors such as a net credit or overdrawn contingency), freezes the job cost entries it claims and a hash of its result, and sends it to the owner/architect. The previous application must be billed and the period ended. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"revision\": 0\n}","options":{"raw":{"language":"json"}}}}},{"id":"b5e62c2f-dc30-492e-8ff4-c15a637cc154","name":"voidCompanyAccountingArGmpApplication — Void a GMP application","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ar/gmp_applications/:id/void","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ar","gmp_applications",":id","void"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Void a GMP application\n\nNeeds ar_enter. Voids a draft or returned application with a reason. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"reason\": \"\",\n  \"revision\": 0\n}","options":{"raw":{"language":"json"}}}}},{"id":"8fe601ae-ea98-487a-880f-1d4bb3659db8","name":"withdrawCompanyAccountingArGmpApplication — Withdraw a GMP certification","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ar/gmp_applications/:id/withdraw","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ar","gmp_applications",":id","withdraw"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Withdraw a GMP certification\n\nNeeds ar_approve. A certified application whose invoice is cancelled or reversed (or that has none) returns to returned and releases its job cost claims; later applications must be voided or withdrawn first. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"reason\": \"\",\n  \"revision\": 0\n}","options":{"raw":{"language":"json"}}}}},{"id":"20175988-a89e-40ab-8112-57d5e3095ecc","name":"decisionCompanyAccountingArGmpDraw — Decide a GMP draw","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ar/gmp_draws/:id/decision","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ar","gmp_draws",":id","decision"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Decide a GMP draw\n\nNeeds ar_approve, not the proposer. Approves or rejects a proposed draw; an approval that would overdraw its contingency is 409. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"decision\": \"approved\",\n  \"note\": \"\"\n}","options":{"raw":{"language":"json"}}}}},{"id":"904dcd39-e4f4-4df2-83ac-081d3b025ed9","name":"listCompanyAccountingArInvoices — List scoped invoices (default 100, maximum 100 per page)","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ar/invoices","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ar","invoices"],"query":[{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true},{"key":"customer_id","value":"","disabled":true},{"key":"status","value":"","disabled":true},{"key":"project_id","value":"","disabled":true,"description":"Header or any line on this project"},{"key":"date_from","value":"","disabled":true,"description":"Invoice date on or after"},{"key":"date_to","value":"","disabled":true,"description":"Invoice date on or before"},{"key":"q","value":"","disabled":true,"description":"Case-insensitive match on number, source reference or memo"},{"key":"overdue","value":"","disabled":true,"description":"true: posted, unreversed invoices with open receivable due before as_of"},{"key":"as_of","value":"","disabled":true,"description":"Overdue cutoff (default today)"},{"key":"disputed","value":"","disabled":true},{"key":"sort","value":"","disabled":true},{"key":"updated_since","value":"","disabled":true,"description":"Delta sync: only rows created or changed at or after this time (ISO 8601 with offset). Switches the list to ascending (updated_at, id) order; page is ignored and Next-Cursor continues it. Re-read with a small overlap (a few seconds) and dedupe by id."},{"key":"cursor","value":"","disabled":true,"description":"Opaque keyset cursor from a previous response's Next-Cursor header; each page costs the same however deep it is."}],"variable":[{"key":"company_id","value":"{{companyId}}"}]},"description":"List scoped invoices (default 100, maximum 100 per page)\n\nLists invoices within the caller entity scope. Requires an accounting view grant. Use returned revision values for subsequent writes. Requires the accounting:read scope."}},{"id":"3e60675a-dddb-4838-8252-7f349aab8d40","name":"createCompanyAccountingArInvoice — Create a draft; a retry with the same request key and payload returns the original invoice","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ar/invoices","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ar","invoices"],"variable":[{"key":"company_id","value":"{{companyId}}"}]},"description":"Create a draft; a retry with the same request key and payload returns the original invoice\n\nRequires ar_enter. Creates a draft using request_key (UUID). A retry with the same key and identical payload returns 200 with the original invoice; the same key with different data returns 409. Optional correction links an unreplaced reversed invoice and preserves its entity/customer/currency; its posting date must be on or after the reversal. Amounts are exact decimal strings. A standard invoice with a line on a project whose prime contract bills this customer by a non-progress method is 409 (bill it through invoices/from_billing). A correction of a contract billing invoice is 409. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"invoice\": {\n    \"customer_id\": 0,\n    \"entity_id\": 0,\n    \"invoice_date\": \"2026-01-31\",\n    \"lines\": [\n      {\n        \"amount\": null,\n        \"description\": null\n      }\n    ],\n    \"posting_date\": \"2026-01-31\",\n    \"source_reference\": \"\"\n  },\n  \"request_key\": \"\"\n}","options":{"raw":{"language":"json"}}}}},{"id":"0df542d0-9fcd-4215-86c6-4d2c7955879c","name":"createCompanyAccountingArInvoicesFromBilling — Draft an AR invoice from a non-progress billing","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ar/invoices/from_billing","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ar","invoices","from_billing"],"variable":[{"key":"company_id","value":"{{companyId}}"}]},"description":"Draft an AR invoice from a non-progress billing\n\nNeeds ar_enter. The prime contract's billing_method (tm, cost_plus, unit_price, gmp, milestone) must match billing.method; progress contracts bill by certified pay app (409). Caps, fees, markups, rates, retainage, unit items and the milestone schedule come only from the contract's approved billing terms (prime_contracts/{id}/billing_terms; 422 when none are approved); the request carries this period's facts. The calc in calc/billing.ts prices the period; its billed amounts become revenue lines with its retainage spread over them, and the draft follows submit, approve and post. NTE and GMP caps, the GMP settlement, the cost-plus fee billed before (fee cap and fixed fee) and each unit-price item's previous quantity read what AR already billed on the contract; fee_billed_before and previous_quantity only count when higher. A T&M ticket_id or cost-plus cost id already on a live (non-cancelled, unreversed) invoice of the contract is 409, as is a second GMP settlement. The resulting draft cannot be edited (cancel and bill again). A credit period is refused (enter a credit memo). Idempotent on request_key: same body replays (200), another body is 409. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"billing\": {\n    \"input\": {\n      \"lines\": [\n        {\n          \"cost_type\": null,\n          \"description\": null,\n          \"id\": null\n        }\n      ]\n    },\n    \"method\": null\n  },\n  \"invoice_date\": \"2026-01-31\",\n  \"prime_contract_id\": 0,\n  \"request_key\": \"\"\n}","options":{"raw":{"language":"json"}}}}},{"id":"e91751e6-e8c1-4d86-83ca-f9ab99f6a318","name":"createCompanyAccountingArInvoicesFromPaymentApplication — Bill a certified owner pay app in AR (once per pay app)","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ar/invoices/from_payment_application","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ar","invoices","from_payment_application"],"variable":[{"key":"company_id","value":"{{companyId}}"}]},"description":"Bill a certified owner pay app in AR (once per pay app)\n\nRequires ar_enter. Creates the draft AR invoice for an approved or paid prime-contract pay app, billed to the contract owner. The pay app is re-performed with the G702 calculator against retainage already billed for the contract and must reproduce its current payment due (line 8); posting debits AR_CONTROL line 8 and RETAINAGE_RECEIVABLE the change in line 5 and credits revenue the period billing. Retainage released on the pay app becomes release lines against the contract's earlier pay-app invoices. Earlier certified pay apps on the contract must already be billed and posted. A repeat call returns 200 with the same invoice. Billing again after the pay app's invoice is reversed creates a new draft linked as that invoice's correction; after a cancel, a new draft. A certified zero-billing pay app needs no invoice. A negative pay app bridges as a credit memo against the earlier pay-app invoices' open AR and retainage. A pay app on a contract whose billing_method is not progress is 409 (it bills through ar/invoices/from_billing). Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"payment_application_id\": 0\n}","options":{"raw":{"language":"json"}}}}},{"id":"43f28b55-5882-42f9-8842-b2a46ca5a8e6","name":"getCompanyAccountingArInvoice — Get scoped invoice","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ar/invoices/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ar","invoices",":id"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Get scoped invoice\n\nReturns the scoped invoice, current revision, lines and reversal/correction metadata. An excluded or absent source returns 404. Requires the accounting:read scope."}},{"id":"a548c260-6b38-4885-8463-08f90b3e9e5f","name":"updateCompanyAccountingArInvoice — Replace current draft revision; all editors are excluded from approval","request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ar/invoices/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ar","invoices",":id"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Replace current draft revision; all editors are excluded from approval\n\nRequires ar_enter. Replaces the current draft using top-level revision and a complete invoice object, including all lines; this is not an AP-style partial patch. A successful edit increments revision. A stale revision or non-draft state returns 409. Posted documents are corrected through reversal and a linked new draft. Pay-app and contract billing invoices (prime_contract_id set) are 409: cancel and bill again. A standard invoice with a line on a project whose prime contract bills this customer by a non-progress method is 409. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"invoice\": {\n    \"customer_id\": 0,\n    \"entity_id\": 0,\n    \"invoice_date\": \"2026-01-31\",\n    \"lines\": [\n      {\n        \"amount\": null,\n        \"description\": null\n      }\n    ],\n    \"posting_date\": \"2026-01-31\",\n    \"source_reference\": \"\"\n  },\n  \"revision\": 0\n}","options":{"raw":{"language":"json"}}}}},{"id":"e3434f8f-c4d8-4887-8959-53307ac30ad8","name":"listCompanyAccountingArInvoiceAttachments — List attachments on a AR invoice","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ar/invoices/:id/attachments","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ar","invoices",":id","attachments"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"List attachments on a AR invoice\n\nOldest first. Needs view_ledger and the parent's entity scope. Requires the accounting:read scope."}},{"id":"85ba9c2f-13be-47c6-8576-0c6b33394688","name":"createCompanyAccountingArInvoiceAttachment — Attach a file to a AR invoice","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ar/invoices/:id/attachments","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ar","invoices",":id","attachments"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Attach a file to a AR invoice\n\nMultipart upload (one `file` part, allow-listed type, up to MAX_UPLOAD_BYTES). Allowed after posting: attachments are not ledger data. Writes an attachment_added audit event on the parent in the same transaction. Needs ar_enter and the parent's entity scope. Requires the accounting:write scope.","body":{"mode":"formdata","formdata":[{"key":"file","type":"file","src":[]}]}}},{"id":"d3ab5722-2a0d-4662-8865-44465561da6d","name":"createCompanyAccountingArInvoiceCreditApplication — Apply a posted on-account credit memo to open invoice lines (Dr AR control / Cr receivable line). arApprove; idempotent by request_key.","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ar/invoices/:id/credit_applications","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ar","invoices",":id","credit_applications"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Apply a posted on-account credit memo to open invoice lines (Dr AR control / Cr receivable line). arApprove; idempotent by request_key.\n\nApplies the credit memo's available on-account credit (on-account lines less earlier applications and posted refunds) to open receivable lines of the same entity, customer and currency. The credit memo's preparer or contributors cannot place it (403, segregation of duties). More than available or open is 409. Reversing the credit memo reverses its applications. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"applications\": [\n    {\n      \"amount\": \"\",\n      \"bucket\": \"current\",\n      \"invoice_id\": 0,\n      \"invoice_revision\": 0,\n      \"journal_line_id\": 0\n    }\n  ],\n  \"posting_date\": \"2026-01-31\",\n  \"request_key\": \"\"\n}","options":{"raw":{"language":"json"}}}}},{"id":"4c7d67c0-df80-4a74-83dc-69b8f75e5bc1","name":"disputeCompanyAccountingArInvoice — Flag or clear a collections dispute on a posted invoice. Disputed invoices age in the Disputed column. arEnter.","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ar/invoices/:id/dispute","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ar","invoices",":id","dispute"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Flag or clear a collections dispute on a posted invoice. Disputed invoices age in the Disputed column. arEnter.\n\nFlag or clear a collections dispute on a posted invoice. Disputed invoices age in the Disputed column. arEnter. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"disputed\": false\n}","options":{"raw":{"language":"json"}}}}},{"id":"24a91cfc-baba-4ba3-8af9-6574fa2ac6ca","name":"listCompanyAccountingArInvoicePdf — Invoice PDF","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ar/invoices/:id/pdf","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ar","invoices",":id","pdf"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Invoice PDF\n\nAny accounting viewer in the invoice's entity. Requires the accounting:read scope."}},{"id":"f02aff6f-541c-4cfd-894b-eb97f8710e5e","name":"reverseCompanyAccountingArInvoice — Append a source-owned reversal. Independent arApprove required. Identical retries return the original reversal.","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ar/invoices/:id/reverse","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ar","invoices",":id","reverse"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Append a source-owned reversal. Independent arApprove required. Identical retries return the original reversal.\n\nRequires ar_approve independent of preparer/contributors, current revision, UUID request_key, date and reason. Only posted invoices can be reversed. First reverse all active applied receipts; invoice reversal cannot precede those reversals or original posting. Reconciled bank lines block reversal. The date must be in an open period. Matching retries return the same reversal; changed key/date/reason conflicts. Create a linked correction separately. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"date\": \"2026-01-31\",\n  \"reason\": \"\",\n  \"request_key\": \"\",\n  \"revision\": 0\n}","options":{"raw":{"language":"json"}}}}},{"id":"d86e469d-c3b1-430c-8686-2e803466b46d","name":"sendCompanyAccountingArInvoice — Queue a posted invoice for email to the customer's billing contact, with the invoice PDF attached.","request":{"method":"POST","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ar/invoices/:id/send","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ar","invoices",":id","send"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Queue a posted invoice for email to the customer's billing contact, with the invoice PDF attached.\n\nCommits an audit row (send_queued) and an outbox job in one transaction and returns 202 without contacting the email provider, so the company posting lock is never held on email latency. The job runner then emails the invoice with its PDF attached as the queuing user (AR read access is rechecked), retries a failed send with backoff, skips an invoice reversed in the meantime, and audits 'sent'. Requires the accounting:write scope."}},{"id":"680cca24-4464-46d9-8df9-9bbb34fd41ae","name":"transitionCompanyAccountingArInvoice — Submit, return to draft, independently approve, or post an invoice","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ar/invoices/:id/transition","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ar","invoices",":id","transition"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Submit, return to draft, independently approve, or post an invoice\n\nRequires revision and action. submit: draft to pending_approval (ar_enter); return: pending_approval to draft with reason and incremented revision (ar_approve); approve: pending_approval to approved (ar_approve, independent of preparer and all contributors); post: approved to posted (ar_enter). Posting revalidates accounts and period. An identical post retry at the current posted revision returns the existing invoice; do not assume every transition is retryable. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"action\": \"submit\",\n  \"revision\": 0\n}","options":{"raw":{"language":"json"}}}}},{"id":"696894e7-a014-4b3f-8e47-1fb5bf0939ba","name":"listCompanyAccountingArPaymentApplicationPdf — G702/G703 PDF of a certified owner pay app","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ar/payment_applications/:id/pdf","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ar","payment_applications",":id","pdf"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"G702/G703 PDF of a certified owner pay app\n\nAccounting viewers with view access to the project's pay apps. Application summary and continuation sheet with the industry form's math and column letters, neutral wording (no AIA form text). 409 before the pay app is certified; 422 for a commitment pay app. Requires the accounting:read scope."}},{"id":"cc77e0b6-cb8e-4283-85ad-7a2b7d068f77","name":"billingMethodCompanyAccountingArPrimeContract — Set a prime contract's billing method","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ar/prime_contracts/:id/billing_method","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ar","prime_contracts",":id","billing_method"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Set a prime contract's billing method\n\nNeeds ar_approve (not a project-scoped grant). progress bills by certified pay app; tm, cost_plus, unit_price, gmp and milestone bill through ar/invoices/from_billing. Once the contract has a non-cancelled AR invoice or a certified (approved or paid) pay app, a change is 409 unless conversion_reason is given. Audited with the reason and those counts. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"billing_method\": \"progress\",\n  \"conversion_reason\": \"\"\n}","options":{"raw":{"language":"json"}}}}},{"id":"efb4093e-0b5d-4fc8-8d6e-b81cfd770ab5","name":"listCompanyAccountingArPrimeContractBillingTerms — Get a prime contract's billing terms","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ar/prime_contracts/:id/billing_terms","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ar","prime_contracts",":id","billing_terms"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Get a prime contract's billing terms\n\nThe approved billing terms and any proposed change waiting for approval. Refused (403) to project-scoped grants. Requires the accounting:read scope."}},{"id":"5cd4fd8b-d8c0-4644-8cf1-34a22c02db18","name":"replaceCompanyAccountingArPrimeContractBillingTerms — Propose a prime contract's billing terms","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ar/prime_contracts/:id/billing_terms","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ar","prime_contracts",":id","billing_terms"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Propose a prime contract's billing terms\n\nNeeds ar_enter (not a project-scoped grant). Stores the body as the proposed terms and increments revision; the approved terms stay in force until an ar_approve user other than the proposer approves (billing_terms/approve). Audited. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}}}},{"id":"b142a448-f9c3-4576-85cc-f07be5379a9b","name":"createCompanyAccountingArPrimeContractBillingTermsApprove — Approve a prime contract's proposed billing terms","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ar/prime_contracts/:id/billing_terms/approve","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ar","prime_contracts",":id","billing_terms","approve"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Approve a prime contract's proposed billing terms\n\nNeeds ar_approve, and the approver must not be the user who proposed the change (403, segregation of duties). revision must be the proposed revision (409 when it changed, or when nothing is proposed). The proposed terms become the terms billing uses. Audited with the before and after terms. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"revision\": 0\n}","options":{"raw":{"language":"json"}}}}},{"id":"1d1b115f-e804-40f0-8b83-162c9f346e64","name":"listCompanyAccountingArPrimeContractCloseout — Get a prime contract's closeout documents","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ar/prime_contracts/:id/closeout","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ar","prime_contracts",":id","closeout"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Get a prime contract's closeout documents\n\nLists the contract's final retainage requirements and which are received or missing. Empty lists indicate no checklist when restricted_submittal_evidence is absent. Linked revision IDs and approval status require Submittals view on the project and submittals:read for scoped tokens. Refused (403) to project-scoped grants. Requires accounting:read."}},{"id":"d657e1a1-d918-4892-8de5-06a3d1f4afb1","name":"closeoutCompanyAccountingArPrimeContract — Set a prime contract's closeout documents","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ar/prime_contracts/:id/closeout","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ar","prime_contracts",":id","closeout"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Set a prime contract's closeout documents\n\nNeeds ar_approve and accounting:write. required lists at least one manual check or exact submittal:<revision ID> reference. received lists manual checks on file. Saving a checklist with new or existing references needs Submittals view and submittals:read for a scoped token. A final retainage release returns 422 at bridge, submit or post until every required item is complete. Audited.","body":{"mode":"raw","raw":"{\n  \"received\": [\n    \"\"\n  ],\n  \"required\": [\n    \"\"\n  ]\n}","options":{"raw":{"language":"json"}}}}},{"id":"67a289cc-a440-40e5-8f49-6008496da4de","name":"listCompanyAccountingArPrimeContractGmpApplications — List a GMP contract's applications","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ar/prime_contracts/:id/gmp_applications","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ar","prime_contracts",":id","gmp_applications"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"List a GMP contract's applications\n\nCost-of-work applications of a cost_plus prime contract with approved GMP terms, newest first. 409 when the contract is not a cost_plus GMP contract. Refused (403) to project-scoped grants. Requires the accounting:read scope."}},{"id":"fe4c1764-f285-42e9-8f9e-6a6fbd863602","name":"createCompanyAccountingArPrimeContractGmpApplication — Start a GMP application","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ar/prime_contracts/:id/gmp_applications","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ar","prime_contracts",":id","gmp_applications"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Start a GMP application\n\nNeeds ar_enter. Starts the contract's next application (draft) for the period ending period_end from posted job cost of the contract's job and entity: every job cost entry through the period end that no earlier certified application claimed. The previous application must be billed; one open application per contract (a repeat is 409). Refused when the contract has invoices outside applications. final: fee and lump-sum general conditions fully earned and the contractor's savings share billed. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"final\": false,\n  \"period_end\": \"2026-01-31\"\n}","options":{"raw":{"language":"json"}}}}},{"id":"d649062c-e3c4-4426-802e-efe1d0adda3b","name":"listCompanyAccountingArPrimeContractGmpCloseout — GMP close-out reconciliation","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ar/prime_contracts/:id/gmp_closeout","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ar","prime_contracts",":id","gmp_closeout"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"GMP close-out reconciliation\n\nFinal reconciliation from the last certified application: revised GMP, cost plus fee, savings and the contractor/owner split or the overrun absorbed, final price, billed to date (AR, posted and all live), final billing still due, retainage held, the closeout checklist and readiness flags. Refused (403) to project-scoped grants. Requires the accounting:read scope."}},{"id":"354e7f39-ca0e-4546-8140-c0b981915910","name":"listCompanyAccountingArPrimeContractGmpDraws — List GMP contingency and allowance draws","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ar/prime_contracts/:id/gmp_draws","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ar","prime_contracts",":id","gmp_draws"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"List GMP contingency and allowance draws\n\nThe usage log of the GMP contract's contingency transfers and allowance adjustments. Requires the accounting:read scope."}},{"id":"66a3b2eb-fbbd-441e-8330-6bee8f868fb3","name":"createCompanyAccountingArPrimeContractGmpDraw — Propose a GMP contingency or allowance draw","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ar/prime_contracts/:id/gmp_draws","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ar","prime_contracts",":id","gmp_draws"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Propose a GMP contingency or allowance draw\n\nNeeds ar_enter. A contingency transfer (contractor_contingency or owner_contingency, positive, to a cost code of the project) moves GMP budget to that code; an allowance adjustment (allowance_key of the GMP terms, signed) changes the allowance. Takes effect when another user approves it. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"allowance_key\": \"\",\n  \"amount\": \"\",\n  \"cost_code_id\": 0,\n  \"reason\": \"\",\n  \"reference\": \"\",\n  \"source\": \"contractor_contingency\"\n}","options":{"raw":{"language":"json"}}}}},{"id":"05813653-c05e-4782-8d7a-e5f69876d7a1","name":"listCompanyAccountingArReceipts — Receipt history, 50 per page","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ar/receipts","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ar","receipts"],"query":[{"key":"page","value":"1","disabled":true},{"key":"customer_id","value":"","disabled":true},{"key":"per_page","value":"100","disabled":true}],"variable":[{"key":"company_id","value":"{{companyId}}"}]},"description":"Receipt history, 50 per page\n\nLists scoped receipts, optionally filtered by customer_id, in pages of per_page (default 50). Pagination headers include Total, Per-Page and Link. Requires the accounting:read scope."}},{"id":"20abdd08-62f1-44d8-8731-4e70566993d2","name":"createCompanyAccountingArReceipt — Record a fully allocated draft; matching request-key retries return the original receipt","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ar/receipts","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ar","receipts"],"variable":[{"key":"company_id","value":"{{companyId}}"}]},"description":"Record a fully allocated draft; matching request-key retries return the original receipt\n\nRequires ar_enter. Creates a draft with UUID request_key and exact decimal string amount. Allocations must sum exactly to the receipt; unapplied cash is not supported. Each allocation identifies invoice_id, invoice_revision, journal_line_id and current or retainage bucket from open_items. Matching-key matching-payload retries return the original; changed payload conflicts. There is no receipt PATCH: cancel an unposted receipt or reverse a posted receipt, then create a linked correction using a new request key and reference. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"receipt\": {\n    \"amount\": \"\",\n    \"applications\": [\n      {\n        \"amount\": \"\",\n        \"bucket\": \"current\",\n        \"invoice_id\": 0,\n        \"invoice_revision\": 0,\n        \"journal_line_id\": 0\n      }\n    ],\n    \"cash_account_id\": 0,\n    \"customer_id\": 0,\n    \"entity_id\": 0,\n    \"posting_date\": \"2026-01-31\",\n    \"reference\": \"\"\n  },\n  \"request_key\": \"\"\n}","options":{"raw":{"language":"json"}}}}},{"id":"f1e8949a-48d5-4810-8941-3739fb84d13c","name":"listCompanyAccountingArReceiptsOpenItems — Open original AR distributions for one customer/entity; pages over open invoices only, oldest due first","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ar/receipts/open_items","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ar","receipts","open_items"],"query":[{"key":"entity_id","value":"","disabled":false},{"key":"customer_id","value":"","disabled":false},{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true},{"key":"currency","value":"","disabled":true,"description":"Receipt currency (ISO 4217). Defaults to the entity's functional currency; a foreign currency lists the invoices billed in it and the cash accounts denominated in it."}],"variable":[{"key":"company_id","value":"{{companyId}}"}]},"description":"Open original AR distributions for one customer/entity; pages over open invoices only, oldest due first\n\nRequires ar_enter and permitted entity_id/customer_id. Returns current open invoice journal lines with revision, bucket and exact open amount. These are current-state amounts only: no historical cutoff reconstruction or tie-out certification. Refresh before allocating; approval and posting revalidate available amounts. Requires the accounting:read scope."}},{"id":"4046961b-69d9-475c-84b5-0fda6ea89380","name":"getCompanyAccountingArReceipt — Receipt detail and immutable applications","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ar/receipts/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ar","receipts",":id"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Receipt detail and immutable applications\n\nReturns a scoped receipt with allocations and reversal/correction links; excluded or absent receipts return 404. Requires the accounting:read scope."}},{"id":"a755a946-0973-4d80-84c7-418a6fabbd78","name":"createCompanyAccountingArReceiptApplication — Apply a posted receipt's unapplied cash to open invoice lines, or transfer its allocations between lines. arApprove; idempotent by request_key.","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ar/receipts/:id/applications","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ar","receipts",":id","applications"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Apply a posted receipt's unapplied cash to open invoice lines, or transfer its allocations between lines. arApprove; idempotent by request_key.\n\nApply a posted receipt's unapplied cash to open invoice lines, or transfer its allocations between lines. arApprove; idempotent by request_key. The receipt's preparer or contributors cannot apply or transfer its cash (403, segregation of duties). Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"applications\": [\n    {\n      \"amount\": \"\",\n      \"bucket\": \"current\",\n      \"invoice_id\": 0,\n      \"invoice_revision\": 0,\n      \"journal_line_id\": 0\n    }\n  ],\n  \"kind\": \"apply\",\n  \"posting_date\": \"2026-01-31\",\n  \"request_key\": \"\"\n}","options":{"raw":{"language":"json"}}}}},{"id":"0bccd3df-5872-41a5-8935-70f966769b8e","name":"listCompanyAccountingArReceiptAttachments — List attachments on a AR receipt","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ar/receipts/:id/attachments","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ar","receipts",":id","attachments"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"List attachments on a AR receipt\n\nOldest first. Needs view_ledger and the parent's entity scope. Requires the accounting:read scope."}},{"id":"90f5ee22-080e-48c7-8212-982cde19e42c","name":"createCompanyAccountingArReceiptAttachment — Attach a file to a AR receipt","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ar/receipts/:id/attachments","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ar","receipts",":id","attachments"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Attach a file to a AR receipt\n\nMultipart upload (one `file` part, allow-listed type, up to MAX_UPLOAD_BYTES). Allowed after posting: attachments are not ledger data. Writes an attachment_added audit event on the parent in the same transaction. Needs ar_enter and the parent's entity scope. Requires the accounting:write scope.","body":{"mode":"formdata","formdata":[{"key":"file","type":"file","src":[]}]}}},{"id":"1edc23d1-b486-49ca-8bca-74dab9f9fa89","name":"reverseCompanyAccountingArReceipt — Append a source-owned reversal. Independent arApprove required. Identical retries return the original reversal.","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ar/receipts/:id/reverse","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ar","receipts",":id","reverse"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Append a source-owned reversal. Independent arApprove required. Identical retries return the original reversal.\n\nRequires ar_approve independent of preparer/contributors, current revision, UUID request_key, date and reason. Reverses posted cash and restores invoice bucket availability. Reversal cannot precede posting and must use an open period; reconciled bank lines block it. Matching retries return the original reversal; changed request data conflicts. A replacement receipt must link the reversed receipt, preserve entity/customer/currency and not predate reversal. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"date\": \"2026-01-31\",\n  \"reason\": \"\",\n  \"request_key\": \"\",\n  \"revision\": 0\n}","options":{"raw":{"language":"json"}}}}},{"id":"f0303c2e-f267-47e4-8772-7e89c80074a5","name":"transitionCompanyAccountingArReceipt — Independently approve or post; balances are revalidated under the company lock","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ar/receipts/:id/transition","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ar","receipts",":id","transition"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Independently approve or post; balances are revalidated under the company lock\n\nRequires current revision. approve moves draft to approved and requires ar_approve independent of preparer/contributors. post requires ar_enter and approved state; it rechecks open amounts, invoice provenance and cash account before posting atomically. Retrying post on the same posted revision returns the existing receipt. cancel needs a reason: draft cancellation requires ar_enter; approved cancellation requires independent ar_approve. Posted receipts must be reversed. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"action\": \"approve\",\n  \"revision\": 0\n}","options":{"raw":{"language":"json"}}}}},{"id":"d7248b23-1995-4dcf-8c45-35e712958828","name":"listCompanyAccountingArRefunds — Customer refunds, newest first (paginated).","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ar/refunds","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ar","refunds"],"query":[{"key":"customer_id","value":"","disabled":true},{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true}],"variable":[{"key":"company_id","value":"{{companyId}}"}]},"description":"Customer refunds, newest first (paginated).\n\nRefunds in the caller's entities; project-scoped grants are refused. Requires the accounting:read scope."}},{"id":"7198b728-ac01-4512-8d38-9c935820f8bc","name":"createCompanyAccountingArRefund — Draft a refund of customer credit: a posted receipt's unapplied cash or an on-account credit memo. arEnter; idempotent by request_key.","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ar/refunds","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ar","refunds"],"variable":[{"key":"company_id","value":"{{companyId}}"}]},"description":"Draft a refund of customer credit: a posted receipt's unapplied cash or an on-account credit memo. arEnter; idempotent by request_key.\n\nThe amount may not exceed the credit available now (409); drafts reserve nothing and are rechecked at posting. Posting is a separate independent step. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"refund\": {\n    \"amount\": \"\",\n    \"bank_account_id\": 0,\n    \"posting_date\": \"2026-01-31\"\n  },\n  \"request_key\": \"\"\n}","options":{"raw":{"language":"json"}}}}},{"id":"ca57707b-b6f7-4dc0-8394-eb38d3a34cc7","name":"getCompanyAccountingArRefund — Refund detail.","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ar/refunds/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ar","refunds",":id"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Refund detail.\n\nRefund in the caller's entities. Requires the accounting:read scope."}},{"id":"5bb28582-0f9d-47ec-8388-c630a7c12b55","name":"transitionCompanyAccountingArRefund — Post, cancel or reverse a customer refund.","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/ar/refunds/:id/transition","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","ar","refunds",":id","transition"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Post, cancel or reverse a customer refund.\n\npost: an arApprove user other than the preparer (403 otherwise) approves and posts Dr CUSTOMER_DEPOSITS (receipt) or AR control (credit memo) / Cr the bank account, after rechecking the available credit (409). cancel: a draft, with a reason (arEnter). reverse: a posted refund, with a reason and date (arApprove, not the preparer); posts the reversing entry. A matching retry of a completed transition returns the refund. A receipt or credit memo with a posted refund cannot be reversed until the refund is. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"action\": \"post\"\n}","options":{"raw":{"language":"json"}}}}},{"id":"f6e2c787-d0b5-43f9-811e-3fc634bcd409","name":"listCompanyAccountingAssets — List fixed assets","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/assets","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","assets"],"query":[{"key":"filters[status]","value":"","disabled":true,"description":"active, disposed"},{"key":"filters[equipment_id]","value":"","disabled":true,"description":"Equipment ids"},{"key":"search","value":"","disabled":true,"description":"Number, name or category"},{"key":"page","value":"1","disabled":true,"description":"Page number"},{"key":"per_page","value":"100","disabled":true,"description":"Page size"}],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"List fixed assets\n\nThe asset register with posted accumulated depreciation and net book value. Filter with `filters[status]` (active, disposed), `filters[equipment_id]`, or `search` (number, name, category). Requires the accounting:read scope. Entity-wide: a project-scoped (project_manager_view) grant gets 403."}},{"id":"3c528c9a-829a-4b4c-8fc3-bc8db7b17821","name":"createCompanyAccountingAsset — Add a fixed asset","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/assets","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","assets"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Add a fixed asset\n\nAdds an asset (FA-#### numbering) with its book parameters (posting) and an optional MACRS tax book (memo). With `acquisition_offset_account_id` it also posts Dr asset / Cr that account on the acquisition date. Needs post_journal. Audited. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"fixed_asset\": {\n    \"acquisition_date\": \"2026-01-31\",\n    \"cost\": \"\",\n    \"in_service_date\": \"2026-01-31\",\n    \"name\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"a46fbb12-70c6-40f1-80c3-8ea1f7d6c499","name":"createCompanyAccountingAssetsCapitalize — Capitalize an AP bill line","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/assets/capitalize","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","assets","capitalize"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Capitalize an AP bill line\n\nRegisters a line of a posted AP bill coded to a fixed_asset account as a fixed asset: cost, asset account, entity and acquisition date come from the bill, and no acquisition entry posts (the bill already debited the asset account), so the register ties to the GL. One live asset per line (409); the bill cannot be voided while the asset is live. Needs post_journal. Audited. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"fixed_asset\": {\n    \"ap_bill_line_id\": 0\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"8a221529-5491-4e7a-8fb0-d36efa6227d4","name":"listCompanyAccountingAssetsClasses — List asset classes","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/assets/classes","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","assets","classes"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"List asset classes\n\nAsset classes of the company, by name. Requires the accounting:read scope."}},{"id":"1a61287b-751e-4753-81d1-db19782a15ff","name":"createCompanyAccountingAssetsClass — Add an asset class","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/assets/classes","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","assets","classes"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Add an asset class\n\nDefault accounts, method, life, convention and MACRS class for new assets (fixed_asset.class_id). Needs post_journal. Audited. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"asset_class\": {\n    \"accumulated_account_id\": 0,\n    \"asset_account_id\": 0,\n    \"book_life_months\": 0,\n    \"expense_account_id\": 0,\n    \"name\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"2991e957-df14-4602-8cd8-363298775c90","name":"listCompanyAccountingAssetsDepreciationRuns — List depreciation runs","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/assets/depreciation_runs","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","assets","depreciation_runs"],"query":[{"key":"page","value":"1","disabled":true,"description":"Page number"},{"key":"per_page","value":"100","disabled":true,"description":"Page size"}],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"List depreciation runs\n\nPosted book-depreciation runs, newest first. Requires the accounting:read scope. Entity-wide: a project-scoped (project_manager_view) grant gets 403."}},{"id":"d51dd6af-1e7c-44fc-817d-885bb5d1b625","name":"createCompanyAccountingAssetsDepreciationRun — Preview or post a depreciation run","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/assets/depreciation_runs","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","assets","depreciation_runs"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Preview or post a depreciation run\n\nFor the period, each active asset posts its book schedule to date minus what is already posted (so a reversed run is caught up next time, and repeating a run posts only what is new). `preview: true` returns the items and posting preview (200). Otherwise posts one FA journal entry dated the period end (201); 422 when nothing is due or the period is closed. Needs post_journal. Requires the accounting:write scope. A project-scoped (project_manager_view) grant gets 403, preview included.","body":{"mode":"raw","raw":"{\n  \"depreciation_run\": {\n    \"period_id\": 0\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"7d5dd5e7-8b93-436d-860a-c10e70cf043c","name":"getCompanyAccountingAssetsDepreciationRun — Show a depreciation run","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/assets/depreciation_runs/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","assets","depreciation_runs",":id"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Show a depreciation run\n\nThe run with its journal lines (one debit and one credit per asset). Requires the accounting:read scope. Entity-wide: a project-scoped (project_manager_view) grant gets 403."}},{"id":"7d39f61b-0e74-4ec8-87e9-eda962e991f9","name":"reverseCompanyAccountingAssetsDepreciationRun — Reverse a depreciation run","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/assets/depreciation_runs/:id/reverse","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","assets","depreciation_runs",":id","reverse"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Reverse a depreciation run\n\nPosts the mirror entry on `date` and marks the run's entry reversed; the next run catches the assets up again. Needs post_journal. Audited. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"reversal\": {\n    \"date\": \"2026-01-31\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"7780ba8c-bff3-4df7-8d6f-aa14f1d13823","name":"createCompanyAccountingAssetsEquipmentLog — Post approved equipment logs","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/assets/equipment_logs","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","assets","equipment_logs"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Post approved equipment logs\n\nTurns approved field equipment logs (status approved or unset, linked to an equipment unit) dated from..to into equipment usage: operating hours at the operating hourly rate, idle hours at the idle hourly rate, each posted as its own voidable job cost entry. A log and rate type posts once. preview lists what would post and what is skipped (no cost code, no rate, already posted) without posting (200); posting is all-or-nothing (201). Preview needs accounting access; posting needs post_journal. Audited. Requires the accounting:read scope.","body":{"mode":"raw","raw":"{\n  \"equipment_logs\": {\n    \"from\": \"2026-01-31\",\n    \"to\": \"2026-01-31\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"a83fec64-8dd5-45ac-8518-34b9a5b37e77","name":"listCompanyAccountingAssetsEquipmentRates — List equipment internal rates","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/assets/equipment_rates","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","assets","equipment_rates"],"query":[{"key":"equipment_id","value":"","disabled":true,"description":"One equipment unit"},{"key":"page","value":"1","disabled":true,"description":"Page number"},{"key":"per_page","value":"100","disabled":true,"description":"Page size"}],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"List equipment internal rates\n\nEffective-dated internal rates by unit, type (operating, standby, idle) and unit of time. Requires the accounting:read scope. Entity-wide: a project-scoped (project_manager_view) grant gets 403."}},{"id":"6558d4ce-5caf-4389-8acc-771258cc86c6","name":"createCompanyAccountingAssetsEquipmentRate — Add an equipment internal rate","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/assets/equipment_rates","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","assets","equipment_rates"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Add an equipment internal rate\n\nJob cost account defaults to 5410 and the recovery (contra-cost) account to 5490. Needs post_journal. Audited. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"equipment_rate\": {\n    \"effective_from\": \"2026-01-31\",\n    \"equipment_id\": 0,\n    \"rate\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"64cb66fb-a492-4668-8910-761c7951a3e6","name":"listCompanyAccountingAssetsEquipmentRecovery — Equipment recovery vs cost","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/assets/equipment_recovery","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","assets","equipment_recovery"],"query":[{"key":"from","value":"","disabled":true,"description":"Posting date on or after"},{"key":"to","value":"","disabled":true,"description":"Posting date on or before"}],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Equipment recovery vs cost\n\nUnit P&L by equipment: internal-rate recovery from jobs vs actual unit cost (depreciation, fuel, repairs and other expense lines carrying the unit). Positive over_under = over-recovered. Requires the accounting:read scope. Entity-wide: a project-scoped (project_manager_view) grant gets 403."}},{"id":"399a094c-90e6-47aa-85e5-426e184421e4","name":"listCompanyAccountingAssetsEquipmentRecoveryReport — Equipment cost recovery report","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/assets/equipment_recovery/report","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","assets","equipment_recovery","report"],"query":[{"key":"from","value":"","disabled":false},{"key":"to","value":"","disabled":false},{"key":"class_key","value":"","disabled":true}],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Equipment cost recovery report\n\nOver/under-recovery per unit and equipment class for from..to, by month: actual cost (expense, cost-of-revenue and other-expense lines coded to the unit, e.g. depreciation, repairs, fuel, insurance, interest) vs recovery (the unit's lines on the rates' recovery accounts: usage charged to jobs and posted true-ups). The tie-out reconciles each recovery account's GL activity to the part attributed to units and each cost account's GL activity to the part coded to units. suggested_hourly_rate = cost / operating hours (advisory). Class = the unit's fixed-asset class, else its category, else Unclassified. Requires the accounting:read scope. A project-scoped grant gets 403; an entity-scoped grant sees its entities' lines."}},{"id":"ab61c374-2f50-49ef-80fb-8a8cafcb1c61","name":"listCompanyAccountingAssetsEquipmentTrueups — List equipment true-ups","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/assets/equipment_trueups","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","assets","equipment_trueups"],"query":[{"key":"period_id","value":"","disabled":true}],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"List equipment true-ups\n\nTrue-up runs, newest period first (200 at most). Requires the accounting:read scope. Needs a grant over every entity (a project- or entity-scoped grant gets 403)."}},{"id":"3a5b086b-bd7b-475c-89fa-ac2984d4245f","name":"createCompanyAccountingAssetsEquipmentTrueup — Prepare an equipment true-up","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/assets/equipment_trueups","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","assets","equipment_trueups"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Prepare an equipment true-up\n\nPrepares the true-up of one period and equipment class: each unit's cost - recovery is allocated to the jobs that used it in the period by their usage charges (policy jobs; a unit with no usage goes to overhead_account_id when given, else it is skipped) or to overhead_account_id (policy overhead), against the unit's recovery account. Returns the prepared run with the same evidence (200, unchanged) or supersedes it. 409 when a posted run already covers the period and class; 422 for a closed period or nothing to true up. A second user approves and posts. Needs post_journal and a grant over every entity. Audited. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"trueup\": {\n    \"class_key\": \"\",\n    \"period_id\": 0,\n    \"policy\": \"jobs\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"4870a4ed-45c6-4663-8c2a-65a76ad5c161","name":"getCompanyAccountingAssetsEquipmentTrueup — Show an equipment true-up","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/assets/equipment_trueups/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","assets","equipment_trueups",":id"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Show an equipment true-up\n\nUnits, lines, status and approvals. Requires the accounting:read scope. Needs a grant over every entity."}},{"id":"bea86289-9e3b-4583-84f1-2d30951ee646","name":"decisionCompanyAccountingAssetsEquipmentTrueup — Approve or cancel an equipment true-up","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/assets/equipment_trueups/:id/decision","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","assets","equipment_trueups",":id","decision"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Approve or cancel an equipment true-up\n\napprove (approve_journal, never the preparer: 403) recomputes the run and posts one balanced JC entry dated the period end (409 if costs or usage changed since preparation); cancel (post_journal) needs a reason. A repeat of the same decision returns the run. Audited. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"decision\": {\n    \"action\": \"approve\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"0c1ee802-0621-4b17-8d5f-e72d3579f131","name":"reverseCompanyAccountingAssetsEquipmentTrueup — Reverse a posted equipment true-up","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/assets/equipment_trueups/:id/reverse","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","assets","equipment_trueups",":id","reverse"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Reverse a posted equipment true-up\n\nReverses the run's entry on date with a reason (approve_journal); the period and class can then be trued up again. Idempotent for the same date and reason. Audited. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"reversal\": {\n    \"date\": \"2026-01-31\",\n    \"reason\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"9021ed06-1cae-4327-8474-1d63236f82cd","name":"listCompanyAccountingAssetsEquipmentUsages — List equipment usage charges","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/assets/equipment_usages","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","assets","equipment_usages"],"query":[{"key":"equipment_id","value":"","disabled":true,"description":"Equipment unit"},{"key":"project_id","value":"","disabled":true,"description":"Project"},{"key":"from","value":"","disabled":true,"description":"On or after"},{"key":"to","value":"","disabled":true,"description":"On or before"},{"key":"page","value":"1","disabled":true,"description":"Page number"},{"key":"per_page","value":"100","disabled":true,"description":"Page size"}],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"List equipment usage charges\n\nUsage charged to jobs, newest first. Requires the accounting:read scope. A project-scoped (project_manager_view) grant sees only usage on projects it is a member of."}},{"id":"3eac25ec-47b5-497f-83d3-1928d93c003f","name":"createCompanyAccountingAssetsEquipmentUsage — Charge equipment usage to a job","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/assets/equipment_usages","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","assets","equipment_usages"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Charge equipment usage to a job\n\nPrices the quantity at the rate effective on the date and posts Dr job cost (project, cost code, unit; writes the job cost subledger as equipment cost) / Cr equipment cost recovery (unit) in the JC journal (201). `preview: true` validates against the ledger and returns the lines without posting (200). Needs post_journal. Requires the accounting:write scope. A project-scoped (project_manager_view) grant gets 403, preview included.","body":{"mode":"raw","raw":"{\n  \"equipment_usage\": {\n    \"cost_code_id\": 0,\n    \"date\": \"2026-01-31\",\n    \"equipment_id\": 0,\n    \"project_id\": 0,\n    \"quantity\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"a86fd23f-8d47-466f-86b6-b4be76fcd358","name":"voidCompanyAccountingAssetsEquipmentUsage — Void equipment usage","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/assets/equipment_usages/:id/void","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","assets","equipment_usages",":id","void"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Void equipment usage\n\nReverses the usage entry (and so its job cost rows) on `date` with a reason and marks the usage voided. Repeating with the same date and reason returns it unchanged; a different date or reason is 409. Needs post_journal. Audited. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"reversal\": {\n    \"date\": \"2026-01-31\",\n    \"reason\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"81dd28b2-ca88-42f2-8781-4e750c3b0cd6","name":"listCompanyAccountingAssetsEquipmentUtilization — Equipment utilization","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/assets/equipment_utilization","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","assets","equipment_utilization"],"query":[{"key":"from","value":"","disabled":true},{"key":"to","value":"","disabled":true}],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Equipment utilization\n\nOperating, idle and standby hours (hourly usage), utilization % (operating / all hours) and recovery per unit from posted usage, optionally within from..to. Requires the accounting:read scope."}},{"id":"6e2cb6fa-ce01-4cf2-8dc8-d4ece71d1944","name":"createCompanyAccountingAssetsImport — Import the fixed asset register","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/assets/import","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","assets","import"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Import the fixed asset register\n\nCSV columns: name, legacy_number, description, category, class, equipment_asset_number, asset_account, accumulated_account, expense_account, cost, salvage, method, life_months, convention, acquisition_date, in_service_date, opening_accumulated, depreciated_through, tax_class, total_units (headers case-insensitive; up to 2,000 rows). Without apply, a preview (200, or 422 with row errors). With apply, every row must validate; all are added in one transaction (201) and nothing posts (the GL balances come in through the opening trial balance); tie_out compares the GL fixed asset and accumulated depreciation accounts with the register for the entity as of as_of (default today). Preview needs accounting access; apply needs post_journal. Audited. An Idempotency-Key makes a retried apply replay the first response instead of importing twice. Requires the accounting:read scope.","body":{"mode":"raw","raw":"{\n  \"apply\": false,\n  \"as_of\": \"2026-01-31\",\n  \"csv\": \"\",\n  \"entity_id\": 0\n}","options":{"raw":{"language":"json"}}}}},{"id":"bf5bd187-ae39-4185-8c85-f4cf307a46b1","name":"getCompanyAccountingAsset — Show a fixed asset","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/assets/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","assets",":id"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Show a fixed asset\n\nThe asset with its book schedule by fiscal year, tax (MACRS) schedule, book-vs-tax temporary differences, and every ledger line posted for it. Each schedule carries an `explain` trace. Requires the accounting:read scope. Entity-wide: a project-scoped (project_manager_view) grant gets 403."}},{"id":"f7f56be8-8650-4bb9-88c5-6cebf30af7ca","name":"updateCompanyAccountingAsset — Update a fixed asset","request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/assets/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","assets",":id"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Update a fixed asset\n\nDescriptive and tax-book fields only; the book basis, life and method are locked. Needs post_journal. Audited. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"fixed_asset\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"c01af43b-d359-4397-874d-17236120b934","name":"createCompanyAccountingAssetAdjustment — Post an asset adjustment","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/assets/:id/adjustments","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","assets",":id","adjustments"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Post an asset adjustment\n\naddition (Dr asset / Cr offset_account_id), impairment (Dr offset_account_id loss / Cr asset; at most net book value less salvage), transfer (to_entity_id, intercompany; and/or category) or partial_disposal (amount = cost removed, accumulated removed in proportion, proceeds and gain/loss). Depreciation must be posted through the month before `date` and not for `date`'s month or later (reverse those runs first); a partial disposal may not leave net book value below salvage; the book schedule then rebases from the adjustment month over the remaining life. Needs post_journal. Audited. Requires the accounting:write scope. estimate_change (ASC 250-10-45-17) posts no entry: the asset takes the new life, salvage or method and the schedule rebases from the adjustment month, holding accumulated depreciation through the month before.","body":{"mode":"raw","raw":"{\n  \"adjustment\": {\n    \"date\": \"2026-01-31\",\n    \"kind\": \"addition\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"3b50b2df-167b-4b2b-8609-d43f881b8049","name":"listCompanyAccountingAssetAttachments — List attachments on a fixed asset","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/assets/:id/attachments","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","assets",":id","attachments"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"List attachments on a fixed asset\n\nOldest first. Needs view_ledger and the parent's entity scope. Requires the accounting:read scope."}},{"id":"0da8db4d-4729-4839-8d7f-fc32dd29fe1e","name":"createCompanyAccountingAssetAttachment — Attach a file to a fixed asset","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/assets/:id/attachments","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","assets",":id","attachments"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Attach a file to a fixed asset\n\nMultipart upload (one `file` part, allow-listed type, up to MAX_UPLOAD_BYTES). Allowed after posting: attachments are not ledger data. Writes an attachment_added audit event on the parent in the same transaction. Needs post_journal and the parent's entity scope. Requires the accounting:write scope.","body":{"mode":"formdata","formdata":[{"key":"file","type":"file","src":[]}]}}},{"id":"572f7aeb-4201-4750-81fd-b9f782d853bb","name":"disposeCompanyAccountingAsset — Dispose of a fixed asset","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/assets/:id/dispose","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","assets",":id","dispose"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Dispose of a fixed asset\n\nWith `preview: true` returns the plan without posting (200, read scope suffices). Otherwise posts catch-up depreciation through the month before disposal, then the disposal entry (remove cost and accumulated depreciation, record proceeds and selling costs, gain to 7200 or loss to 8200 unless accounts are given) and marks the asset disposed (201). Needs post_journal. Audited. Requires the accounting:write scope. A project-scoped (project_manager_view) grant gets 403, preview included.","body":{"mode":"raw","raw":"{\n  \"disposal\": {\n    \"date\": \"2026-01-31\",\n    \"proceeds\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"caac8748-a9f9-4925-81c6-553dbf7180a2","name":"createCompanyAccountingAssetMeterReading — Record a UOP meter reading","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/assets/:id/meter_readings","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","assets",":id","meter_readings"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Record a UOP meter reading\n\nUnits used in a month (YYYY-MM) for a units-of-production asset; replaces that month's reading. The next depreciation run catches up to base x cumulative units / total units. Needs post_journal. Audited. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"meter_reading\": {\n    \"period\": \"\",\n    \"units\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"ecc375a6-cc8f-4fb3-80ec-872495257238","name":"undoDisposalCompanyAccountingAsset — Undo a disposal","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/assets/:id/undo_disposal","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","assets",":id","undo_disposal"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Undo a disposal\n\nReverses the disposal entry and its depreciation true-up on `date` with a reason, and returns the asset to active. Repeating with the same date and reason returns the asset unchanged. Needs post_journal. Audited. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"reversal\": {\n    \"date\": \"2026-01-31\",\n    \"reason\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"4d406a60-da97-46ef-8cd8-30145561cb09","name":"voidCompanyAccountingAsset — Void an asset added in error","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/assets/:id/void","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","assets",":id","void"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Void an asset added in error\n\nReverses the acquisition entry (if any) on `date` with a reason and sets status voided. Refused (422) once depreciation or an adjustment has posted: dispose of the asset instead. Repeating with the same date and reason returns the asset unchanged; a different one is 409. Needs post_journal. Audited. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"reversal\": {\n    \"date\": \"2026-01-31\",\n    \"reason\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"65782436-806b-4018-88c8-e9e736674caf","name":"getCompanyAccountingAttachment — Download an attachment","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/attachments/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","attachments",":id"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Download an attachment\n\nReturns the stored bytes as application/octet-stream with Content-Disposition: attachment (never rendered inline). Access is re-checked against the parent record. Requires the accounting:read scope."}},{"id":"3f0909bc-0d30-4ec2-8888-4ea1127e15f2","name":"listCompanyAccountingBankingAccounts — List bank and card accounts","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/banking/accounts","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","banking","accounts"],"query":[{"key":"active","value":"","disabled":true,"description":"Filter by active"}],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"List bank and card accounts\n\nBank, savings, money market, cash and credit card registers, each tied to one GL account. Bank numbers are masked. Requires the accounting:read scope. Entity-wide: a project-scoped (project_manager_view) grant gets 403."}},{"id":"9cb2b12a-3ef3-482f-8c06-7549b353f1b1","name":"createCompanyAccountingBankingAccount — Create a bank account","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/banking/accounts","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","banking","accounts"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Create a bank account\n\nLinks an existing GL account (bank/cash, or credit_card for cards) or creates one (`create_gl_account`). Needs manage_coa; bank numbers need manage_vendor_banking. Audited. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"bank_account\": {\n    \"kind\": \"checking\",\n    \"name\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"b28fa9b0-18ec-49ae-8cf9-2a9c6cbbb370","name":"getCompanyAccountingBankingAccount — Show a bank account","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/banking/accounts/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","banking","accounts",":id"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Show a bank account\n\nOne bank account with masked numbers. Requires the accounting:read scope."}},{"id":"7881a21d-22b5-408c-80ec-bf77e012d33f","name":"updateCompanyAccountingBankingAccount — Update a bank account","request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/banking/accounts/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","banking","accounts",":id"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Update a bank account\n\nName, institution, controls, CSV mapping, check numbering. Account and routing numbers need manage_vendor_banking and are not applied: they become pending_bank_change (audited bank_change_requested) until a second manage_vendor_banking user approves them via POST .../bank_change. entity_id can't change once the account's GL account has journal lines (422). Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"bank_account\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"97396060-bea9-409c-88fc-65140ca9a943","name":"activityPreviewCompanyAccountingBankingAccount — Inspect one sandbox card activity response without persistence","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/banking/accounts/:id/activity_preview","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","banking","accounts",":id","activity_preview"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Inspect one sandbox card activity response without persistence\n\nRequires accounting:read token scope, manageIntegrations and bankReconcile, accounting MFA and whole-account entity access. Mapping is a transient operator assertion. Source polarity is preserved, never interpreted as statement direction. No provider calls, imports, matches, receipts, jobs or postings. Supported settlement exponents: USD/CAD/EUR/GBP=2, JPY=0, KWD=3; other currencies excluded. No local duplicate identity inferred.","body":{"mode":"raw","raw":"{\n  \"currency\": \"\",\n  \"entity_id\": 0,\n  \"external_entity_id\": \"\",\n  \"sandbox_confirmed\": true,\n  \"source_page\": \"\"\n}","options":{"raw":{"language":"json"}}}}},{"id":"67107069-3b1e-43ae-86bc-a4fabe9fa532","name":"bankChangeCompanyAccountingBankingAccount — Approve or reject a pending bank number change","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/banking/accounts/:id/bank_change","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","banking","accounts",":id","bank_change"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Approve or reject a pending bank number change\n\nA manage_vendor_banking user other than the requester applies or discards pending_bank_change. change_hash must match the change reviewed (409 stale_change otherwise). Audited as bank_changed or bank_change_rejected. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"change_hash\": \"\",\n  \"decision\": \"approve\"\n}","options":{"raw":{"language":"json"}}}}},{"id":"82c77fce-03fd-468b-87e0-66cd523ae283","name":"listCompanyAccountingBankingAccountInbox — Matching inbox","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/banking/accounts/:id/inbox","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","banking","accounts",":id","inbox"],"query":[{"key":"status","value":"","disabled":true,"description":"Default unmatched"}],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Matching inbox\n\nStatement lines with one suggestion each: a match (source match; confidence high = amount + reference/payee/check number agree, medium = unique amount or a combination, low = several candidates) or a bank rule. Each book item is offered to one line only. Requires the accounting:read scope. Entity-wide: a project-scoped (project_manager_view) grant gets 403."}},{"id":"4943cc6a-b3d2-49ec-86f9-8b615a5dc6d7","name":"createCompanyAccountingBankingAccountInboxAcceptHigh — Accept all High matches","request":{"method":"POST","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/banking/accounts/:id/inbox/accept_high","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","banking","accounts",":id","inbox","accept_high"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Accept all High matches\n\nMatches every high-confidence suggestion on the account (book lines become cleared, not reconciled). Needs bank_reconcile. Requires the accounting:write scope."}},{"id":"3e824e51-ff6d-41ca-8654-3f8ebe1fc7f8","name":"listCompanyAccountingBankingAccountOutstanding — Outstanding items","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/banking/accounts/:id/outstanding","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","banking","accounts",":id","outstanding"],"query":[{"key":"as_of","value":"","disabled":true,"description":"Default today"},{"key":"page","value":"1","disabled":true,"description":"Page (1-based)"},{"key":"per_page","value":"100","disabled":true,"description":"Items per page"}],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Outstanding items\n\nDeposits in transit and outstanding payments as of a date, with the proof book balance = reconciled and void + outstanding (difference 0.00). The item lists are paginated (Total counts both lists); totals always cover every outstanding line. Requires the accounting:read scope."}},{"id":"bcbf4af9-5f04-436a-8703-93d0073c6ef8","name":"positivePayCompanyAccountingBankingAccount — Generate a positive pay file","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/banking/accounts/:id/positive_pay","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","banking","accounts",":id","positive_pay"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Generate a positive pay file\n\nCSV issue file of checks not yet sent plus voids of checks the bank already has. Generated on demand, never stored; marks the checks sent unless dry_run. A dry run returns counts and totals only (content is empty: the file carries the decrypted account number). Pending checks are not included until released. Needs release_payments; audited. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"positive_pay\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"715a077b-3de7-4365-85e7-3fcae21b30fc","name":"listCompanyAccountingBankingAccountPositivePayBatches — List positive pay batches","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/banking/accounts/:id/positive_pay/batches","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","banking","accounts",":id","positive_pay","batches"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"List positive pay batches\n\nPositive pay files sent from this account (banking and AP run files), newest first: counts and totals only. Needs release_payments. Requires the accounting:read scope."}},{"id":"624cec27-78a7-4495-8420-bfb3b0e0a60b","name":"regenerateCompanyAccountingBankingAccountPositivePayBatch — Regenerate a positive pay batch","request":{"method":"POST","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/banking/accounts/:id/positive_pay/batches/:batch_id/regenerate","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","banking","accounts",":id","positive_pay","batches",":batch_id","regenerate"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""},{"key":"batch_id","value":""}]},"description":"Regenerate a positive pay batch\n\nRebuilds a sent batch (for a lost download): the same checks with the status each was sent with, under the original file name. Marks nothing. A batch holds only the rows it marked first (an AP run file that repeated rows an earlier file sent regenerates without them), and the current account number and file options are used. Needs release_payments; audited as positive_pay_regenerated. Requires the accounting:write scope."}},{"id":"3030fa69-421e-4e33-8071-becd5db7cf14","name":"listCompanyAccountingBankingAccountReceiptCapture — First receipt submissions needed for existing native card charge lines","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/banking/accounts/:id/receipt_capture","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","banking","accounts",":id","receipt_capture"],"query":[{"key":"after","value":"","disabled":true},{"key":"per_page","value":"100","disabled":true}],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"First receipt submissions needed for existing native card charge lines\n\nRead only. Requires accounting:read token scope, bankReconcile and whole-account access; project-scoped grants refused. Non-void card charges strictly above the current Decimal account threshold with no submission history. Legacy assertions do not exclude work. Scoped ascending line-ID cursor; no counts. Final common authorization/state snapshot; 409 if changed. No import, matching or financial writes."}},{"id":"8297a04e-3918-4454-8003-70c9763a7782","name":"listCompanyAccountingBankingAccountReconciliations — List reconciliations","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/banking/accounts/:id/reconciliations","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","banking","accounts",":id","reconciliations"],"query":[{"key":"page","value":"1","disabled":true,"description":"Page (1-based)"},{"key":"per_page","value":"100","disabled":true,"description":"Items per page"}],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"List reconciliations\n\nSessions for the account, latest statement first. Paginated. Requires the accounting:read scope. Entity-wide: a project-scoped (project_manager_view) grant gets 403."}},{"id":"3cf1c9a1-4664-4953-8b53-2c277eea79b0","name":"createCompanyAccountingBankingAccountReconciliation — Start a reconciliation","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/banking/accounts/:id/reconciliations","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","banking","accounts",":id","reconciliations"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Start a reconciliation\n\nBeginning balance = the sum of reconciled lines; lines already cleared on or before the statement date are pre-ticked. One session in progress per account; the date must follow the last finished one. Needs bank_reconcile. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"reconciliation\": {\n    \"statement_date\": \"2026-01-31\",\n    \"statement_ending_balance\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"3bbd6a35-c556-478f-8045-94f3f1516a6f","name":"listCompanyAccountingBankingAccountRegister — Account register","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/banking/accounts/:id/register","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","banking","accounts",":id","register"],"query":[{"key":"from","value":"","disabled":true,"description":"From date"},{"key":"to","value":"","disabled":true,"description":"To date"},{"key":"page","value":"1","disabled":true,"description":"Page (1-based)"},{"key":"per_page","value":"100","disabled":true,"description":"Items per page"}],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Account register\n\nPosted lines on the account's GL account, newest first, with a running balance and the reconcile state (n new, c cleared, y reconciled and locked, v void). Paginated. Requires the accounting:read scope."}},{"id":"fb5a96e5-0b39-4e0c-8a6f-82041ec5fe74","name":"revealCompanyAccountingBankingAccount — Reveal bank numbers","request":{"method":"POST","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/banking/accounts/:id/reveal","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","banking","accounts",":id","reveal"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Reveal bank numbers\n\nFull account and routing numbers. manage_vendor_banking only; writes a pii_revealed audit event. Not cached. Requires the accounting:write scope."}},{"id":"bf5a74a1-b1ad-40bf-8354-ab41957f0290","name":"listCompanyAccountingBankingAccountStatementImports — List statement imports","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/banking/accounts/:id/statement_imports","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","banking","accounts",":id","statement_imports"],"query":[{"key":"page","value":"1","disabled":true,"description":"Page (1-based)"},{"key":"per_page","value":"100","disabled":true,"description":"Items per page"}],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"List statement imports\n\nStatement files imported into this account, newest first. Paginated (default 100 per page). Requires the accounting:read scope."}},{"id":"7546e6ff-0a79-4c80-8e6f-05bed95c3a02","name":"createCompanyAccountingBankingAccountStatementImport — Import a statement","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/banking/accounts/:id/statement_imports","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","banking","accounts",":id","statement_imports"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Import a statement\n\nParses CSV (with a column mapping), OFX/QFX, BAI2 or camt.053 through the shared statement parsers. The same file can't be imported twice (409); lines already imported (bank id, else a line hash) are skipped and counted. Needs bank_reconcile. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"statement_import\": {\n    \"content\": \"\",\n    \"format\": \"csv\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"eb5ab510-b3c7-4612-8ed1-95f5695a2357","name":"listCompanyAccountingBankingCashForecast — Cash forecast","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/banking/cash_forecast","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","banking","cash_forecast"],"query":[{"key":"as_of","value":"","disabled":true,"description":"Default today"},{"key":"weeks","value":"","disabled":true,"description":"1–52, default 13"},{"key":"trend","value":"","disabled":true,"description":"Include run rate"},{"key":"open_items","value":"","disabled":true,"description":"Include open AP bills (due date), draft payment runs (pay date), open AR (due date plus ar_lag_days) and payroll (unposted runs and each pay group's next regular runs); default true"},{"key":"ar_lag_days","value":"","disabled":true,"description":"Days after the due date AR is expected to collect; default 0"}],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Cash forecast\n\nWeekly projection of the cash (non-card) accounts: opening book balance plus postdated cash lines, recurring journals touching cash, and (unless trend=false) the trailing 13-week run rate excluding transfers. Each flow names its source. Requires the accounting:read scope. Entity-wide: a project-scoped (project_manager_view) grant gets 403."}},{"id":"b4b55950-3e4b-4839-8ff1-fd6a4bc71a22","name":"listCompanyAccountingBankingCashPosition — Cash position","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/banking/cash_position","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","banking","cash_position"],"query":[{"key":"as_of","value":"","disabled":true,"description":"Default today"}],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Cash position\n\nPer account: book, reconciled and cleared balances, outstanding items, last reconciliation and statement, lines to match; totals for cash and cards owed. Requires the accounting:read scope. Entity-wide: a project-scoped (project_manager_view) grant gets 403."}},{"id":"f3f47298-f86b-42d1-84d2-9938c71acfcf","name":"stopCompanyAccountingBankingCheck — Stop payment on a check","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/banking/checks/:id/stop","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","banking","checks",":id","stop"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Stop payment on a check\n\nMarks an issued check in the register (banking, AP or payroll) as stopped; the next positive pay file sends it to the bank with the stop status. The books do not change: void or reissue the check to move the money. release_payments; audited. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"stop\": {\n    \"reason\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"dc0c8a0e-10c5-4db3-80f4-f1c2b6959a64","name":"listCompanyAccountingBankingFeeds — List live bank feed connections","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/banking/feeds","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","banking","feeds"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"List live bank feed connections\n\nConnections in the grant's entity scope (a connection without an entity is visible to all-entity grants only). `enabled` is false when feeds are not configured on this server. Entity-wide: a project-scoped grant gets 403. Requires the accounting:read scope."}},{"id":"d2657ef7-8c26-4ca6-859a-a34f403897f3","name":"createCompanyAccountingBankingFeed — Link a bank (exchange a Link public token)","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/banking/feeds","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","banking","feeds"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Link a bank (exchange a Link public token)\n\nExchanges the provider Link public token and stores the connection; the access token is encrypted, bound to the row and never returned. Needs manage_integrations and bank_reconcile. Audited. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"entity_id\": 0,\n  \"institution_name\": \"\",\n  \"public_token\": \"\"\n}","options":{"raw":{"language":"json"}}}}},{"id":"5f8eec0b-bce3-4313-8527-20343e5a4300","name":"createCompanyAccountingBankingFeedsLinkToken — Create a bank Link token","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/banking/feeds/link_token","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","banking","feeds","link_token"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Create a bank Link token\n\nA provider Link token for a new connection, or update mode (reconnect after login_required, or add accounts) with `connection_id`. Needs manage_integrations and bank_reconcile. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"connection_id\": 0\n}","options":{"raw":{"language":"json"}}}}},{"id":"2b25f775-82f8-4e4a-8a03-7f1170d0f7ea","name":"getCompanyAccountingBankingFeed — Show a live bank feed connection","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/banking/feeds/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","banking","feeds",":id"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Show a live bank feed connection\n\nEntity-wide: a project-scoped grant gets 403. Requires the accounting:read scope."}},{"id":"6c95149c-58d1-4042-86fb-08daaa9f5c85","name":"deleteCompanyAccountingBankingFeed — Disconnect a live bank feed","request":{"method":"DELETE","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/banking/feeds/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","banking","feeds",":id"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Disconnect a live bank feed\n\nRemoves the Item at the provider (best effort), forgets the token and cursor, sets status disconnected and unmaps its bank accounts. Statement lines stay. Needs manage_integrations and bank_reconcile. Audited. Requires the accounting:write scope."}},{"id":"e4cebedf-a930-4a75-8f5c-065c04fd9cb6","name":"updateCompanyAccountingBankingFeedAccounts — Map feed accounts to bank accounts","request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/banking/feeds/:id/accounts","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","banking","feeds",":id","accounts"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Map feed accounts to bank accounts\n\nMap, remap or unmap (bank_account_id null) each provider account. start_date is the first day the feed owns (default: the day after the account's latest statement line, else 30 days ago); it may not be on or before the last finished reconciliation (409). A bank account fed by another connection is refused (409); one outside the connection's entity is 404. Mapping queues a sync. Needs manage_integrations and bank_reconcile. Audited. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"mappings\": [\n    {\n      \"bank_account_id\": 0,\n      \"feed_account_id\": \"\"\n    }\n  ]\n}","options":{"raw":{"language":"json"}}}}},{"id":"c4cdbb64-38da-4073-8d79-543e196dafed","name":"syncCompanyAccountingBankingFeed — Sync a live bank feed now","request":{"method":"POST","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/banking/feeds/:id/sync","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","banking","feeds",":id","sync"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Sync a live bank feed now\n\nQueues a sync job (one per connection per minute; never syncs inline). New posted transactions become statement lines in the matching inbox; pending ones are skipped. Needs bank_reconcile. Requires the accounting:write scope."}},{"id":"891e93be-5919-4926-8612-3fbb02c9f645","name":"listCompanyAccountingBankingReceiptReviews — List pending independent card receipt reviews","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/banking/receipt_reviews","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","banking","receipt_reviews"],"query":[{"key":"after","value":"","disabled":true,"description":"Exclusive submission ID cursor from next_after."},{"key":"per_page","value":"100","disabled":true}],"variable":[{"key":"company_id","value":"{{companyId}}"}]},"description":"List pending independent card receipt reviews\n\nRequires accounting:read and live bankReconcile. Excludes project-scoped grants and inaccessible, shared or mixed-entity accounts according to the existing bank artifact policy. Scope and independence precede keyset pagination. Includes stale pending submissions for explicit rejection; never mutates financial state. No total count is exposed."}},{"id":"bdac1783-a739-42f9-8214-5e9736700ae9","name":"getCompanyAccountingBankingReconciliation — Show a reconciliation","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/banking/reconciliations/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","banking","reconciliations",":id"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Show a reconciliation\n\nThe session with its lines (in progress: every candidate with a cleared flag; finished: the locked items) and totals with an explain trace. Requires the accounting:read scope."}},{"id":"b9c708fc-47b6-4d5a-87c0-c1dc4df9b0c9","name":"updateCompanyAccountingBankingReconciliation — Tick lines / change the statement balance","request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/banking/reconciliations/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","banking","reconciliations",":id"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Tick lines / change the statement balance\n\nclear / unclear journal line ids (n ↔ c) and the statement ending balance, while in progress. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"reconciliation\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"2dd64238-4a47-47a2-8a0b-c23efc01f90f","name":"deleteCompanyAccountingBankingReconciliation — Cancel an in-progress reconciliation","request":{"method":"DELETE","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/banking/reconciliations/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","banking","reconciliations",":id"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Cancel an in-progress reconciliation\n\nDrops the ticks; matched lines stay cleared. Requires the accounting:write scope. Also the recovery path for a session with invalid ledger links: those links are dropped without changing the lines they point at, and the audit entry lists them."}},{"id":"f35e49dc-21a1-4bca-89e4-2f65b9e9072d","name":"finishCompanyAccountingBankingReconciliation — Finish a reconciliation","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/banking/reconciliations/:id/finish","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","banking","reconciliations",":id","finish"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Finish a reconciliation\n\nOnly at a difference of 0.00, or with adjustment_reason, which posts an adjustment entry (to adjustment_account_id or SUSPENSE). The adjustment is refused (422) above settings.recon_adjustment_limit, or, when that is null, at or above require_approval_above (any difference when both are null): record the difference as a bank transaction, which a second person approves at or above the threshold, clear it, then finish. Every ticked line becomes reconciled (y) and is locked; the database refuses any later change to it outside an undo. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"finish\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"53582c4d-155f-4347-8cea-83851e4ec444","name":"reviewCompanyAccountingBankingReconciliation — Review a finished reconciliation","request":{"method":"POST","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/banking/reconciliations/:id/review","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","banking","reconciliations",":id","review"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Review a finished reconciliation\n\nIndependent sign-off of a finished reconciliation by a user with close_period or approve_journal who did not finish it (403 for the finisher). Sets reviewed_by_id and reviewed_at and is audited. 409 when the session is not finished or is already reviewed. Close readiness blocks (reconciliation_unreviewed) on a finished, unreviewed reconciliation dated in the period. No request body. Requires the accounting:write scope."}},{"id":"4cfc781d-cb6d-4efb-81d7-6d9755d47c85","name":"undoCompanyAccountingBankingReconciliation — Undo a reconciliation","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/banking/reconciliations/:id/undo","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","banking","reconciliations",":id","undo"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Undo a reconciliation\n\nController only (close_period), latest finished session only. Reconciled lines go back to cleared. Audited. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"undo\": {\n    \"reason\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"f1dc6c4a-eb37-40b1-8d71-a073894fbb50","name":"listCompanyAccountingBankingRules — List bank rules","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/banking/rules","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","banking","rules"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"List bank rules\n\nRules in priority order. Requires the accounting:read scope."}},{"id":"d24b67c1-34a4-4881-8045-31d3efcca137","name":"createCompanyAccountingBankingRule — Create a bank rule","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/banking/rules","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","banking","rules"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Create a bank rule\n\nText match (case-insensitive) plus direction and amount band, coding to a postable non-control account. Needs bank_reconcile. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"bank_rule\": {\n    \"account_id\": 0,\n    \"description_contains\": \"\",\n    \"name\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"37970c0a-0bb0-4102-8473-38f09d13be54","name":"updateCompanyAccountingBankingRule — Update a bank rule","request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/banking/rules/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","banking","rules",":id"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Update a bank rule\n\nAny rule field. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"bank_rule\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"6683309a-8fbe-481d-8ec1-ca97fc0ea70b","name":"deleteCompanyAccountingBankingRule — Delete a bank rule","request":{"method":"DELETE","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/banking/rules/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","banking","rules",":id"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Delete a bank rule\n\nLines it matched keep their match. Requires the accounting:write scope."}},{"id":"022238b9-c20a-4c02-8cef-7c7184292b8b","name":"createTransactionCompanyAccountingBankingStatementLine — Create from a statement line","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/banking/statement_lines/:id/create_transaction","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","banking","statement_lines",":id","create_transaction"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Create from a statement line\n\nRecords the document the bank line represents (deposit/withdrawal, or card charge/credit), posts it, matches it, and optionally saves a bank rule from the coding. At or above the journal approval threshold the document is held as pending_approval and the line stays unmatched until a second person approves it (approval matches it); creating again from that line is refused with 409. A single line defaults to the full amount. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"create\": {\n    \"lines\": [\n      {\n        \"account_id\": 0\n      }\n    ]\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"66ce985b-fffd-484b-8a83-42b3587d84f1","name":"createCompanyAccountingBankingStatementLineFeedNoteClear — Mark a bank feed note reviewed","request":{"method":"POST","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/banking/statement_lines/:id/feed_note/clear","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","banking","statement_lines",":id","feed_note","clear"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Mark a bank feed note reviewed\n\nClears the note the live feed left on a matched line it changed or removed. Needs bank_reconcile. Audited. Requires the accounting:write scope."}},{"id":"bb07b5e2-a3cb-4174-807a-1d7678c4b748","name":"ignoreCompanyAccountingBankingStatementLine — Ignore a statement line","request":{"method":"POST","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/banking/statement_lines/:id/ignore","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","banking","statement_lines",":id","ignore"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Ignore a statement line\n\nMoves an unmatched line out of the inbox. Requires the accounting:write scope."}},{"id":"19b7c101-f40d-4dfe-8397-f83a7481b2bd","name":"matchCompanyAccountingBankingStatementLine — Match a statement line","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/banking/statement_lines/:id/match","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","banking","statement_lines",":id","match"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Match a statement line\n\nMatches one or more book lines (posted, on the account, not reconciled or void, not matched elsewhere) whose total equals the bank amount to the cent. Book lines become cleared. Needs bank_reconcile. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"match\": {\n    \"journal_line_ids\": [\n      0\n    ]\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"4ee88228-b417-4349-83a8-7c2371980200","name":"restoreCompanyAccountingBankingStatementLine — Restore an ignored statement line","request":{"method":"POST","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/banking/statement_lines/:id/restore","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","banking","statement_lines",":id","restore"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Restore an ignored statement line\n\nPuts the line back in the inbox. Requires the accounting:write scope."}},{"id":"b428bc23-8f4a-4392-85c0-101e2ad26b59","name":"unmatchCompanyAccountingBankingStatementLine — Unmatch a statement line","request":{"method":"POST","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/banking/statement_lines/:id/unmatch","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","banking","statement_lines",":id","unmatch"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Unmatch a statement line\n\nRefused with 409 when a matched book line is reconciled (the lock). Requires the accounting:write scope."}},{"id":"5107baef-0b12-4044-8bb7-e75642b1a34f","name":"listCompanyAccountingBankingTransactions — List cash documents","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/banking/transactions","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","banking","transactions"],"query":[{"key":"from","value":"","disabled":true,"description":"From date"},{"key":"to","value":"","disabled":true,"description":"To date"},{"key":"search","value":"","disabled":true,"description":"Search"},{"key":"page","value":"1","disabled":true,"description":"Page (1-based)"},{"key":"per_page","value":"100","disabled":true,"description":"Items per page"},{"key":"updated_since","value":"","disabled":true,"description":"Delta sync: only rows created or changed at or after this time (ISO 8601 with offset). Switches the list to ascending (updated_at, id) order; page is ignored and Next-Cursor continues it. Re-read with a small overlap (a few seconds) and dedupe by id."},{"key":"cursor","value":"","disabled":true,"description":"Opaque keyset cursor from a previous response's Next-Cursor header; each page costs the same however deep it is."}],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"List cash documents\n\nDeposits, checks, withdrawals, transfers and card charges/credits. Filters: filters[bank_account_id], filters[kind], filters[status]; from/to; search (number, payee, memo, check #). Paginated. Delta sync: updated_since and/or cursor return changes in ascending (updated_at, id) order with Next-Cursor. Requires the accounting:read scope. Entity-wide: a project-scoped (project_manager_view) grant gets 403."}},{"id":"f3f7d130-b633-4a21-8220-17254a9c2779","name":"createCompanyAccountingBankingTransaction — Record and post a cash document","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/banking/transactions","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","banking","transactions"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Record and post a cash document\n\nPosts one CM journal entry (idempotent on the document id), or holds the document as pending_approval with no posting until a second person approves it (POST .../approve): checks always (release by a different release_payments user), deposits, withdrawals and card documents at or above the journal approval threshold. Transfers between the company's own accounts follow the transfer policy (settings transfer_approval_cross_entity, default true, and transfer_approval_above, null = require_approval_above when set): a transfer between entities or at or above the amount is held for release by a different release_payments user; others post at once. Checks take the account's next check number unless one is given, need a payee, and need release_payments; the others need bank_reconcile. Coding lines must total the amount and can't use control accounts or other bank registers. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"bank_transaction\": {\n    \"amount\": \"\",\n    \"bank_account_id\": 0,\n    \"date\": \"2026-01-31\",\n    \"kind\": \"deposit\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"b2991cf0-f503-4c36-8a72-738427e0012d","name":"getCompanyAccountingBankingTransaction — Show a cash document","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/banking/transactions/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","banking","transactions",":id"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Show a cash document\n\nOne document with its coding lines; card charges flag receipt_missing above the account's threshold. Requires the accounting:read scope."}},{"id":"72a6699b-8bb8-4e1f-8a43-3de1240dd72c","name":"approveCompanyAccountingBankingTransaction — Release or approve a pending cash document","request":{"method":"POST","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/banking/transactions/:id/approve","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","banking","transactions",":id","approve"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Release or approve a pending cash document\n\nPosts a cash document that is waiting for a second person (status pending_approval): a check or transfer needs release_payments, any other kind approve_journal. Refused with 403 for the user who created it (segregation of duties) and 409 when it is not pending. Checks are always held for release; deposits, withdrawals and card documents are held at or above the journal approval threshold (settings.require_approval_above; null holds every one). Approval registers the check for positive pay and matches the statement line it was created from. Requires the accounting:write scope."}},{"id":"ad6964a9-8ab6-4e44-8ab9-67602ab7920a","name":"listCompanyAccountingBankingTransactionAttachments — List attachments on a bank transaction","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/banking/transactions/:id/attachments","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","banking","transactions",":id","attachments"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"List attachments on a bank transaction\n\nOldest first. Needs view_ledger and the parent's entity scope. Requires the accounting:read scope."}},{"id":"81ef5c6b-9faf-43b1-8b35-9d4739cf8786","name":"createCompanyAccountingBankingTransactionAttachment — Attach a file to a bank transaction","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/banking/transactions/:id/attachments","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","banking","transactions",":id","attachments"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Attach a file to a bank transaction\n\nMultipart upload (one `file` part, allow-listed type, up to MAX_UPLOAD_BYTES). Allowed after posting: attachments are not ledger data. Writes an attachment_added audit event on the parent in the same transaction. Needs bank_reconcile and the parent's entity scope. Requires the accounting:write scope.","body":{"mode":"formdata","formdata":[{"key":"file","type":"file","src":[]}]}}},{"id":"3b6c0e2a-e634-4717-821b-6bd2620bb6b3","name":"checkPrintCompanyAccountingBankingTransaction — Check print data","request":{"method":"POST","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/banking/transactions/:id/check_print","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","banking","transactions",":id","check_print"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Check print data\n\nMICR line, amount in words and stub for a check. Decrypts the bank numbers: release_payments only, audited, not cached. Requires the accounting:write scope."}},{"id":"cee82255-1585-4def-87e7-6670a8bc2527","name":"listCompanyAccountingBankingTransactionReceiptEvidence — Read retained receipt evidence under bank-account scope","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/banking/transactions/:id/receipt_evidence","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","banking","transactions",":id","receipt_evidence"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Read retained receipt evidence under bank-account scope\n\nRead only. Requires accounting:read token scope and view access to the card account. Lists the card charge lines with their latest submission status and full submission history; never mutates financial state."}},{"id":"af15cd74-6388-4376-8ccb-bab2cfbd2aa3","name":"receiptEvidenceCompanyAccountingBankingTransaction — Submit line evidence for independent review","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/banking/transactions/:id/receipt_evidence","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","banking","transactions",":id","receipt_evidence"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Submit line evidence for independent review\n\nRequires accounting:write token scope and bankReconcile on the card account. Attaches an uploaded receipt (or an exception reason) to one card charge line for independent review. request_key in the body makes retries safe: the same key and evidence returns the first submission, a different payload under the same key is refused (409). Creates no posting and does not change approval, void or reconciliation state.","body":{"mode":"raw","raw":"{\n  \"attachment_id\": 0,\n  \"exception_reason\": \"\",\n  \"line_id\": 0,\n  \"request_key\": \"\"\n}","options":{"raw":{"language":"json"}}}}},{"id":"b8f50d6b-1eb5-412f-8f6e-70e152d40449","name":"createCompanyAccountingBankingTransactionReceiptEvidenceReview — Record immutable independent review; exact reviewer/outcome/reason retries replay","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/banking/transactions/:id/receipt_evidence/review","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","banking","transactions",":id","receipt_evidence","review"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Record immutable independent review; exact reviewer/outcome/reason retries replay\n\nRequires accounting:write token scope and bankReconcile on the card account. The reviewer must be independent of the charge creator, the submitter and the uploader. Decisions are immutable: an exact retry returns the recorded decision, anything else is refused (409). Creates no posting.","body":{"mode":"raw","raw":"{\n  \"outcome\": \"verified\",\n  \"reason\": \"\",\n  \"submission_id\": 0\n}","options":{"raw":{"language":"json"}}}}},{"id":"c49a1773-75a3-4035-82a0-730f0e622890","name":"voidCompanyAccountingBankingTransaction — Void a cash document","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/banking/transactions/:id/void","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","banking","transactions",":id","void"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Void a cash document\n\nPosts the reversing entry on the void date (an open period; a check from a closed month voids in the current one) and flags both bank lines void. Refused with 409 when the bank line is reconciled (the lock) or matched to a statement line. Requires the accounting:write scope. A pending_approval document is voided without any posting (withdrawn or rejected).","body":{"mode":"raw","raw":"{\n  \"void\": {\n    \"date\": \"2026-01-31\",\n    \"reason\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"7a15c7b2-3388-4b17-898f-01ad5fd253d9","name":"listCompanyAccountingBudgets — List GL budgets","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/budgets","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","budgets"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"List GL budgets\n\nEvery budget version, newest fiscal year first. Requires the accounting:read scope. Entity-wide: a project-scoped (project_manager_view) grant gets 403."}},{"id":"201b5c74-d436-4532-8560-66fc18475bb0","name":"createCompanyAccountingBudget — Import a GL budget from CSV","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/budgets","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","budgets"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Import a GL budget from CSV\n\nCSV with a header row `account,period,amount` and optional `entity` (entity code) and `department` (department name, case-insensitive; the company departments journal lines carry). Accounts are postable income-statement accounts by number; period is YYYY-MM inside the fiscal year when it exists; amounts have at most two decimals and are positive for revenue and expense alike. Every bad row is reported at once (422). Importing the same fiscal year and name again creates the next version. Compare on the income statement with `compare=budget&budget_id=`. Needs close_period and unrestricted entity access; audited. Honors Idempotency-Key. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"budget\": {\n    \"csv\": \"\",\n    \"fiscal_year\": 0,\n    \"name\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"398d539e-96c2-462f-88c9-2c202336990a","name":"listCompanyAccountingBudgetsVariance — Budget vs actual","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/budgets/variance","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","budgets","variance"],"query":[{"key":"budget_id","value":"","disabled":true},{"key":"fiscal_year","value":"","disabled":true},{"key":"from","value":"","disabled":true},{"key":"to","value":"","disabled":true},{"key":"entity_id","value":"","disabled":true},{"key":"project_id","value":"","disabled":true},{"key":"scenario_id","value":"","disabled":true}],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Budget vs actual\n\nBudget vs actual by account over whole months of one version: the approved (or locked) version of the fiscal year by default (latest approval), or budget_id. Income-statement rows compare the months' posted activity (closing entries left out) with the budget months; balance-sheet rows compare the posted balance at the last month's end with that month's budget balance. variance = actual − budget; variance_pct = variance ÷ |budget| × 100; favorable for revenue above budget and cost or expense below it. scenario_id compares against the scenario overlay of the version. An entity-scoped grant sees its entities only. Requires the accounting:read scope. Entity-wide: a project-scoped (project_manager_view) grant gets 403."}},{"id":"cc4a1e91-0dd6-414b-89ac-ca12550725e4","name":"createCompanyAccountingBudgetsVersion — Create a budget version","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/budgets/versions","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","budgets","versions"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Create a budget version\n\nA new draft version of the fiscal year and name (the next version number): blank, copied from another version (copy_from.kind version, optionally through a scenario overlay: the source version is not changed), or from a fiscal year's posted actuals (copy_from.kind actuals: income-statement activity by month, closing entries left out, or with accounts=all also balance-sheet month-end balances; factor_pct uplifts every amount). Month k of the source year lands on month k of the new year. Needs close_period and unrestricted entity access; audited. Honors Idempotency-Key. Requires the accounting:write scope. Entity-wide: a project-scoped (project_manager_view) grant gets 403.","body":{"mode":"raw","raw":"{\n  \"budget\": {\n    \"fiscal_year\": 0,\n    \"name\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"53e20378-2166-4151-85f2-e411b1ee317f","name":"getCompanyAccountingBudget — Show a GL budget with its lines","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/budgets/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","budgets",":id"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Show a GL budget with its lines\n\nRequires the accounting:read scope. Entity-wide: a project-scoped (project_manager_view) grant gets 403."}},{"id":"77e706bc-7a6e-499a-8a16-557bc9f63f21","name":"deleteCompanyAccountingBudget — Delete a GL budget version","request":{"method":"DELETE","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/budgets/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","budgets",":id"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Delete a GL budget version\n\nNeeds close_period and unrestricted entity access; audited. Requires the accounting:write scope."}},{"id":"51edef77-0e3a-46f4-88c3-71e172822970","name":"approveCompanyAccountingBudget — Approve a budget version","request":{"method":"POST","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/budgets/:id/approve","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","budgets",":id","approve"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Approve a budget version\n\nApprove a submitted version. Maker-checker: a user who created, edited or submitted the version is refused (403), also by a database trigger. The approved version is the default for budget vs actual and the income statement comparison. Needs approve_journal and unrestricted entity access; audited. Requires the accounting:write scope. Entity-wide: a project-scoped (project_manager_view) grant gets 403."}},{"id":"f0293f0b-8ce7-479b-83e3-c8a3744ef796","name":"replaceCompanyAccountingBudgetCells — Set budget cells","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/budgets/:id/cells","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","budgets",":id","cells"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Set budget cells\n\nSet cells of a draft version: each replaces every line on the same account, dimensions and month; amount 0 removes the cell. Accounts are postable accounts of any type (balance-sheet cells are month-end balances), periods are months of the version's fiscal year, a cost code needs its project. A submitted, approved or locked version is refused (409 budget_immutable). Needs close_period and unrestricted entity access; the editor joins the version's makers; audited. Requires the accounting:write scope. Entity-wide: a project-scoped (project_manager_view) grant gets 403.","body":{"mode":"raw","raw":"{\n  \"cells\": [\n    {\n      \"account_id\": 0,\n      \"amount\": \"\",\n      \"period\": \"\"\n    }\n  ]\n}","options":{"raw":{"language":"json"}}}}},{"id":"fd720e7d-8d07-447f-8c08-9ac44a092277","name":"listCompanyAccountingBudgetGrid — Budget grid","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/budgets/:id/grid","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","budgets",":id","grid"],"query":[{"key":"account_id","value":"","disabled":true},{"key":"project_id","value":"","disabled":true},{"key":"entity_id","value":"","disabled":true}],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Budget grid\n\nThe version as rows (account plus entity, department, project and cost code) by fiscal month, with the net income budget per month. editable is true only for a draft. Filters: account_id, project_id, entity_id. An entity-scoped grant sees its entities' lines. Requires the accounting:read scope. Entity-wide: a project-scoped (project_manager_view) grant gets 403."}},{"id":"fa9027e1-7310-415b-8084-7f96297ef708","name":"lockCompanyAccountingBudget — Lock a budget version","request":{"method":"POST","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/budgets/:id/lock","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","budgets",":id","lock"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Lock a budget version\n\nLock an approved version: it can never change or be deleted (a trigger refuses any write). Needs close_period and unrestricted entity access; audited. Requires the accounting:write scope. Entity-wide: a project-scoped (project_manager_view) grant gets 403."}},{"id":"86d51558-6a26-4bfd-8400-a7c3ed91fc40","name":"returnCompanyAccountingBudget — Return a budget version","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/budgets/:id/return","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","budgets",":id","return"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Return a budget version\n\nSend a submitted version back to draft with a reason. Needs approve_journal and unrestricted entity access; audited. Requires the accounting:write scope. Entity-wide: a project-scoped (project_manager_view) grant gets 403.","body":{"mode":"raw","raw":"{\n  \"reason\": \"\"\n}","options":{"raw":{"language":"json"}}}}},{"id":"1d1a3786-4531-4bd3-834d-ec3170306c1d","name":"spreadCompanyAccountingBudget — Spread a budget line","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/budgets/:id/spread","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","budgets",":id","spread"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Spread a budget line\n\nSpread annual_amount over the fiscal year's months on one line of a draft: even, prior_year (the prior fiscal year's posted monthly activity on the same account and dimensions as weights; a negative month weighs zero; no activity is 422) or custom (twelve percents summing to 100). Each month takes the amount × weight ÷ Σ weights truncated to cents and the leftover cents go to the largest remainders, earlier months first, so the months add back exactly. Needs close_period; audited. Requires the accounting:write scope. Entity-wide: a project-scoped (project_manager_view) grant gets 403.","body":{"mode":"raw","raw":"{\n  \"spread\": {\n    \"account_id\": 0,\n    \"annual_amount\": \"\",\n    \"method\": \"even\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"99ed76ba-9f39-4a49-85a5-8487b5bc8276","name":"submitCompanyAccountingBudget — Submit a budget version","request":{"method":"POST","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/budgets/:id/submit","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","budgets",":id","submit"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Submit a budget version\n\nSubmit a draft with lines for approval; the submitter joins the makers. Needs close_period and unrestricted entity access; audited. Requires the accounting:write scope. Entity-wide: a project-scoped (project_manager_view) grant gets 403."}},{"id":"1ef73645-d780-43d2-897c-fb31a9943f57","name":"createCompanyAccountingCeclAllowance — Post the CECL allowance adjustment","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/cecl_allowance","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","cecl_allowance"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Post the CECL allowance adjustment\n\nComputes expected credit losses (ASC 326-20) from settings.cecl_policy loss rates on aged AR, disputed AR, retainage receivable and contract assets for one entity, and posts the difference to the allowance (ALLOWANCE_DOUBTFUL) against credit loss expense (BAD_DEBT_EXPENSE). Idempotent per entity and date; 422 when no policy or role account is set. Needs post_journal. Requires accounting:write.","body":{"mode":"raw","raw":"{\n  \"as_of\": \"2026-01-31\",\n  \"entity_id\": 0\n}","options":{"raw":{"language":"json"}}}}},{"id":"c362f79c-3928-4132-8bf2-6f4f7f8e62ca","name":"listCompanyAccountingCloseAlertTests — Alert delivery tests","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/close/alert_tests","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","close","alert_tests"],"query":[{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true}],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Alert delivery tests\n\nAlert delivery evidence, newest first: each requested test alert with one attempt per channel and recipient (email through the finance alert recipient path and the configured transport; a signed webhook test delivery per active subscription receiving accounting events, with its live outcome). Needs close_period; refused to project-scoped grants. Requires the accounting:read scope. See docs/accounting/INTERFACE-FAILURE-VERIFICATION.md."}},{"id":"8527f361-a1ab-4947-812e-f919285231af","name":"createCompanyAccountingCloseAlertTest — Send a test alert","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/close/alert_tests","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","close","alert_tests"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Send a test alert\n\nQueues a test alert (job accounting_alert_test) to the finance alert recipients, by the same recipient resolution and email transport real finance alerts use, and, when the requester is a company administrator, a signed webhook.test delivery to each active subscription receiving accounting events. Idempotent on request_key: a repeat returns the existing test. Nobody is mailed twice by one test, even when its job is retried. Needs close_period; refused to project-scoped grants. Audited. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"request_key\": \"\"\n}","options":{"raw":{"language":"json"}}}}},{"id":"91dd3336-5298-4638-84c3-df9c18d8906c","name":"listCompanyAccountingCloseCockpit — Close cockpit","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/close/cockpit","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","close","cockpit"],"query":[{"key":"period_id","value":"","disabled":false,"description":"The period"},{"key":"entity_id","value":"","disabled":true,"description":"Entity scope (omit for all entities)"}],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Close cockpit\n\nProgress by status and category, the critical path (longest chain of unfinished dependent tasks), overdue tasks, who is blocking whom, the reconciliation summary and what the period close would refuse now. entity_id omitted: the all-entities task list. Needs view_ledger; refused to project-scoped grants. Requires the accounting:read scope."}},{"id":"c267c97f-4f10-4c4b-82fd-3b74dc11b42c","name":"createCompanyAccountingCloseCockpitGenerate — Generate close tasks","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/close/cockpit/generate","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","close","cockpit","generate"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Generate close tasks\n\nCreates the scope's tasks for the period from a template (default: the settings' default); keys already present are kept. Needs close_period (all entities: unrestricted entity access). Audited. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"generate\": {\n    \"period_id\": 0\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"f9b9f697-1d4b-4ea9-8313-f4b810ad104c","name":"createCompanyAccountingCloseCockpitSync — Refresh close evidence","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/close/cockpit/sync","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","close","cockpit","sync"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Refresh close evidence\n\nRe-evaluates every evidence task of the scope (subledger tie-outs, module close readiness, depreciation, allocation, WIP and elimination runs, reconciliations): passing evidence completes the task (reviewed, auto-completed); a completed task whose evidence fails goes stale (not started, with the reason). Then auto-reconciles the scope's reconciliations. Needs close_period. Audited per change. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"sync\": {\n    \"period_id\": 0\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"0895addd-f2d7-42a6-891e-db5e3bff183d","name":"listCompanyAccountingCloseFlux — Flux analysis of a period","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/close/flux","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","close","flux"],"query":[{"key":"period_id","value":"","disabled":false},{"key":"entity_id","value":"","disabled":true}],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Flux analysis of a period\n\nRows of one period for one entity (entity_id) or every entity the grant reaches, with the three comparisons, the threshold that applied, whether an explanation is required and the explanation state (none, explained, reviewed or stale). Needs view_ledger; refused to project-scoped grants. Requires the accounting:read scope."}},{"id":"a550e169-b9fc-4cba-8fb8-05421214fa55","name":"createCompanyAccountingCloseFluxExplanation — Explain a flux row","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/close/flux/explanations","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","close","flux","explanations"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Explain a flux row\n\nWrite or rewrite the explanation of one row (period, entity, account and, for a split account, dimension value). Needs post_journal and the entity in scope; the caller becomes the preparer. One explanation per row (natural key), so a repeat updates it; rewriting a reviewed explanation makes the review stale. The same text over moved figures confirms them for a fresh review. Audited. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"flux_explanation\": {\n    \"account_id\": 0,\n    \"entity_id\": 0,\n    \"explanation\": \"\",\n    \"period_id\": 0\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"9418b813-4624-4b04-8d54-8392f3620437","name":"getCompanyAccountingCloseFluxExplanation — Show a flux explanation","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/close/flux/explanations/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","close","flux","explanations",":id"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Show a flux explanation\n\nThe explanation with its live row (figures, comparisons, status and stale reason). Needs view_ledger and the entity in scope. Requires the accounting:read scope."}},{"id":"dee5cf50-2bcd-4b48-8c65-f184bc5a09cc","name":"reviewCompanyAccountingCloseFluxExplanation — Review a flux explanation","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/close/flux/explanations/:id/review","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","close","flux","explanations",":id","review"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Review a flux explanation\n\nSign as reviewer: needs close_period and the entity in scope; the preparer is refused (403). Refused (409) when the figures or balance moved since the explanation was written (the preparer confirms it first) or when the review is already current. The reviewer signs a hash of the explanation, the figures and the cumulative posted debit and credit. Audited. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"review\": {\n    \"note\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"6bf39fa3-26e5-4331-8f4f-98846f544ec1","name":"listCompanyAccountingCloseFluxSettings — Flux settings","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/close/flux/settings","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","close","flux","settings"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Flux settings\n\nDefault thresholds, threshold mode, materiality floor and which comparisons apply. Needs view_ledger; refused to project-scoped grants. Requires the accounting:read scope."}},{"id":"80db7d53-030f-4091-8656-c07d4a7f29a5","name":"replaceCompanyAccountingCloseFluxSettings — Save flux settings","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/close/flux/settings","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","close","flux","settings"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Save flux settings\n\nOwner or controller with close_period and unrestricted entity access. threshold_mode both: a variance needs an explanation when it reaches the amount AND the percent threshold; either: one of them. A variance below materiality_floor never does. Audited. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"flux_settings\": {\n    \"compare_budget\": false,\n    \"compare_prior_period\": false,\n    \"compare_prior_year\": false,\n    \"default_amount\": \"\",\n    \"default_percent\": \"\",\n    \"materiality_floor\": \"\",\n    \"threshold_mode\": \"both\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"712316c4-d75f-4638-8cfa-faff08874e4a","name":"listCompanyAccountingCloseFluxThresholds — List flux thresholds","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/close/flux/thresholds","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","close","flux","thresholds"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"List flux thresholds\n\nThreshold overrides per account type or account. An account's own threshold wins over its type's; with neither, the settings' defaults apply. Needs view_ledger; refused to project-scoped grants. Requires the accounting:read scope."}},{"id":"94485c30-2600-4b3d-832e-7e08542a6709","name":"createCompanyAccountingCloseFluxThreshold — Create a flux threshold","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/close/flux/thresholds","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","close","flux","thresholds"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Create a flux threshold\n\nFor exactly one of account_type or account_id. Owner or controller with close_period and unrestricted entity access; a second threshold for the same type or account is 409. Audited. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"flux_threshold\": {\n    \"amount\": \"\",\n    \"percent\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"3dfd4a52-4466-4a76-84e7-a87829b9a8eb","name":"updateCompanyAccountingCloseFluxThreshold — Update a flux threshold","request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/close/flux/thresholds/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","close","flux","thresholds",":id"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Update a flux threshold\n\nChange the amount, percent or active flag. Owner or controller with close_period and unrestricted entity access. Audited. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"flux_threshold\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"6e3c6e1d-8b64-4e97-801a-a3d5c0362341","name":"listCompanyAccountingCloseRecRules — List reconciliation rules","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/close/rec_rules","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","close","rec_rules"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"List reconciliation rules\n\nNeeds view_ledger; refused to project-scoped grants. Requires the accounting:read scope."}},{"id":"73575894-a7c9-4269-8943-1be28f259388","name":"createCompanyAccountingCloseRecRule — Create a reconciliation rule","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/close/rec_rules","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","close","rec_rules"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Create a reconciliation rule\n\nWhich balance sheet accounts need a reconciliation (by account type or list, optionally per entity), the supporting source (auto picks the subledger tie-out by account type: AP, AR, retainage, payroll liabilities, fixed assets, WIP, bank; else manual schedule lines) and the materiality (absolute and percent of the GL balance) and risk that set the review level (high risk, or medium and material: two reviewers) and frequency (low risk and immaterial: quarterly). Owner or controller with close_period. Audited. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"rec_rule\": {\n    \"materiality_abs\": \"\",\n    \"materiality_pct\": \"\",\n    \"name\": \"\",\n    \"risk_rating\": \"low\",\n    \"source\": \"auto\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"8fabc7e2-4a32-4b75-8c4f-26b6d0edfc39","name":"updateCompanyAccountingCloseRecRule — Update a reconciliation rule","request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/close/rec_rules/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","close","rec_rules",":id"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Update a reconciliation rule\n\nName, active flag, materiality or risk. Existing reconciliations keep the parameters they were generated with. Owner or controller with close_period. Audited. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"rec_rule\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"8b96ee71-5205-486a-802f-374d2d300f6f","name":"listCompanyAccountingCloseReconciliations — List account reconciliations","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/close/reconciliations","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","close","reconciliations"],"query":[{"key":"period_id","value":"","disabled":false,"description":"The period"},{"key":"entity_id","value":"","disabled":true,"description":"One entity"},{"key":"status","value":"","disabled":true}],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"List account reconciliations\n\nThe period's reconciliations in the grant's entity scope, each with its live GL balance (period balance snapshots), supporting balance (subledger tie-out or schedule lines), open reconciling items, unexplained difference, staleness and item aging. Needs view_ledger; refused to project-scoped grants. Requires the accounting:read scope."}},{"id":"330bd668-7b9b-498b-8b29-fd492799018d","name":"createCompanyAccountingCloseReconciliationsGenerate — Generate account reconciliations","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/close/reconciliations/generate","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","close","reconciliations","generate"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Generate account reconciliations\n\nCreates the period's due reconciliations (rules x accounts x entities with posted activity, due by frequency), carries open reconciling items and schedule lines forward from the latest earlier reconciliation with their original dates, then auto-reconciles those whose tie-out passes with nothing unexplained. Needs close_period. Audited. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"generate\": {\n    \"period_id\": 0\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"ab94f1f8-1078-467c-8335-d840ea949d46","name":"getCompanyAccountingCloseReconciliation — Show an account reconciliation","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/close/reconciliations/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","close","reconciliations",":id"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Show an account reconciliation\n\nNeeds view_ledger and the reconciliation's entity scope. Requires the accounting:read scope."}},{"id":"46b4e326-bf70-4ca2-8806-e393e7f17e7e","name":"listCompanyAccountingCloseReconciliationAttachments — List attachments on an account reconciliation","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/close/reconciliations/:id/attachments","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","close","reconciliations",":id","attachments"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"List attachments on an account reconciliation\n\nOldest first. Needs view_ledger and the reconciliation's entity scope; refused to project-scoped grants. Requires the accounting:read scope."}},{"id":"1342d8d1-ae51-4d40-8986-e3b82f73e5b5","name":"createCompanyAccountingCloseReconciliationAttachment — Attach a workpaper to an account reconciliation","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/close/reconciliations/:id/attachments","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","close","reconciliations",":id","attachments"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Attach a workpaper to an account reconciliation\n\nMultipart upload (one `file` part, allow-listed type, up to MAX_UPLOAD_BYTES): statements, schedules and other support. Writes an attachment_added audit event on the reconciliation. Needs post_journal and the reconciliation's entity scope. Requires the accounting:write scope.","body":{"mode":"formdata","formdata":[{"key":"file","type":"file","src":[]}]}}},{"id":"354a8307-ca74-4960-8fa7-409dc6fad932","name":"createCompanyAccountingCloseReconciliationItem — Add a reconciling item or schedule line","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/close/reconciliations/:id/items","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","close","reconciliations",":id","items"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Add a reconciling item or schedule line\n\nA reconciling item explains GL vs support (signed, in the account's normal-balance direction; carried forward while open); a schedule line is the support of a manual reconciliation. Refused (409) while the reconciliation is signed. Needs post_journal. Audited. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"item\": {\n    \"amount\": \"\",\n    \"description\": \"\",\n    \"item_date\": \"2026-01-31\",\n    \"kind\": \"reconciling_item\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"0510743b-8287-48a2-8ee5-c533b712868e","name":"updateCompanyAccountingCloseReconciliationItem — Update or clear a reconciliation item","request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/close/reconciliations/:id/items/:item_id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","close","reconciliations",":id","items",":item_id"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""},{"key":"item_id","value":""}]},"description":"Update or clear a reconciliation item\n\nEdit the description, amount or reference, or clear (resolve) the item: a cleared item stops explaining the difference and is not carried forward. Refused (409) while signed. Needs post_journal. Audited. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"item\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"f08f7aba-4e39-43d6-8519-87fb89dc35cf","name":"prepareCompanyAccountingCloseReconciliation — Prepare an account reconciliation","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/close/reconciliations/:id/prepare","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","close","reconciliations",":id","prepare"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Prepare an account reconciliation\n\nSign as preparer (post_journal): the unexplained difference must be within the tolerance (the lesser of the absolute materiality and the percentage of the GL balance). Snapshots the cumulative posted debit and credit, support and items. A signed reconciliation that went stale may be prepared again. Audited. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"prepare\": {\n    \"note\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"19d45339-81a2-4824-8a8d-87cf117a3d50","name":"reviewCompanyAccountingCloseReconciliation — Review an account reconciliation","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/close/reconciliations/:id/review","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","close","reconciliations",":id","review"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Review an account reconciliation\n\nSign as reviewer: needs close_period; the preparer is refused (403); a two-level reconciliation needs a second reviewer who is neither the preparer nor the first reviewer. Refused (409) if the GL or support moved since preparation. Audited. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"review\": {\n    \"note\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"beac8639-3f59-4111-8722-bae249ec3d54","name":"unsignCompanyAccountingCloseReconciliation — Unsign an account reconciliation","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/close/reconciliations/:id/unsign","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","close","reconciliations",":id","unsign"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Unsign an account reconciliation\n\nWithdraws every sign-off (back to in_progress) with a reason. Needs close_period. Audited. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"unsign\": {\n    \"reason\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"77b7ee37-e6b8-4a1d-85a8-2bf004e0412f","name":"listCompanyAccountingCloseSettings — Close cockpit settings","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/close/settings","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","close","settings"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Close cockpit settings\n\nWhether the period close requires the cockpit tasks and account reconciliations to be reviewed, and the default template. Needs view_ledger; refused to project-scoped grants. Requires the accounting:read scope."}},{"id":"e16e26b2-9294-486a-8413-13005767d2a6","name":"replaceCompanyAccountingCloseSettings — Save close cockpit settings","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/close/settings","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","close","settings"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Save close cockpit settings\n\nOwner or controller with close_period and unrestricted entity access. With require_tasks the period close (prepare, approve and close) is refused while a required task of the scope is not reviewed; with require_recs a GL or whole-period close is refused while a due reconciliation is missing, not fully reviewed or stale; with require_flux a GL or whole-period close is refused while a flux variance above threshold is unexplained, unreviewed or stale. Audited. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"settings\": {\n    \"require_recs\": false,\n    \"require_tasks\": false\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"92586342-5fa1-4eff-8c5c-bc701f705d81","name":"getCompanyAccountingCloseTask — Show a close task","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/close/tasks/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","close","tasks",":id"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Show a close task\n\nNeeds view_ledger and the task's entity scope. Requires the accounting:read scope."}},{"id":"83e0b556-b33a-4e0f-81b3-477e97048c29","name":"prepareCompanyAccountingCloseTask — Prepare a close task","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/close/tasks/:id/prepare","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","close","tasks",":id","prepare"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Prepare a close task\n\nSign as preparer: needs post_journal, the task's owner or a close_period user, and every dependency reviewed. Evidence tasks complete from evidence only (422). Audited. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"prepare\": {\n    \"note\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"1417d540-0b8e-4c1e-84be-12d5f0fee649","name":"reviewCompanyAccountingCloseTask — Review a close task","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/close/tasks/:id/review","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","close","tasks",":id","review"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Review a close task\n\nSign as reviewer: needs close_period; the preparer is refused (403, segregation of duties); a designated reviewer is required unless the reviewer is an owner or controller. Audited. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"review\": {\n    \"note\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"f4ff23f4-a037-4402-85c2-ed550a28d9c1","name":"startCompanyAccountingCloseTask — Start a close task","request":{"method":"POST","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/close/tasks/:id/start","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","close","tasks",":id","start"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Start a close task\n\nnot_started to in_progress. Needs post_journal; the task's owner or a close_period user. Audited. Requires the accounting:write scope."}},{"id":"12388aee-975e-43e0-80b6-134902443c28","name":"unsignCompanyAccountingCloseTask — Unsign a close task","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/close/tasks/:id/unsign","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","close","tasks",":id","unsign"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Unsign a close task\n\nWithdraws the preparation and review (back to in_progress) with a reason; tasks depending on it lose their sign-off too. Needs close_period. Audited. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"unsign\": {\n    \"reason\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"93273106-1263-476a-8cea-1dbfb4e0ecc2","name":"listCompanyAccountingCloseTemplates — List close templates","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/close/templates","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","close","templates"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"List close templates\n\nEvery close template with its tasks. Needs view_ledger. Requires the accounting:read scope."}},{"id":"870c6796-6191-4e0e-8036-fafb02390b80","name":"createCompanyAccountingCloseTemplate — Create a close template","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/close/templates","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","close","templates"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Create a close template\n\nTasks with owner, reviewer, due day offset (business days after the period end), dependencies (acyclic, by key), a category, the module close the task gates and optional system evidence that completes it. Owner or controller with close_period. Audited. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"revision\": 0,\n  \"template\": {\n    \"name\": \"\",\n    \"tasks\": [\n      {\n        \"category\": \"subledger_close\",\n        \"due_day_offset\": 0,\n        \"key\": \"\",\n        \"title\": \"\"\n      }\n    ]\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"639f4b45-5b07-403e-8c61-f4d70b4192fe","name":"getCompanyAccountingCloseTemplate — Show a close template","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/close/templates/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","close","templates",":id"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Show a close template\n\nNeeds view_ledger. Requires the accounting:read scope."}},{"id":"a72e9adc-f850-476f-88af-8a373ceb6c5f","name":"replaceCompanyAccountingCloseTemplate — Replace a close template","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/close/templates/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","close","templates",":id"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Replace a close template\n\nReplaces the name, description and tasks; `revision` refuses a stale edit (409). Tasks already generated for periods keep their copy. Owner or controller with close_period. Audited. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"revision\": 0,\n  \"template\": {\n    \"name\": \"\",\n    \"tasks\": [\n      {\n        \"category\": \"subledger_close\",\n        \"due_day_offset\": 0,\n        \"key\": \"\",\n        \"title\": \"\"\n      }\n    ]\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"95764324-3061-412c-83e1-21513ec9f029","name":"listCompanyAccountingCompliancePolicyAreas — Policy areas and their qualified sign-off status","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/compliance/policy_areas","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","compliance","policy_areas"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Policy areas and their qualified sign-off status\n\nEvery policy area that needs qualified review, the policy version in force, the credentials that may sign it, and for each jurisdiction it is encoded for: current, awaiting_evidence, expired, outdated (signed for an older version), revoked or not_reviewed, as of the company's business date. A jurisdiction that is not listed is unsupported, not exempt. Needs view_ledger. Requires accounting:read."}},{"id":"3dd78e25-4089-4058-8697-9e9d4f10ab0e","name":"listCompanyAccountingComplianceReviewers — List registered qualified reviewers","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/compliance/reviewers","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","compliance","reviewers"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"List registered qualified reviewers\n\nEvery registration, revoked ones included, oldest first. Needs view_ledger. Requires accounting:read."}},{"id":"133af532-706a-4426-8507-ade816fe65d9","name":"createCompanyAccountingComplianceReviewer — Register a qualified reviewer","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/compliance/reviewers","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","compliance","reviewers"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Register a qualified reviewer\n\nRegisters an active company member as a qualified reviewer: credential type, number, issuer and jurisdiction, the policy areas they may sign (each must accept the credential type) and the validity window. Nobody may register themselves. Immutable once written except one revocation; audited. Needs manage_grants with company-wide access and step-up (a token needs accounting:step_up). Honors Idempotency-Key. Requires accounting:write.","body":{"mode":"raw","raw":"{\n  \"reviewer\": {\n    \"areas\": [\n      \"\"\n    ],\n    \"credential_issuer\": \"\",\n    \"credential_jurisdiction\": \"\",\n    \"credential_number\": \"\",\n    \"credential_type\": \"cpa\",\n    \"user_id\": 0,\n    \"valid_from\": \"2026-01-31\",\n    \"valid_until\": \"2026-01-31\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"6845851e-b3f6-4904-8f67-daf322eef34b","name":"revokeCompanyAccountingComplianceReviewer — Revoke a qualified reviewer registration","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/compliance/reviewers/:id/revoke","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","compliance","reviewers",":id","revoke"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Revoke a qualified reviewer registration\n\nRecords the one permitted revocation with an audited reason; the reviewer can sign nothing afterwards. Earlier sign-offs stand until revoked themselves. A repeat is 409. Needs manage_grants with company-wide access and step-up. Requires accounting:write.","body":{"mode":"raw","raw":"{\n  \"revoke\": {\n    \"reason\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"cd0ae7d0-a2ac-4338-80a4-668f2f2465ef","name":"listCompanyAccountingComplianceSignoffs — List qualified sign-offs","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/compliance/signoffs","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","compliance","signoffs"],"query":[{"key":"area","value":"","disabled":true,"description":"Only this policy area key"},{"key":"jurisdiction","value":"","disabled":true,"description":"Only this jurisdiction"},{"key":"page","value":"1","disabled":true,"description":"Page"},{"key":"per_page","value":"100","disabled":true,"description":"Page size"}],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"List qualified sign-offs\n\nNewest first, each with its computed status and evidence count. Paginated (Total, Per-Page, Link). Needs view_ledger. Requires accounting:read."}},{"id":"6f11ac49-b5fb-4552-8018-bfb676d8fdff","name":"createCompanyAccountingComplianceSignoff — Record a qualified sign-off","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/compliance/signoffs","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","compliance","signoffs"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Record a qualified sign-off\n\nOnly a reviewer registered for the area on the signing date, with a credential the area accepts, may sign; for a jurisdiction the area is encoded for and the policy version in force (409 otherwise). Signed on or up to 90 days before the business date; expires after it is signed and no later than the area's maximum validity. With exceptions, describe them. The record is immutable (one revocation aside) and audited; reviewer identity and credential are copied onto it. It counts as current once evidence is attached. Needs view_ledger and an active registration. Honors Idempotency-Key. Requires accounting:write.","body":{"mode":"raw","raw":"{\n  \"signoff\": {\n    \"area\": \"\",\n    \"conclusion\": \"approved\",\n    \"expires_on\": \"2026-01-31\",\n    \"jurisdiction\": \"\",\n    \"policy_version\": \"\",\n    \"scope\": \"\",\n    \"signed_on\": \"2026-01-31\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"27e2d3a2-96ca-40dc-868e-af1a1a4045f4","name":"getCompanyAccountingComplianceSignoff — Show a qualified sign-off","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/compliance/signoffs/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","compliance","signoffs",":id"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Show a qualified sign-off\n\nThe sign-off with its computed status and evidence count. Needs view_ledger. Requires accounting:read."}},{"id":"32a14e40-5326-40a3-8ab7-7e21d1f2e598","name":"listCompanyAccountingComplianceSignoffAttachments — List evidence on a qualified sign-off","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/compliance/signoffs/:id/attachments","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","compliance","signoffs",":id","attachments"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"List evidence on a qualified sign-off\n\nOldest first. Needs view_ledger. Requires the accounting:read scope."}},{"id":"1a32a645-7ce3-4af3-88f2-312f464e8d3b","name":"createCompanyAccountingComplianceSignoffAttachment — Attach evidence to a qualified sign-off","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/compliance/signoffs/:id/attachments","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","compliance","signoffs",":id","attachments"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Attach evidence to a qualified sign-off\n\nMultipart upload (one `file` part, allow-listed type, up to MAX_UPLOAD_BYTES): the review memo, workpapers or engagement letter. Only the reviewer who signed may attach, and not after revocation. Writes an attachment_added audit event on the sign-off. Needs view_ledger. Requires the accounting:write scope.","body":{"mode":"formdata","formdata":[{"key":"file","type":"file","src":[]}]}}},{"id":"f14a9efb-1e8b-4c52-8c39-0ba187ef1a20","name":"revokeCompanyAccountingComplianceSignoff — Revoke a qualified sign-off","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/compliance/signoffs/:id/revoke","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","compliance","signoffs",":id","revoke"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Revoke a qualified sign-off\n\nRecords the one permitted revocation with an audited reason; the area falls back to its other sign-offs or shows revoked. A repeat is 409. Needs manage_grants with company-wide access and step-up. Requires accounting:write.","body":{"mode":"raw","raw":"{\n  \"revoke\": {\n    \"reason\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"ba38ac5c-7cd5-461f-86ce-2b915a3dd137","name":"listCompanyAccountingConsolidationEquityMethodRuns — List equity-method runs","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/consolidation/equity_method/runs","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","consolidation","equity_method","runs"],"query":[{"key":"investee_entity_id","value":"","disabled":true,"description":"Filter: investee"},{"key":"period_id","value":"","disabled":true,"description":"Filter: period"}],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"List equity-method runs\n\nRuns newest first. Requires the accounting:read scope."}},{"id":"690be027-fbb5-43d2-8ce6-b0f1b1677e29","name":"createCompanyAccountingConsolidationEquityMethodRun — Prepare an equity-method run","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/consolidation/equity_method/runs","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","consolidation","equity_method","runs"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Prepare an equity-method run\n\nThe investor's share of the investee's net income and OCI for a period (ASC 323-10-35), segment by segment through ownership changes, losses limited to the carrying amount with the excess suspended. An investee kept elsewhere takes a reported net income with its source. The same evidence returns the prepared run (200); a revision posts only the change since earlier posted revisions. Needs post_journal over every entity. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"run\": {\n    \"investee_entity_id\": 0,\n    \"period_id\": 0\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"a70d11eb-334b-4083-8300-bdc3df723f1d","name":"getCompanyAccountingConsolidationEquityMethodRun — Get an equity-method run","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/consolidation/equity_method/runs/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","consolidation","equity_method","runs",":id"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Get an equity-method run\n\nOne run. Requires the accounting:read scope."}},{"id":"8fc3483c-bfab-4c2a-8578-ec4726faed87","name":"decisionCompanyAccountingConsolidationEquityMethodRun — Approve or cancel an equity-method run","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/consolidation/equity_method/runs/:id/decision","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","consolidation","equity_method","runs",":id","decision"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Approve or cancel an equity-method run\n\napprove (approve_journal, never the preparer): recomputes the evidence (409 if anything moved) and posts the investor's entry (investment against equity in earnings and, for OCI, the CTA account). cancel (post_journal, with a reason). A repeat of a finished decision returns the run. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"decision\": {\n    \"action\": \"approve\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"7935c4c4-40d9-4bbc-8270-3b4eadbb2c7f","name":"listCompanyAccountingConsolidationIcDisputes — List intercompany disputes","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/consolidation/ic/disputes","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","consolidation","ic","disputes"],"query":[{"key":"status","value":"","disabled":true,"description":"Filter: status"}],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"List intercompany disputes\n\nNewest first. Requires the accounting:read scope."}},{"id":"8cc88e29-ac15-476b-84ac-9955547ece4b","name":"createCompanyAccountingConsolidationIcDispute — Raise an intercompany dispute","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/consolidation/ic/disputes","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","consolidation","ic","disputes"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Raise an intercompany dispute\n\nOn a pair and currency whose difference on as_of exceeds the tolerance; the active dispute on the same pair and currency is returned instead (200). Needs post_journal over every entity. Audited. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"dispute\": {\n    \"as_of\": \"2026-01-31\",\n    \"currency\": \"\",\n    \"entity_a_id\": 0,\n    \"entity_b_id\": 0\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"27acdb60-a73c-4d2b-857c-602a88938955","name":"getCompanyAccountingConsolidationIcDispute — Get an intercompany dispute","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/consolidation/ic/disputes/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","consolidation","ic","disputes",":id"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Get an intercompany dispute\n\nOne dispute with its history (raised, assigned, comments, adjustment proposed, approved or rejected, resolved, withdrawn). Requires the accounting:read scope."}},{"id":"69d46d68-fa87-474b-89fa-6f8c001a4090","name":"adjustmentCompanyAccountingConsolidationIcDispute — Propose the adjusting entry","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/consolidation/ic/disputes/:id/adjustment","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","consolidation","ic","disputes",":id","adjustment"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Propose the adjusting entry\n\nProposes the entry in the responsible entity that brings the pair's difference to zero on posting_date: its intercompany account (due-from or due-to by direction, naming the other entity) against offset_account_id. The dispute waits for a second user's decision. Needs post_journal. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"adjustment\": {\n    \"offset_account_id\": 0,\n    \"posting_date\": \"2026-01-31\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"9bdf23b6-20dc-4c90-897f-1d6e761b4eb2","name":"assignCompanyAccountingConsolidationIcDispute — Assign an intercompany dispute","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/consolidation/ic/disputes/:id/assign","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","consolidation","ic","disputes",":id","assign"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Assign an intercompany dispute\n\nAssigns an open dispute to a user with accounting access and the entity (one of the pair) that must correct it. The same assignment again changes nothing. Needs post_journal. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"assignment\": {\n    \"assignee_user_id\": 0,\n    \"responsible_entity_id\": 0\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"8cdd8caa-5e20-4836-8d6a-5893f1a9406e","name":"createCompanyAccountingConsolidationIcDisputeComment — Comment on an intercompany dispute","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/consolidation/ic/disputes/:id/comments","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","consolidation","ic","disputes",":id","comments"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Comment on an intercompany dispute\n\nAdds a comment to the dispute's history. Needs post_journal. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"comment\": {\n    \"body\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"6c68d2bf-82c5-423d-8879-2f8756d5c260","name":"decisionCompanyAccountingConsolidationIcDispute — Approve or reject the adjusting entry","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/consolidation/ic/disputes/:id/decision","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","consolidation","ic","disputes",":id","decision"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Approve or reject the adjusting entry\n\napprove (approve_journal, never the proposer): re-checks the difference (409 if it moved), posts the entry and resolves the dispute. reject (post_journal, with a reason) reopens it. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"decision\": {\n    \"action\": \"approve\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"82b909c7-02ad-4f0c-8e35-fef93642181b","name":"resolveCompanyAccountingConsolidationIcDispute — Resolve or withdraw an intercompany dispute","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/consolidation/ic/disputes/:id/resolve","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","consolidation","ic","disputes",":id","resolve"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Resolve or withdraw an intercompany dispute\n\nresolve: allowed once the pair's difference today is within the tolerance (422 otherwise); withdraw: closes it with the note. Needs post_journal. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"resolution\": {\n    \"action\": \"resolve\",\n    \"note\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"2976c091-4e0c-469c-825b-b3b3dfaed0e1","name":"listCompanyAccountingConsolidationIcSettlements — List intercompany settlement runs","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/consolidation/ic/settlements","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","consolidation","ic","settlements"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"List intercompany settlement runs\n\nNewest first. Requires the accounting:read scope."}},{"id":"accbf417-9c68-4f91-8bae-f2d97360ee38","name":"createCompanyAccountingConsolidationIcSettlement — Prepare an intercompany settlement","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/consolidation/ic/settlements","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","consolidation","ic","settlements"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Prepare an intercompany settlement\n\ncash: every matched pair in the base currency is cleared through the entities' cash accounts; netting: each entity's balances against one counterparty are offset into one account. Pairs that do not match, lack a cash account or are in a foreign currency are skipped (listed). The same evidence returns the prepared run (200). Needs post_journal over every entity. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"settlement\": {\n    \"as_of\": \"2026-01-31\",\n    \"mode\": \"cash\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"bd5c3d1f-845c-4e14-861e-2fd5069a4dcd","name":"getCompanyAccountingConsolidationIcSettlement — Get an intercompany settlement run","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/consolidation/ic/settlements/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","consolidation","ic","settlements",":id"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Get an intercompany settlement run\n\nOne run with its lines and settled pairs. Requires the accounting:read scope."}},{"id":"aa6308cf-c0c4-4e52-8a3a-85efbdd3f7fc","name":"decisionCompanyAccountingConsolidationIcSettlement — Approve or cancel an intercompany settlement","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/consolidation/ic/settlements/:id/decision","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","consolidation","ic","settlements",":id","decision"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Approve or cancel an intercompany settlement\n\napprove (approve_journal, never the preparer): recomputes (409 if balances moved) and posts one IC entry per entity, keyed by run and line so a retry posts nothing twice. cancel (post_journal, with a reason). Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"decision\": {\n    \"action\": \"approve\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"52019fb5-a7ba-41bf-8ea3-51ea171041b0","name":"listCompanyAccountingConsolidationIcTransfers — List intercompany asset transfers","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/consolidation/ic/transfers","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","consolidation","ic","transfers"],"query":[{"key":"as_of","value":"","disabled":true,"description":"Date for the status amounts (default: today)"},{"key":"include_voided","value":"","disabled":true,"description":"Include voided transfers"}],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"List intercompany asset transfers\n\nEquipment and inventory sold between group entities, with profit, recognized and deferred amounts as of as_of. Requires the accounting:read scope."}},{"id":"376b5d2b-87d7-4aa2-8330-1e12b55163c0","name":"createCompanyAccountingConsolidationIcTransfer — Register an intercompany asset transfer","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/consolidation/ic/transfers","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","consolidation","ic","transfers"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Register an intercompany asset transfer\n\nConsolidation defers the seller's profit (sale amount less carrying amount) and recognizes it as the buyer depreciates the equipment (useful life from the depreciation start month) or sells the inventory on. Both entities report in the base currency. The identical active transfer is returned (200). Refused in a closed period. Needs post_journal over every entity. Audited. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"transfer\": {\n    \"buyer_asset_account_id\": 0,\n    \"buyer_entity_id\": 0,\n    \"buyer_expense_account_id\": 0,\n    \"kind\": \"fixed_asset\",\n    \"sale_amount\": \"\",\n    \"seller_cost\": \"\",\n    \"seller_entity_id\": 0,\n    \"seller_gain_account_id\": 0,\n    \"transfer_date\": \"2026-01-31\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"5fbef288-dc59-4c37-8fd1-2ab5a0ecd5c7","name":"getCompanyAccountingConsolidationIcTransfer — Get an intercompany asset transfer","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/consolidation/ic/transfers/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","consolidation","ic","transfers",":id"],"query":[{"key":"as_of","value":"","disabled":true,"description":"Date for the status amounts (default: today)"}],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Get an intercompany asset transfer\n\nOne transfer with its events and status amounts as of as_of. Requires the accounting:read scope."}},{"id":"4a1b7ff2-ffd8-463f-8e53-1dfb2c268e42","name":"createCompanyAccountingConsolidationIcTransferEvent — Record a sale on or a disposal","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/consolidation/ic/transfers/:id/events","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","consolidation","ic","transfers",":id","events"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Record a sale on or a disposal\n\nsold (inventory): percent of the transferred goods sold to a third party on event_date; disposed: the buyer disposed of the asset, recognizing what remains. Refused in a closed period. Needs post_journal. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"event\": {\n    \"event_date\": \"2026-01-31\",\n    \"kind\": \"sold\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"72582887-71d2-43f2-8cdd-629501d99a8a","name":"voidCompanyAccountingConsolidationIcTransfer — Void an intercompany asset transfer","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/consolidation/ic/transfers/:id/void","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","consolidation","ic","transfers",":id","void"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Void an intercompany asset transfer\n\nMarks it void with a reason (kept; append-only). Refused in a closed period. Needs post_journal. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"void\": {\n    \"reason\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"5af95038-a9e3-45b8-885d-1c8994272880","name":"listCompanyAccountingConsolidationOwnership — List ownership versions","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/consolidation/ownership","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","consolidation","ownership"],"query":[{"key":"child_entity_id","value":"","disabled":true,"description":"Filter: child entity"},{"key":"include_voided","value":"","disabled":true,"description":"Include voided versions"}],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"List ownership versions\n\nEffective-dated, append-only ownership versions (parent, child, ownership and voting percent, method: full, equity, cost or none), oldest first per child. Needs a grant over every entity. Requires the accounting:read scope."}},{"id":"0de097e0-a0d5-4efd-8576-3cde0ce029c6","name":"createCompanyAccountingConsolidationOwnership — Record an ownership version","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/consolidation/ownership","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","consolidation","ownership"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Record an ownership version\n\nAdds a version effective from effective_from; the relationship in force on a date is the child's latest version on or before it. Full consolidation needs a voting majority or a stated control basis; the equity method needs the investment and equity-in-earnings accounts. Refused (422) when it would change a closed period or form a cycle; the identical version again returns it (200); a different version on the same day is 409. Needs manage_coa over every entity. Audited. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"ownership\": {\n    \"child_entity_id\": 0,\n    \"effective_from\": \"2026-01-31\",\n    \"method\": \"full\",\n    \"ownership_pct\": \"\",\n    \"parent_entity_id\": 0\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"aa9bf064-2e7a-45a4-8093-ffe3a9c40164","name":"getCompanyAccountingConsolidationOwnership — Get an ownership version","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/consolidation/ownership/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","consolidation","ownership",":id"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Get an ownership version\n\nOne ownership version, voided or not. Requires the accounting:read scope."}},{"id":"62d4c022-e851-4138-8d5b-e156ab279a8b","name":"voidCompanyAccountingConsolidationOwnership — Void an ownership version","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/consolidation/ownership/:id/void","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","consolidation","ownership",":id","void"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Void an ownership version\n\nMarks the version void with a reason (the row is kept; history is append-only). Refused when it would change a closed period. Voiding again returns it. Needs manage_coa over every entity. Audited. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"void\": {\n    \"reason\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"3777099c-87e5-4153-83e6-6a421e01d5c7","name":"listCompanyAccountingConsolidationSettings — Consolidation settings","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/consolidation/settings","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","consolidation","settings"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Consolidation settings\n\nThe intercompany matching tolerance. Requires the accounting:read scope."}},{"id":"9f5332dd-863d-422f-8d2f-9862a1401c06","name":"updateCompanyAccountingConsolidationSettings — Update consolidation settings","request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/consolidation/settings","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","consolidation","settings"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Update consolidation settings\n\nSets the intercompany matching tolerance (manage_coa over every entity). Audited. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"settings\": {\n    \"ic_tolerance\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"ef00091a-0541-4bea-84b1-2d900f17af8d","name":"listCompanyAccountingConsolidationStructure — Consolidation group on a date","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/consolidation/structure","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","consolidation","structure"],"query":[{"key":"as_of","value":"","disabled":true,"description":"Date (default: today)"}],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Consolidation group on a date\n\nMembers (roots and fully consolidated entities) with parent, group share and NCI percent, and the entities outside the group (equity, cost, not held, or held through one of those). Requires the accounting:read scope."}},{"id":"11288029-bb0f-4456-879a-8281532cf588","name":"listCompanyAccountingControlObjectives — SOC 1 control register","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/control_objectives","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","control_objectives"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"SOC 1 control register\n\nEach control objective (CO-1 to CO-10) with its owner, frequency, procedure, newest evidence (system records read live, and recorded evidence) and state as of the company's business date: current, overdue (newest evidence older than the frequency), no_evidence or unassigned (no owner). Needs view_ledger on an unrestricted grant. Requires accounting:read."}},{"id":"6d668a0e-ea89-4082-8108-ee494777e929","name":"getCompanyAccountingControlObjective — Get a control objective with its evidence","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/control_objectives/:objective_key","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","control_objectives",":objective_key"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"objective_key","value":"","description":"Control objective key, e.g. CO-1"}]},"description":"Get a control objective with its evidence\n\nThe objective and every evidence item, system and recorded, newest first. Needs view_ledger on an unrestricted grant. Requires accounting:read."}},{"id":"92b23270-8ebd-4335-8374-c27adf2c89be","name":"replaceCompanyAccountingControlObjective — Assign a control objective's owner and frequency","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/control_objectives/:objective_key","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","control_objectives",":objective_key"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"objective_key","value":"","description":"Control objective key, e.g. CO-1"}]},"description":"Assign a control objective's owner and frequency\n\nSets the owner (an active member with accounting access, or null), frequency (monthly, quarterly, semiannual, annual) and procedure. Audited with before and after. Needs manage_grants on an unrestricted grant. Requires accounting:write.","body":{"mode":"raw","raw":"{\n  \"control_objective\": {\n    \"frequency\": \"monthly\",\n    \"owner_user_id\": 0\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"46e3d239-7666-4cab-870f-48f65bb7fd1c","name":"evidenceCompanyAccountingControlObjective — Record control evidence","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/control_objectives/:objective_key/evidence","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","control_objectives",":objective_key","evidence"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"objective_key","value":"","description":"Control objective key, e.g. CO-8"}]},"description":"Record control evidence\n\nAppends evidence of a control performance (append-only): a DR rehearsal report, a document link, or a pointer to an access review or qualified sign-off of this company (ref_id). Not dated in the future. The objective's owner or a grant manager. Needs view_ledger on an unrestricted grant. Honors Idempotency-Key. Requires accounting:write.","body":{"mode":"raw","raw":"{\n  \"evidence\": {\n    \"kind\": \"dr_rehearsal\",\n    \"performed_on\": \"2026-01-31\",\n    \"title\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"a4826a18-6a7d-4ec0-880a-71afdeee2835","name":"createCompanyAccountingCurrentPortionReclass — Post the current-portion reclass","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/current_portion_reclass","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","current_portion_reclass"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Post the current-portion reclass\n\nMoves principal due within one year after as_of from each active schedule's long-term account to the current portion (ASC 210-10-45), on journal GJ, auto-reversing the next day. Idempotent per entity and date. 422 when no schedule exists, no current-portion account is mapped, the period is closed, or a schedule's current portion exceeds its account balance. Needs post_journal. Requires accounting:write.","body":{"mode":"raw","raw":"{\n  \"as_of\": \"2026-01-31\",\n  \"entity_id\": 0\n}","options":{"raw":{"language":"json"}}}}},{"id":"5ab6f734-3916-4440-89f8-00c403a3e249","name":"listCompanyAccountingDashboards — My accounting dashboard","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/dashboards","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","dashboards"],"query":[{"key":"preset","value":"","disabled":true,"description":"Show another preset's default layout instead of the saved one"},{"key":"as_of","value":"","disabled":true,"description":"Date the widgets read (default the company's today)"}],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"My accounting dashboard\n\nThe caller's saved layout, else their role's preset (owner: CFO; controller, accountant, auditor, AR and payroll: controller; AP clerk; project manager), with each widget's data read with the caller's grant. Widgets the grant cannot read are left out and listed in `hidden`. Requires accounting:read."}},{"id":"367bc2f5-f5f4-460f-81be-5fcfda6cee10","name":"replaceCompanyAccountingDashboards — Save my dashboard layout","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/dashboards","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","dashboards"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Save my dashboard layout\n\nA preset plus up to 16 widgets in display order with their size. Every widget must be readable with the caller's grant. Requires accounting:write.","body":{"mode":"raw","raw":"{\n  \"dashboard\": {\n    \"preset\": \"cfo\",\n    \"widgets\": [\n      {\n        \"key\": \"\"\n      }\n    ]\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"c931d459-dbc2-4071-8679-471076747b6d","name":"deleteCompanyAccountingDashboards — Reset my dashboard","request":{"method":"DELETE","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/dashboards","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","dashboards"],"query":[{"key":"preset","value":"","disabled":true,"description":"Preset to reset to (default the role's)"}],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Reset my dashboard\n\nRemoves the saved layout (back to the role preset), or with `preset` saves that preset's default widgets. Requires accounting:write."}},{"id":"101d9285-c03e-4e93-87b7-a1879c8d074a","name":"listCompanyAccountingDashboardsWidgets — Dashboard widgets and presets","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/dashboards/widgets","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","dashboards","widgets"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Dashboard widgets and presets\n\nWidgets the caller's grant can read, and each role preset's widgets. Requires accounting:read."}},{"id":"52c3e083-a4e7-4384-809c-1a384c0b3839","name":"listCompanyAccountingDebtSchedules — List debt and lease schedules","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/debt_schedules","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","debt_schedules"],"query":[{"key":"entity_id","value":"","disabled":true}],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"List debt and lease schedules\n\nActive principal maturity schedules, optionally for one entity. Requires accounting:read."}},{"id":"ec95e8f2-e521-44d8-8fa2-b4cf292214cd","name":"createCompanyAccountingDebtSchedule — Create a debt or lease schedule","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/debt_schedules","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","debt_schedules"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Create a debt or lease schedule\n\nPrincipal maturities of a long-term note or lease liability, the source of the current-portion reclass. The account must be a postable long-term liability. Needs post_journal; audited. Requires accounting:write.","body":{"mode":"raw","raw":"{\n  \"debt_schedule\": {\n    \"account_id\": 0,\n    \"entity_id\": 0,\n    \"name\": \"\",\n    \"payments\": [\n      {\n        \"due_date\": \"2026-01-31\",\n        \"principal\": \"\"\n      }\n    ]\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"6d134693-0eca-4be4-864b-e78035cb8472","name":"deleteCompanyAccountingDebtSchedule — Deactivate a debt or lease schedule","request":{"method":"DELETE","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/debt_schedules/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","debt_schedules",":id"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Deactivate a debt or lease schedule\n\nStops it feeding later reclasses (kept for the audit trail). Needs post_journal. Requires accounting:write."}},{"id":"b2086d6b-3b79-455c-81c3-a8aa504e6013","name":"listCompanyAccountingDimensions — List dimensions","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/dimensions","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","dimensions"],"query":[{"key":"active","value":"","disabled":true}],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"List dimensions\n\nEvery dimension with its values and requirement rules, by position then code. `active=true` lists active dimensions only. Requires the accounting:read scope."}},{"id":"e6ccd09d-97c0-49cd-8f39-d31caeb217de","name":"createCompanyAccountingDimension — Create a dimension","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/dimensions","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","dimensions"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Create a dimension\n\nNeeds manage_coa on an unrestricted grant. Codes are unique per company (case-insensitive). Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"dimension\": {\n    \"code\": \"\",\n    \"name\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"f1ebec27-9b5b-4fcc-8c90-a3135863cdb2","name":"getCompanyAccountingDimension — Show a dimension","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/dimensions/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","dimensions",":id"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Show a dimension\n\nRequires the accounting:read scope."}},{"id":"73bacd99-fa76-4e1b-8e3d-db2e24dd7c13","name":"updateCompanyAccountingDimension — Update a dimension","request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/dimensions/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","dimensions",":id"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Update a dimension\n\nRename (audited as `renamed` with from and to), change the default requirement or order, or (de)activate. An inactive dimension's values are refused at posting. Needs manage_coa on an unrestricted grant. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"dimension\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"5d4f019d-3b6c-4913-862f-89e0f05bcac3","name":"listCompanyAccountingDimensionHistory — Dimension history","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/dimensions/:id/history","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","dimensions",":id","history"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Dimension history\n\nAudit trail of the dimension and its values, newest first (at most 500): created, renamed (changes.name / changes.code from and to), updated, deactivated, reactivated and rules_changed (rules before and after). Requires the accounting:read scope."}},{"id":"9c26681e-0b89-40f3-84b6-21b3084c9ae7","name":"listCompanyAccountingDimensionRules — List a dimension's requirement rules","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/dimensions/:id/rules","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","dimensions",":id","rules"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"List a dimension's requirement rules\n\nRequires the accounting:read scope."}},{"id":"ff927075-8f64-4b04-8322-e8be68ffa3fd","name":"replaceCompanyAccountingDimensionRules — Replace a dimension's requirement rules","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/dimensions/:id/rules","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","dimensions",":id","rules"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Replace a dimension's requirement rules\n\nEach rule names one selector: account_id, account_type, or an account number range (account_from with account_to, inclusive). The most specific match wins (account, then the narrowest range, then type), else the dimension's default_requirement. `optional` exempts accounts a broader rule requires. Checked when an entry posts; closing entries and reversals are exempt. Needs manage_coa on an unrestricted grant. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"rules\": [\n    {\n      \"requirement\": \"optional\"\n    }\n  ]\n}","options":{"raw":{"language":"json"}}}}},{"id":"46d25115-992d-4f06-88d2-5d152f460d88","name":"listCompanyAccountingDimensionValues — List a dimension's values","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/dimensions/:id/values","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","dimensions",":id","values"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"List a dimension's values\n\nBy code; parent_id gives the roll-up hierarchy. Requires the accounting:read scope."}},{"id":"67aeca8c-498a-4640-819d-a173cd1f10e7","name":"createCompanyAccountingDimensionValue — Create a dimension value","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/dimensions/:id/values","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","dimensions",":id","values"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Create a dimension value\n\nparent_id must be a value of the same dimension. entity_ids restricts the value to those entities (empty = every entity); effective_from/effective_to bound the posting dates it accepts. Needs manage_coa on an unrestricted grant. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"value\": {\n    \"code\": \"\",\n    \"name\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"cf048297-c39d-40d2-8b9b-3964583cd92f","name":"getCompanyAccountingDimensionValue — Show a dimension value","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/dimensions/:id/values/:value_id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","dimensions",":id","values",":value_id"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""},{"key":"value_id","value":""}]},"description":"Show a dimension value\n\nRequires the accounting:read scope."}},{"id":"bf366083-f3cf-4633-896a-a0e7b469dd29","name":"updateCompanyAccountingDimensionValue — Update a dimension value","request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/dimensions/:id/values/:value_id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","dimensions",":id","values",":value_id"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""},{"key":"value_id","value":""}]},"description":"Update a dimension value\n\nRename, re-parent (no cycles), change the effective window or entity restriction, or (de)activate. Posted lines keep the value id, so reports show the new name for all history and the rename is in the dimension's history. Needs manage_coa on an unrestricted grant. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"value\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"7c7449c0-b6e4-41a0-8e73-215813333534","name":"listCompanyAccountingEntities — List legal entities","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/entities","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","entities"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"List legal entities\n\nLegal entities inside the company, for multi-entity books, intercompany and consolidation. Every posted entry balances per entity. Requires the accounting:read scope."}},{"id":"b81c5de5-e349-4c74-838f-fdd5d8f349f0","name":"createCompanyAccountingEntity — Create a legal entity","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/entities","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","entities"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Create a legal entity\n\nAdds an entity with optional intercompany due-to/due-from accounts. The first entity becomes the default. Needs manage_coa. Requires the accounting:write scope. `is_elimination: true` creates the consolidation elimination book (one per company), which takes only CL entries and never becomes the default.","body":{"mode":"raw","raw":"{\n  \"entity\": {\n    \"code\": \"\",\n    \"name\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"f6566b0f-fd64-4897-871c-0512825633fb","name":"getCompanyAccountingEntity — Show a legal entity","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/entities/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","entities",":id"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Show a legal entity\n\nOne entity of this company. Requires the accounting:read scope."}},{"id":"9d832f45-19da-46a7-84e3-b8f7dd717482","name":"updateCompanyAccountingEntity — Update a legal entity","request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/entities/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","entities",":id"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Update a legal entity\n\nRenames, deactivates or remaps intercompany accounts. Needs manage_coa. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"entity\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"a59d5117-9f17-4f38-832a-1c37f3759a34","name":"createCompanyAccountingFiscalYear — Generate a fiscal year","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/fiscal_years","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","fiscal_years"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Generate a fiscal year\n\nCreates the fiscal year (labelled by the calendar year it ends in) and its twelve monthly periods from the settings' start month. Returns the existing year unchanged if it already exists. A year before a closed period is refused unless `closed` is true. Needs close_period with unrestricted entity access. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"fiscal_year\": {\n    \"year\": 0\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"c26c4862-60d4-4038-8317-bcaeeb2bcbff","name":"adjustingPeriodCompanyAccountingFiscalYear — Add the adjusting period (period 13)","request":{"method":"POST","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/fiscal_years/:id/adjusting_period","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","fiscal_years",":id","adjusting_period"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Add the adjusting period (period 13)\n\nAdds period 13 to the fiscal year: one day on the year's last day, open, for audit adjustments that land after later months closed. Entries reach it only with adjusting: true (GJ or CL), it is exempt from later closed periods, and it closes and reopens on its own. Idempotent: 200 with the existing period. Needs close_period with unrestricted entity access. Audited. Requires the accounting:write scope."}},{"id":"b283a698-7c2d-4676-89ca-30a8fce95d30","name":"yearEndCloseCompanyAccountingFiscalYear — Post the year-end close","request":{"method":"POST","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/fiscal_years/:id/year_end_close","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","fiscal_years",":id","year_end_close"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Post the year-end close\n\nPosts one closing entry (journal `CL`, `is_closing_entry: true`, source `year_end_close` with the fiscal year id) dated the last day of the year. It moves the year’s income and expense balances of every entity into retained earnings, balanced per entity, and marks the fiscal year `closed`. Earlier fiscal years with income or expense balances must be closed first. Once closed, the year refuses every posting except closing entries until the close is reversed (POST .../year_end_close/reverse). Each entity closes into its own retained_earnings_account_id when set (else the company's retained earnings), and equity accounts with subtype `distributions` (S-corp distributions, partner draws) close into it too. When the year has period 13, the closing entry posts there, period 13 may stay open, and each later adjusting entry re-closes the year with a new revision. Every period of the year must be soft-closed (or closed) for GL first, and the last period must still accept GL postings. Idempotent: a rerun returns the existing entry with 200. Reports already present prior-year earnings in retained earnings, so the entry changes no statement total. Needs close_period with unrestricted entity access. Audited. Requires the accounting:write scope."}},{"id":"eec68574-284e-468a-8162-01a151978e05","name":"createCompanyAccountingFiscalYearYearEndCloseReverse — Reverse the year-end close","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/fiscal_years/:id/year_end_close/reverse","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","fiscal_years",":id","year_end_close","reverse"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Reverse the year-end close\n\nReverses the fiscal year's standing year-end closing entry on its own date (the year's last day) and reopens the fiscal year (status `open`), so the year can take postings and be closed again. The last period must still accept GL postings. Needs post_journal and close_period with unrestricted entity access; at or above the approval threshold the reverser must hold approve_journal and must not have prepared the close. 404 when the year has no posted closing entry. Audited. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"reversal\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"b03d223c-bd11-4b25-814c-d6abc3268176","name":"listCompanyAccountingFpaCashForecast — Cash forecast","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/fpa/cash_forecast","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","fpa","cash_forecast"],"query":[{"key":"as_of","value":"","disabled":true},{"key":"granularity","value":"","disabled":true},{"key":"buckets","value":"","disabled":true},{"key":"scenario_id","value":"","disabled":true},{"key":"entity_id","value":"","disabled":true,"description":"One entity of the grant's scope. The forecast is single-currency: a scope whose entities keep different functional currencies is refused (422) unless narrowed to one entity."}],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Cash forecast\n\nThe job-aware rolling cash forecast: 13 weeks (granularity week) or 12 months (month) after as_of (default today). Opening = book balance of the non-card bank accounts in scope. Lines (each with its source document and basis): open AR on due date + the customer's days past due at payment; AR retainage at job completion + release days; pay apps not yet invoiced and the remaining prime contract spread to completion; open AP on due date or on the discount date at the discounted amount (policy); draft payment runs; AP retainage at completion; open commitments spread to completion on vendor terms; payroll (unposted runs, then the pay calendar at the recent average; payroll_view only); recurring journals; debt principal; lease payments; manual lines. scenario_id applies a scenario overlay. ties reconcile each source to its open items (in the horizon, beyond it, excluded). Banking-wide: an entity-scoped grant sees its entities. Requires the accounting:read scope. Entity-wide: a project-scoped (project_manager_view) grant gets 403."}},{"id":"d5ea3b12-996c-4bb0-8c7d-cfe0b1f2fd9f","name":"listCompanyAccountingFpaCashForecastAdjustments — List manual forecast lines","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/fpa/cash_forecast/adjustments","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","fpa","cash_forecast","adjustments"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"List manual forecast lines\n\nManual cash forecast lines, voided ones included. Requires the accounting:read scope. Entity-wide: a project-scoped (project_manager_view) grant gets 403."}},{"id":"5cfee0ab-6c5f-40d7-8ccc-0edc8c60438a","name":"createCompanyAccountingFpaCashForecastAdjustment — Add a manual forecast line","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/fpa/cash_forecast/adjustments","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","fpa","cash_forecast","adjustments"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Add a manual forecast line\n\nA known receipt (positive) or payment (negative) dated after today with a reason. An entity-scoped grant must name one of its entities. Needs bank_reconcile; audited. Honors Idempotency-Key. Requires the accounting:write scope. Entity-wide: a project-scoped (project_manager_view) grant gets 403.","body":{"mode":"raw","raw":"{\n  \"adjustment\": {\n    \"amount\": \"\",\n    \"date\": \"2026-01-31\",\n    \"reason\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"9839c71d-e170-40e5-8a94-c210cf183043","name":"voidCompanyAccountingFpaCashForecastAdjustment — Void a manual forecast line","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/fpa/cash_forecast/adjustments/:id/void","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","fpa","cash_forecast","adjustments",":id","void"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Void a manual forecast line\n\nManual lines are never edited or deleted: a correction voids one with a reason. Needs bank_reconcile; audited. Requires the accounting:write scope. Entity-wide: a project-scoped (project_manager_view) grant gets 403.","body":{"mode":"raw","raw":"{\n  \"reason\": \"\"\n}","options":{"raw":{"language":"json"}}}}},{"id":"ea909b7b-d362-4d90-8749-61d6fc084e30","name":"listCompanyAccountingFpaCashForecastCompare — Compare cash scenarios","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/fpa/cash_forecast/compare","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","fpa","cash_forecast","compare"],"query":[{"key":"as_of","value":"","disabled":true},{"key":"granularity","value":"","disabled":true},{"key":"buckets","value":"","disabled":true},{"key":"scenario_ids","value":"","disabled":false},{"key":"entity_id","value":"","disabled":true,"description":"One entity of the grant's scope. The forecast is single-currency: a scope whose entities keep different functional currencies is refused (422) unless narrowed to one entity."}],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Compare cash scenarios\n\nThe base forecast and each scenario overlay of the same lines (scenario_ids, comma-separated, at most 5): net and closing per bucket, totals and low points. A scenario never changes the base column. Requires the accounting:read scope. Entity-wide: a project-scoped (project_manager_view) grant gets 403."}},{"id":"a48bfd49-5853-44dc-893b-8285f1749434","name":"listCompanyAccountingFpaCashForecastDaysToPay — Customer days to pay","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/fpa/cash_forecast/days_to_pay","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","fpa","cash_forecast","days_to_pay"],"query":[{"key":"as_of","value":"","disabled":true},{"key":"customer_id","value":"","disabled":true}],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Customer days to pay\n\nPer customer (and all customers, customer_id null) from posted, unreversed receipt applications: invoices fully paid within the lookback window; days to pay = paid date − invoice date, days late = paid date − due date; mean and median rounded half up to whole days; lag_days is the configured statistic of days late, which shifts open invoices in the forecast. Requires the accounting:read scope. Entity-wide: a project-scoped (project_manager_view) grant gets 403."}},{"id":"a8680c06-7f43-4e41-8de2-a523b9399016","name":"listCompanyAccountingFpaCashForecastSnapshots — List cash forecast snapshots","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/fpa/cash_forecast/snapshots","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","fpa","cash_forecast","snapshots"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"List cash forecast snapshots\n\nStored forecasts, newest first; an entity-scoped grant sees snapshots within its entities. Requires the accounting:read scope. Entity-wide: a project-scoped (project_manager_view) grant gets 403."}},{"id":"5531db45-00de-47e4-8f49-9d74d78d59b2","name":"createCompanyAccountingFpaCashForecastSnapshot — Store a cash forecast snapshot","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/fpa/cash_forecast/snapshots","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","fpa","cash_forecast","snapshots"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Store a cash forecast snapshot\n\nStores today's forecast (as of the company's today) with every line, its basis and a content hash. Append-only: a database trigger refuses any update or delete. Needs bank_reconcile; audited. Honors Idempotency-Key. Requires the accounting:write scope. Entity-wide: a project-scoped (project_manager_view) grant gets 403.","body":{"mode":"raw","raw":"{\n  \"snapshot\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"c95d15e8-173e-4b3a-86b5-b3b9c1b10a5b","name":"getCompanyAccountingFpaCashForecastSnapshot — Show a cash forecast snapshot","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/fpa/cash_forecast/snapshots/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","fpa","cash_forecast","snapshots",":id"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Show a cash forecast snapshot\n\nWith its stored lines. Requires the accounting:read scope. Entity-wide: a project-scoped (project_manager_view) grant gets 403."}},{"id":"827b8ea6-2ff1-4073-8458-725440f88f6e","name":"listCompanyAccountingFpaCashForecastSnapshotAccuracy — Forecast vs actual","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/fpa/cash_forecast/snapshots/:id/accuracy","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","fpa","cash_forecast","snapshots",":id","accuracy"],"query":[{"key":"as_of","value":"","disabled":true}],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Forecast vs actual\n\nFor every bucket of the snapshot that has ended by as_of (default today): forecast in/out from the stored lines vs actual posted debits/credits to the snapshot's cash accounts in its entity scope (entries that only move cash between those accounts left out); error = actual net − forecast net, absolute percent error, forecast vs actual closing balance; summary bias, MAE and MAPE. Requires the accounting:read scope. Entity-wide: a project-scoped (project_manager_view) grant gets 403."}},{"id":"165512c7-c975-4427-87e1-fb17e24261ac","name":"listCompanyAccountingFpaMarginFade — Margin fade portfolio","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/fpa/margin_fade","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","fpa","margin_fade"],"query":[{"key":"as_of","value":"","disabled":true},{"key":"flagged","value":"","disabled":true}],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Margin fade portfolio\n\nEvery job with projected margin snapshots in scope (a project_manager_view grant: its own jobs): the latest margin, the change since the prior and the first snapshot, and fade flags against the FP&A thresholds (a fall of more than the percentage points or the amount). Faded jobs first. Requires the accounting:read scope."}},{"id":"68f88550-a3ba-4855-84ce-d92a6fb41c10","name":"createCompanyAccountingFpaMarginFadeCapture — Capture projected margins","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/fpa/margin_fade/capture","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","fpa","margin_fade","capture"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Capture projected margins\n\nCaptures each job's projected margin at a past period end: the job's latest approved or posted WIP row for that period end (its EAC override when set), else its latest unsuperseded frozen PM forecast in that month with a known contract value. Append-only: a job already captured for the period keeps its snapshot. Needs close_period; audited. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"period_end\": \"2026-01-31\"\n}","options":{"raw":{"language":"json"}}}}},{"id":"3f20119b-bac3-4c81-82d7-cb55bb7e4dd8","name":"getCompanyAccountingFpaMarginFade — Job margin history","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/fpa/margin_fade/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","fpa","margin_fade",":id"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":"","description":"Project id"}]},"description":"Job margin history\n\nOne job's projected margin snapshots, the change since the prior and first snapshot, its fade flags and every threshold crossing (events). A project_manager_view grant reads its own jobs only. Requires the accounting:read scope."}},{"id":"fac6c83a-02aa-4fa1-89a2-d9ba86c021b8","name":"listCompanyAccountingFpaScenarios — List forecast scenarios","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/fpa/scenarios","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","fpa","scenarios"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"List forecast scenarios\n\nNamed scenarios (base, upside, downside, custom) with their overlay adjustments. Requires the accounting:read scope. Entity-wide: a project-scoped (project_manager_view) grant gets 403."}},{"id":"fe75898c-7275-4d0b-881e-b1a82ae74af8","name":"createCompanyAccountingFpaScenario — Create a forecast scenario","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/fpa/scenarios","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","fpa","scenarios"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Create a forecast scenario\n\nA scenario is a set of overlay adjustments, never a copy: target budget (by account and/or project: percent, or amount per month) or cash (by driver and/or project: percent, amount per bucket, or shift_days). Needs close_period and unrestricted entity access; audited. Honors Idempotency-Key. Requires the accounting:write scope. Entity-wide: a project-scoped (project_manager_view) grant gets 403.","body":{"mode":"raw","raw":"{\n  \"scenario\": {\n    \"name\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"1f7735f3-aecc-426b-823d-dd0fbfa71a96","name":"listCompanyAccountingFpaScenariosCompare — Compare budget scenarios","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/fpa/scenarios/compare","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","fpa","scenarios","compare"],"query":[{"key":"budget_id","value":"","disabled":false},{"key":"scenario_ids","value":"","disabled":false}],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Compare budget scenarios\n\nA budget version's fiscal-year totals per account against the overlay of each scenario (scenario_ids, comma-separated, at most 5), with net income per column. The version is read, never changed. Requires the accounting:read scope. Entity-wide: a project-scoped (project_manager_view) grant gets 403."}},{"id":"617b7c0c-ce7c-461f-8a33-63353a6fb67d","name":"getCompanyAccountingFpaScenario — Show a forecast scenario","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/fpa/scenarios/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","fpa","scenarios",":id"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Show a forecast scenario\n\nRequires the accounting:read scope. Entity-wide: a project-scoped (project_manager_view) grant gets 403."}},{"id":"8665da6e-4913-47be-86c7-f7667b1ba3a4","name":"deleteCompanyAccountingFpaScenario — Delete a forecast scenario","request":{"method":"DELETE","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/fpa/scenarios/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","fpa","scenarios",":id"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Delete a forecast scenario\n\nRefused (409) while a stored cash forecast snapshot names it. Needs close_period; audited. Requires the accounting:write scope. Entity-wide: a project-scoped (project_manager_view) grant gets 403."}},{"id":"83fc126a-4c1e-4e7b-8afa-e700a00c3fd6","name":"createCompanyAccountingFpaScenarioAdjustment — Add a scenario adjustment","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/fpa/scenarios/:id/adjustments","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","fpa","scenarios",":id","adjustments"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Add a scenario adjustment\n\nNeeds close_period; audited. Honors Idempotency-Key. Requires the accounting:write scope. Entity-wide: a project-scoped (project_manager_view) grant gets 403.","body":{"mode":"raw","raw":"{\n  \"adjustment\": {\n    \"method\": \"percent\",\n    \"target\": \"budget\",\n    \"value\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"4d978ca9-c1a1-4e87-818e-6274171db703","name":"deleteCompanyAccountingFpaScenarioAdjustment — Remove a scenario adjustment","request":{"method":"DELETE","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/fpa/scenarios/:id/adjustments/:adjustment_id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","fpa","scenarios",":id","adjustments",":adjustment_id"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""},{"key":"adjustment_id","value":""}]},"description":"Remove a scenario adjustment\n\nNeeds close_period; audited. Requires the accounting:write scope. Entity-wide: a project-scoped (project_manager_view) grant gets 403."}},{"id":"83ab6cc6-bfbe-4b7a-86eb-c19d6dd49837","name":"listCompanyAccountingFpaSettings — FP&A settings","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/fpa/settings","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","fpa","settings"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"FP&A settings\n\nCash forecast timing policy and margin fade thresholds (defaults until saved: saved false). Requires the accounting:read scope."}},{"id":"5e4840b7-31d8-4855-8979-d50f321cbb33","name":"updateCompanyAccountingFpaSettings — Update FP&A settings","request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/fpa/settings","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","fpa","settings"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Update FP&A settings\n\nNeeds close_period and unrestricted entity access; audited with the diff. Requires the accounting:write scope. Entity-wide: a project-scoped (project_manager_view) grant gets 403.","body":{"mode":"raw","raw":"{\n  \"settings\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"471476a1-1089-492b-8384-4cd76f8a2e7d","name":"listCompanyAccountingFxEntities — List entity functional currencies","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/fx/entities","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","fx","entities"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"List entity functional currencies\n\nEach entity in the grant's scope with its functional currency (the base currency when unset). Requires the accounting:read scope."}},{"id":"02d4f5c7-01e1-4a74-81b2-395640034300","name":"updateCompanyAccountingFxEntity — Set an entity's functional currency","request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/fx/entities/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","fx","entities",":id"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Set an entity's functional currency\n\nASC 830-10-45-2. Allowed only before the entity has posted or unposted entries (a later change is prospective remeasurement, which is not automated); the elimination entity stays in the base currency. Needs manage_coa over every entity. Audited. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"entity\": {\n    \"functional_currency\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"aa03ab29-e6a9-4a5f-8382-f9a9ae3c37f4","name":"listCompanyAccountingFxRates — List exchange rates","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/fx/rates","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","fx","rates"],"query":[{"key":"from_currency","value":"","disabled":true,"description":"Filter: from currency"},{"key":"to_currency","value":"","disabled":true,"description":"Filter: to currency"},{"key":"rate_type","value":"","disabled":true,"description":"Filter: rate type"},{"key":"since","value":"","disabled":true,"description":"Effective on or after"},{"key":"until","value":"","disabled":true,"description":"Effective on or before"},{"key":"page","value":"1","disabled":true,"description":"Page number"},{"key":"per_page","value":"100","disabled":true,"description":"Page size (default 100)"}],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"List exchange rates\n\nEffective-dated rates (spot, average, historical), newest first, with Total/Per-Page/Link headers. Any accounting grant. Requires the accounting:read scope."}},{"id":"be7dc757-b132-440e-8d2a-4cb6b74db432","name":"createCompanyAccountingFxRate — Add an exchange rate","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/fx/rates","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","fx","rates"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Add an exchange rate\n\nAdds one rate: `rate` units of to_currency per unit of from_currency, effective on effective_date. Needs manage_coa over every entity. Audited. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"exchange_rate\": {\n    \"effective_date\": \"2026-01-31\",\n    \"from_currency\": \"\",\n    \"rate\": \"\",\n    \"to_currency\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"b0cc6ac1-6f1a-4b64-8381-ae75784b2698","name":"createCompanyAccountingFxRatesImport — Import exchange rates from CSV","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/fx/rates/import","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","fx","rates","import"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Import exchange rates from CSV\n\nCSV with header rate_type,from_currency,to_currency,effective_date,rate (rate_type optional, default spot). All or nothing: any invalid row, or a row that would change an existing rate, refuses the file (422; with dry_run the errors are returned). Rows equal to existing rates are unchanged, so re-importing a file is a no-op (natural key). One audit event with the file's sha256. Needs manage_coa over every entity. Returns 201 when rates were created, else 200. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"import\": {\n    \"csv\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"72a7951d-d1d7-4ab8-8fa7-d2d888acf0a3","name":"getCompanyAccountingFxRate — Show an exchange rate","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/fx/rates/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","fx","rates",":id"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Show an exchange rate\n\nOne rate, with whether it is used (immutable). Requires the accounting:read scope."}},{"id":"e7cfe633-0adb-4089-87cb-e7a730596fe7","name":"updateCompanyAccountingFxRate — Change an unused exchange rate","request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/fx/rates/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","fx","rates",":id"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Change an unused exchange rate\n\nChanges the rate or effective date of a rate no posting, document or revaluation has used (409 once used; a database trigger also refuses). Needs manage_coa over every entity. Audited with before and after values. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"exchange_rate\": {\n    \"rate\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"62c84d89-e6c2-4726-84ba-edcb80f27e2c","name":"deleteCompanyAccountingFxRate — Delete an unused exchange rate","request":{"method":"DELETE","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/fx/rates/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","fx","rates",":id"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Delete an unused exchange rate\n\nDeletes a rate nothing has used (409 once used). Needs manage_coa over every entity. Audited. Requires the accounting:write scope."}},{"id":"6e3b5670-b289-44e2-8240-20dd8ed8ded2","name":"listCompanyAccountingFxRevaluations — List revaluation runs","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/fx/revaluations","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","fx","revaluations"],"query":[{"key":"entity_id","value":"","disabled":true,"description":"Filter: entity"},{"key":"period_id","value":"","disabled":true,"description":"Filter: period"}],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"List revaluation runs\n\nMonth-end revaluation runs, newest first (at most 200), in the grant's entities. Requires the accounting:read scope."}},{"id":"71bd212f-534c-4478-85ac-d375b64e9ec3","name":"createCompanyAccountingFxRevaluation — Prepare a revaluation","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/fx/revaluations","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","fx","revaluations"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Prepare a revaluation\n\nASC 830-20-35-1: restates the entity's foreign-currency cash, receivable, payable and intercompany balances at the period-end spot rate. Saves a prepared run with its lines, rates and evidence hash; nothing posts until a different user approves. Natural key: at most one prepared run per entity and period; preparing again with unchanged balances and rates returns the current run (200, unchanged: true). Refused (422) in a closed period, when the next period (where it reverses) is missing or closed, when a prior revaluation has not yet auto-reversed, or when no gain/loss account is mapped. Needs post_journal and the entity in the grant. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"revaluation\": {\n    \"entity_id\": 0,\n    \"period_id\": 0\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"0ec75d65-2dec-4986-8415-4a79b76b12ea","name":"listCompanyAccountingFxRevaluationsPreview — Preview a revaluation","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/fx/revaluations/preview","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","fx","revaluations","preview"],"query":[{"key":"entity_id","value":"","disabled":false,"description":"Entity"},{"key":"period_id","value":"","disabled":false,"description":"Period"}],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Preview a revaluation\n\nWhat a revaluation of the entity for the period would post now. No write. Requires the accounting:read scope."}},{"id":"c392ae45-3e87-4e70-8d87-5443ce25d23f","name":"getCompanyAccountingFxRevaluation — Show a revaluation run","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/fx/revaluations/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","fx","revaluations",":id"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Show a revaluation run\n\nOne run with its lines, rates and posting. Requires the accounting:read scope."}},{"id":"165ad7f2-ce16-48de-80e7-74ff0d51787b","name":"decisionCompanyAccountingFxRevaluation — Approve or cancel a revaluation","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/fx/revaluations/:id/decision","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","fx","revaluations",":id","decision"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Approve or cancel a revaluation\n\napprove (approve_journal, never the preparer): recomputes the evidence (409 if balances or rates moved), posts the GJ entry dated the period end, auto-reversing on the next period's first day, and stamps the rates used. cancel (post_journal, with a reason) withdraws a prepared run. A repeat of a finished decision returns the run. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"decision\": {\n    \"action\": \"approve\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"7a41aaec-57f7-4812-8c52-c06e1a220052","name":"createCompanyAccountingFxSetup — Create the FX accounts","request":{"method":"POST","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/fx/setup","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","fx","setup"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Create the FX accounts\n\nCreates and maps any missing FX_GAIN_LOSS (7500), FX_UNREALIZED_GAIN_LOSS (7510) and CTA (3600, accumulated other comprehensive income) accounts. Idempotent: nothing is created when every role is mapped (200). Needs manage_coa over every entity. Audited. Requires the accounting:write scope."}},{"id":"14af7c3d-c6f3-4f21-8db4-271111e10607","name":"listCompanyAccountingFxTranslation — Translated trial balance","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/fx/translation","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","fx","translation"],"query":[{"key":"entity_id","value":"","disabled":false,"description":"Entity"},{"key":"as_of","value":"","disabled":false,"description":"As-of date"}],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Translated trial balance\n\nASC 830-30 current rate method for one entity as of a date: assets and liabilities at the closing rate (reporting-currency balances at their transaction amount), income and expense at monthly average rates, equity at historical rates, prior years' earnings in retained earnings, and the cumulative translation adjustment. Lists the rates used. Requires the accounting:read scope."}},{"id":"32ccf824-8f1a-4bac-8554-46e153cd35ef","name":"listCompanyAccountingGeneralLedger — General ledger detail","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/general_ledger","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","general_ledger"],"query":[{"key":"account_id","value":"","disabled":true,"description":"One account (enables running balances)"},{"key":"from","value":"","disabled":true,"description":"Inclusive start (default the fiscal year start for `to`)"},{"key":"to","value":"","disabled":true,"description":"Inclusive end"},{"key":"entity_id","value":"","disabled":true,"description":"Entity"},{"key":"project_id","value":"","disabled":true,"description":"Project"},{"key":"department_id","value":"","disabled":true,"description":"Department"},{"key":"dimension_value_ids","value":"","disabled":true,"description":"Comma-separated dimension value ids: lines carrying one of them or a child value (values of one dimension OR, dimensions AND). Opening, closing and running balances follow the filter."},{"key":"cost_code_id","value":"","disabled":true,"description":"Cost code"},{"key":"party_id","value":"","disabled":true,"description":"Lines whose vendor or customer is this company vendor. Narrows the lines only: opening, closing and running balance are null."},{"key":"source_type","value":"","disabled":true,"description":"Lines of this source type (manual, ap_bill, ar_invoice, payroll_run, intercompany for generated due-to/due-from lines…). Narrows the lines only: opening, closing and running balance are null."},{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true},{"key":"cursor","value":"","disabled":true,"description":"Opaque keyset cursor from `next_cursor` of the previous page; when set, `page` is ignored"}],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"General ledger detail\n\nPosted lines between `from` (default the start of the fiscal year holding `to`) and `to` (default today) in posting order. With `account_id` the response also carries the opening balance, a running balance per line and the closing balance (debit positive). Filter by entity, project, department or cost code. Requires the accounting:read scope. Deep reads should page by keyset: pass the previous response’s `next_cursor` as `cursor` (the running balance travels in the cursor, so no earlier line is re-summed); `page` is then ignored and the response carries no `Link` page header. Cursors are at most 512 characters; a longer or malformed one returns 422."}},{"id":"2246d93e-cf98-4ee2-8ccc-a97ee7c20d53","name":"listCompanyAccountingGrants — List accounting access","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/grants","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","grants"],"query":[{"key":"search","value":"","disabled":true,"description":"Name or email"},{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true}],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"List accounting access\n\nEvery company member with their accounting role and permission flags. Company admins are implicit owners. Needs manage_grants. Requires the accounting:read scope."}},{"id":"0b7458f4-2e0d-4d24-87e9-f9b0c39d73ed","name":"createCompanyAccountingGrantsAccessReview — Certify an access review","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/grants/access_review","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","grants","access_review"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Certify an access review\n\nQuarterly access review: decide every grant inside your entity scope except your own (keep stamps certified_at; revoke deletes the grant), in one transaction with one audit row per grant (grant_certified or grant_revoked). 422 when a grant is undecided or a decision names a member without a reviewable grant. Needs manage_grants. Requires the accounting:write scope. Step-up: from a browser session this needs an authenticator code re-entered within settings step_up_minutes (401 step_up_required); a user without a factor is refused (403 mfa_required) unless the MFA policy is off entirely (require_mfa_for empty and require_mfa_for_accounting off). An API token cannot re-enter a code: it passes only when it holds the accounting:step_up scope (403 step_up_required otherwise; the MFA policy still applies to its user); each such use writes a step_up_token audit row.","body":{"mode":"raw","raw":"{\n  \"access_review\": {\n    \"decisions\": [\n      {\n        \"decision\": \"keep\",\n        \"user_id\": 0\n      }\n    ]\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"cfa58c8e-5480-4a8e-8914-3d5890ae7765","name":"updateCompanyAccountingGrant — Set a member's accounting access","request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/grants/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","grants",":id"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":"","description":"The member's user id"}]},"description":"Set a member's accounting access\n\nGrants a role preset (owner, controller, accountant, ap_clerk, ar_clerk, payroll_admin, project_manager_view, auditor_readonly) or `none` to revoke. Individual flags override the preset; `entity_ids` limits the grant to some entities. Needs manage_grants. Audited in the same transaction. Requires the accounting:write scope. 422 when a project_manager_view grant would hold an AP, AR, banking or payroll flag (ap_enter, ap_approve, release_payments, manage_vendor_banking, ar_enter, ar_approve, bank_reconcile, payroll_view, payroll_run, view_payroll_pii): the role is project-scoped and those areas are entity-wide. A grant saved with one before this check resolves with it off, so every AP, AR, banking and payroll endpoint answers it 403. Preventive segregation of duties: rules ap_full_cycle (ap_enter + ap_approve + release_payments + manage_vendor_banking), payroll_full_cycle (payroll_run + view_payroll_pii + manage_vendor_banking) and gl_full_cycle (post_journal + approve_journal + close_period) warn: a grant that gains one needs `reason` (422 sod_reason_required), and the response lists every conflict it holds in `warnings`. grants_with_payments (manage_grants + release_payments) blocks (422 sod_blocked) except on the owner role. Step-up: from a browser session this needs an authenticator code re-entered within settings step_up_minutes (401 step_up_required); a user without a factor is refused (403 mfa_required) unless the MFA policy is off entirely (require_mfa_for empty and require_mfa_for_accounting off). An API token cannot re-enter a code: it passes only when it holds the accounting:step_up scope (403 step_up_required otherwise; the MFA policy still applies to its user); each such use writes a step_up_token audit row.","body":{"mode":"raw","raw":"{\n  \"grant\": {\n    \"role\": \"owner\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"93cbe6ea-ce2c-4d77-82c9-fcb51bbd7ab3","name":"listCompanyAccountingIntegrationsConnections — List ERP connections with health and recent sync runs","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/integrations/connections","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","integrations","connections"],"variable":[{"key":"company_id","value":"{{companyId}}"}]},"description":"List ERP connections with health and recent sync runs\n\nRequires the accounting:read scope."}},{"id":"b4150911-0065-4b60-8fe3-32fa75b90514","name":"createCompanyAccountingIntegrationsConnection — Create an ERP connection (manageIntegrations)","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/integrations/connections","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","integrations","connections"],"variable":[{"key":"company_id","value":"{{companyId}}"}]},"description":"Create an ERP connection (manageIntegrations)\n\nRequires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"config\": {},\n  \"entity_id\": 0,\n  \"external_tenant\": \"\",\n  \"name\": \"\",\n  \"provider\": \"qbo\"\n}","options":{"raw":{"language":"json"}}}}},{"id":"e0548318-fb09-48d2-8201-c4861bb10b21","name":"syncCompanyAccountingIntegrationsConnection — Queue a sync pull (live API connections); it stages coa, vendors and open_ap import runs","request":{"method":"POST","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/integrations/connections/:id/sync","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","integrations","connections",":id","sync"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Queue a sync pull (live API connections); it stages coa, vendors and open_ap import runs\n\nRequires the accounting:write scope."}},{"id":"7c2bc3b6-7782-4a01-8a8f-e8cb858d37fc","name":"listCompanyAccountingIntegrationsExportsJournals — Export posted journals as an ERP import file","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/integrations/exports/journals","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","integrations","exports","journals"],"query":[{"key":"from","value":"","disabled":true,"description":"Posting date range; required unless since_last or batch_id is sent."},{"key":"to","value":"","disabled":true,"description":"Posting date range; required unless since_last or batch_id is sent."},{"key":"format","value":"","disabled":true},{"key":"journal","value":"","disabled":true},{"key":"entity_id","value":"","disabled":true},{"key":"target","value":"","disabled":true,"description":"A named feed (another ERP running alongside). Each posted entry is exported to a target once: entries already sent to it are left out, and the new ones are recorded as an export batch (X-Export-Batch-Id). Needs the accounting:write scope and the manageIntegrations grant (403 otherwise); a read-only workspace is refused."},{"key":"since_last","value":"","disabled":true,"description":"With target: every posted entry not yet exported to it, whatever its posting date, oldest post first, up to the line cap (call again for the rest). An entry posted late with a back date is never missed."},{"key":"batch_id","value":"","disabled":true,"description":"Download a recorded batch again (for a lost response), exactly as it was exported: its stored format and qbo_class are used, not the ones sent."},{"key":"qbo_class","value":"","disabled":true,"description":"What the qbo_journal Class column carries. Location is the entity code."}],"variable":[{"key":"company_id","value":"{{companyId}}"}]},"description":"Export posted journals as an ERP import file\n\nNeeds view_ledger; a project-scoped (project_manager_view) grant gets 403. Posted entries (reversed originals and their reversals) with posting dates in [from, to], optionally one journal (journal=AP exports AP) and one entity, in the caller's entity scope. The debit_credit and signed_amount files end with Entity (code) and Department columns, since one file can mix entities. Job-coded lines carry Project (project number, else name), Cost Code (full code) and Cost Type (code); the QBO template's Name column carries the line's vendor or customer, Location the entity code and Class the project (or department, qbo_class). Every entry balances before the file is written; text cells are formula-escaped and amounts are exact. Up to 20,000 lines; rate limited per user across all app instances (429 with Retry-After). Each export is audited. A target export that races another export to the same target is 409; export again. Requires the accounting:read scope; with target, the accounting:write scope (it records what was sent)."}},{"id":"3b13f0cb-9593-4661-8452-370ce71cba89","name":"listCompanyAccountingIntegrationsImports — List imports","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/integrations/imports","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","integrations","imports"],"query":[{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true}],"variable":[{"key":"company_id Import runs carry opening balances and open AP/AR documents, so project-scoped (project_manager_view) grants get 403 on every import read.","value":""},{"key":"company_id","value":"{{companyId}}"}]},"description":"List imports\n\nRequires the accounting:read scope."}},{"id":"c99fb9e8-47ee-4c70-8438-61f1df7e5e5a","name":"createCompanyAccountingIntegrationsImport — Upload CSV and persist validation preview","request":{"method":"POST","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/integrations/imports","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","integrations","imports"],"variable":[{"key":"company_id Import runs carry opening balances and open AP/AR documents, so project-scoped (project_manager_view) grants get 403 on every import read.","value":""},{"key":"company_id","value":"{{companyId}}"}]},"description":"Upload CSV and persist validation preview\n\nRequires the accounting:write scope.","body":{"mode":"formdata","formdata":[{"key":"as_of","value":"","type":"text"},{"key":"entity_id","value":"","type":"text"},{"key":"file","type":"file","src":[]},{"key":"kind","value":"","type":"text"},{"key":"profile","value":"","type":"text"},{"key":"source_namespace","value":"","type":"text"}]}}},{"id":"bc9f9cb2-dae0-43f1-8061-a07d4def18cc","name":"getCompanyAccountingIntegrationsImport — Read preview, results and history","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/integrations/imports/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","integrations","imports",":id"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Read preview, results and history\n\nRequires the accounting:read scope."}},{"id":"c4125db4-2ecd-4704-84da-be3b32e5ba78","name":"createCompanyAccountingIntegrationsImportPost — Map, reconcile, approve/apply or reverse an imported entry","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/integrations/imports/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","integrations","imports",":id"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Map, reconcile, approve/apply or reverse an imported entry\n\nRequires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"action\": null,\n  \"mapping\": {\n    \"accounts\": {},\n    \"columns\": {}\n  },\n  \"preview_hash\": \"\"\n}","options":{"raw":{"language":"json"}}}}},{"id":"8aef5ba7-db7c-471c-8fa1-ee18f25112e4","name":"listCompanyAccountingIntegrationsInbox — Integration error inbox: sync run errors and blocked or failed import runs","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/integrations/inbox","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","integrations","inbox"],"variable":[{"key":"company_id","value":"{{companyId}}"}]},"description":"Integration error inbox: sync run errors and blocked or failed import runs\n\nRequires the accounting:read scope."}},{"id":"a3f33070-8619-4f6f-807b-5ccdbe76c62e","name":"createCompanyAccountingIntegrationsParallelRun — Parallel run: compare a source system trial balance with the posted trial balance on the same date","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/integrations/parallel_run","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","integrations","parallel_run"],"variable":[{"key":"company_id","value":"{{companyId}}"}]},"description":"Parallel run: compare a source system trial balance with the posted trial balance on the same date\n\nRequires the accounting:read scope and a ledger viewer grant over the entity. Read only: nothing is posted. The CSV uses the opening_tb layout (account with debit/credit or a signed balance). Source accounts map by the saved opening_tb mapping of source_namespace, else by account number. Balances are cumulative posted balances through as_of in the entity.","body":{"mode":"raw","raw":"{\n  \"as_of\": \"2026-01-31\",\n  \"csv\": \"\",\n  \"entity_id\": 0,\n  \"source_namespace\": \"\"\n}","options":{"raw":{"language":"json"}}}}},{"id":"9a65d308-1a4a-4631-8297-53309df30b14","name":"getCompanyAccountingIntegrationsSyncRun — Get a sync run","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/integrations/sync_runs/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","integrations","sync_runs",":id"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Get a sync run\n\nRequires the accounting:read scope."}},{"id":"5f04ae7b-5f06-479b-8707-eef5f0ceab33","name":"listCompanyAccountingJobCostEntries — List job cost entries","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/job_cost_entries","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","job_cost_entries"],"query":[{"key":"filters[project_id]","value":"","disabled":true,"description":"Project ids"},{"key":"filters[cost_code_id]","value":"","disabled":true,"description":"Cost code ids"},{"key":"filters[cost_type]","value":"","disabled":true,"description":"labor, material, subcontract, equipment, other, burden"},{"key":"filters[kind]","value":"","disabled":true,"description":"actual, committed, estimate, projection, change, billed"},{"key":"from","value":"","disabled":true,"description":"On or after"},{"key":"to","value":"","disabled":true,"description":"On or before"},{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true}],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"List job cost entries\n\nThe job cost subledger: one actual row per posted line on a job-cost account with a project (labor, burden, material, subcontract, equipment, other), linked to its GL line. Filter with `filters[project_id]`, `filters[cost_code_id]`, `filters[cost_type]`, `filters[kind]` and a `from`/`to` date range. A project_manager_view grant sees only the projects its user is a member of. Requires the accounting:read scope."}},{"id":"5f318a19-641d-4545-8fa2-44e7a0e8f793","name":"getCompanyAccountingJobTaxProfile — Get a job tax profile","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/job_tax_profiles/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","job_tax_profiles",":id"],"query":[{"key":"as_of","value":"","disabled":true}],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Get a job tax profile\n\n`id` is the project id. Returns the job's contractor sales/use tax profile with the model resolved from the state and contract type on `as_of` (default today). Requires the accounting:read scope."}},{"id":"4d2402e1-4c3d-4f4a-8213-97ac7073e143","name":"replaceCompanyAccountingJobTaxProfile — Set a job tax profile","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/job_tax_profiles/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","job_tax_profiles",":id"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Set a job tax profile\n\n`id` is the project id. Creates or replaces the profile. A state with no encoded contractor rule is refused (422, setup gap) rather than defaulted. Retailer and gross-receipts states need sales_tax_code_id (except separated retailer contracts); use-tax states need use_tax_code_id. Needs manage_coa. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"tax_profile\": {\n    \"contract_type\": \"lump_sum\",\n    \"state_code\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"5a168f09-0950-4da0-8258-db50dd1d4b52","name":"listCompanyAccountingJobcostForecast — Review a tenant/entity-scoped forecast from dated sources","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/jobcost/forecast","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","jobcost","forecast"],"query":[{"key":"project_id","value":"","disabled":false},{"key":"entity_id","value":"","disabled":false},{"key":"as_of","value":"","disabled":false}],"variable":[{"key":"company_id","value":"{{companyId}}"}]},"description":"Review a tenant/entity-scoped forecast from dated sources\n\nRequires the accounting:read scope."}},{"id":"b811053c-4581-4799-85b4-06403a741906","name":"replaceCompanyAccountingJobcostForecast — Save a dated PM forecast input: projection method per cost code (manual cost to complete, physical percent complete, unit rate, budget) and its inputs (jobFor","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/jobcost/forecast","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","jobcost","forecast"],"variable":[{"key":"company_id","value":"{{companyId}}"}]},"description":"Save a dated PM forecast input: projection method per cost code (manual cost to complete, physical percent complete, unit rate, budget) and its inputs (jobForecastEdit permission; PM grants only on projects they belong to). With no PM input a cost code's EAC is max(revised budget, actual + remaining commitments) (flag unforecast_budget when the budget is higher); a null cost_to_complete selects actual + remaining commitments explicitly and, like any input, needs approval before WIP reads it. Saving clears any approval; saving on a later date than the carried-forward input adds a new dated input. Frozen forecasts dated on or after the input are superseded (kept, with supersededAt), never deleted; the audit lists their ids. Refused (409) in a soft- or hard-closed job cost period and on or before the latest posted WIP period end for the entity.\n\nRequires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"as_of\": \"2026-01-31\",\n  \"cost_code_id\": 0,\n  \"cost_to_complete\": \"\",\n  \"entity_id\": 0,\n  \"project_id\": 0,\n  \"reason\": \"\",\n  \"revision\": 0\n}","options":{"raw":{"language":"json"}}}}},{"id":"efa20e0e-32b2-4403-8b4a-d0cde22d5e9c","name":"createCompanyAccountingJobcostForecastApprove — Approve the PM input shown for a cost code on the worksheet date (approveJournal permission; the last editor cannot approve). Only approved inputs may f","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/jobcost/forecast/approve","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","jobcost","forecast","approve"],"variable":[{"key":"company_id","value":"{{companyId}}"}]},"description":"Approve the PM input shown for a cost code on the worksheet date (approveJournal permission; the last editor cannot approve). Only approved inputs may feed WIP. Approving the last pending input for the date freezes the forecast there, superseding (not deleting) an earlier freeze on the same date. Refused (409) in a hard-closed period or on or before the latest posted WIP period end; allowed in a soft-closed period, so a month-end approval freezes at the period end.\n\nRequires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"as_of\": \"2026-01-31\",\n  \"cost_code_id\": 0,\n  \"entity_id\": 0,\n  \"project_id\": 0,\n  \"revision\": 0\n}","options":{"raw":{"language":"json"}}}}},{"id":"9ce6b035-1b68-4806-8914-7b1d2d131a18","name":"listCompanyAccountingJobcostScope — List accessible projects, entities and source assignments","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/jobcost/scope","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","jobcost","scope"],"variable":[{"key":"company_id","value":"{{companyId}}"}]},"description":"List accessible projects, entities and source assignments\n\nRequires the accounting:read scope."}},{"id":"f966c029-1cd6-48bc-8b15-596803b2d01d","name":"createCompanyAccountingJobcostScope — Assign a project's sources to one entity and base currency (unrestricted manageCoa permission)","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/jobcost/scope","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","jobcost","scope"],"variable":[{"key":"company_id","value":"{{companyId}}"}]},"description":"Assign a project's sources to one entity and base currency (unrestricted manageCoa permission)\n\nRequires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"confirm_project_sources\": true,\n  \"currency\": \"\",\n  \"entity_id\": 0,\n  \"project_id\": 0,\n  \"reason\": \"\"\n}","options":{"raw":{"language":"json"}}}}},{"id":"0c024f8f-6808-4c2b-891c-9bf458d86513","name":"updateCompanyAccountingJobcostScope — Set a job's WIP contract terms (manageCoa): revenue method (cost_to_cost, or as_invoiced for T&M / cost-plus jobs: revenue equals billings, ASC 606-10-55-18) and/","request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/jobcost/scope","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","jobcost","scope"],"variable":[{"key":"company_id","value":"{{companyId}}"}]},"description":"Set a job's WIP contract terms (manageCoa): revenue method (cost_to_cost, or as_invoiced for T&M / cost-plus jobs: revenue equals billings, ASC 606-10-55-18) and/or whether retainage is conditional (WIP presents it as a contract asset, ASC 606-10-45-3). Audited with the reason.\n\nRequires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"project_id\": 0,\n  \"reason\": \"\",\n  \"retainage_conditional\": false,\n  \"revenue_method\": \"cost_to_cost\"\n}","options":{"raw":{"language":"json"}}}}},{"id":"66687e5e-d6d9-4f37-8f94-ca905499b53d","name":"listCompanyAccountingJobcostWip — List WIP snapshots (newest period end and revision first), 100 per page, filtered by entity, period and status.","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/jobcost/wip","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","jobcost","wip"],"query":[{"key":"entity_id","value":"","disabled":true},{"key":"period_id","value":"","disabled":true},{"key":"status","value":"","disabled":true},{"key":"page","value":"1","disabled":true,"description":"1-based page of 100 snapshots"}],"variable":[{"key":"company_id","value":"{{companyId}}"}]},"description":"List WIP snapshots (newest period end and revision first), 100 per page, filtered by entity, period and status.\n\nRequires the accounting:read scope."}},{"id":"00fdbea3-a3cd-4abe-8c99-6a75888d9bdd","name":"createCompanyAccountingJobcostWip — Compute the next WIP revision for an entity at an ended period (postJournal and viewLedger). Contract = executed prime SOV + approved prime COs; cost = posted job c","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/jobcost/wip","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","jobcost","wip"],"variable":[{"key":"company_id","value":"{{companyId}}"}]},"description":"Compute the next WIP revision for an entity at an ended period (postJournal and viewLedger). Contract = executed prime SOV + approved prime COs; cost = posted job cost; billed = posted AR; EAC = the forecast frozen at the period end (PM approval or soft close) plus job cost posted since the freeze beyond what the freeze already held on each cost code (only cost on a commitment-linked line consumes the open commitment frozen there; a budget_remaining code rises to max(frozen EAC, actual + commitment left)), else the approved live forecast, unless overridden with a reason. Each job uses its revenue method (cost_to_cost or as_invoiced); pending prime COs are the memo column (pendingChangeOrders) and enter the transaction price only through overrides[].change_orders; retainage receivable comes from AR (retainageContractAsset when the job's retainage is conditional); each row records settings.loss_provision_unit; cash position is AR receipts less AP payments on the job (payroll and other direct cash costs are not included). A job whose inputs fail is a compute_failed exception, and an executed contract with no value against a positive EAC a contract_value_missing exception (not on completed_contract jobs; the other jobs still compute); both block approval. Rows are read without the company posting lock; the insert refuses with 409 if job cost or billings were posted, or job forecast inputs changed, meanwhile. Supports Idempotency-Key.\n\nRequires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"entity_id\": 0,\n  \"overrides\": [\n    {\n      \"project_id\": 0,\n      \"reason\": \"\"\n    }\n  ],\n  \"period_id\": 0\n}","options":{"raw":{"language":"json"}}}}},{"id":"81df61c4-de9f-439b-8d53-3c407b0d2769","name":"getCompanyAccountingJobcostWip — Get a WIP snapshot with its job rows; format=csv returns the rows as CSV","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/jobcost/wip/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","jobcost","wip",":id"],"query":[{"key":"format","value":"","disabled":true}],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Get a WIP snapshot with its job rows; format=csv returns the rows as CSV\n\nRequires the accounting:read scope."}},{"id":"59a5425a-4688-4e7e-8d2b-a764643c39ff","name":"approveCompanyAccountingJobcostWip — Approve a draft snapshot (approveJournal; the preparer cannot approve). A snapshot with exceptions needs exceptions_note; compute_failed exceptions cannot be ackno","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/jobcost/wip/:id/approve","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","jobcost","wip",":id","approve"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Approve a draft snapshot (approveJournal; the preparer cannot approve). A snapshot with exceptions needs exceptions_note; compute_failed exceptions cannot be acknowledged. Idempotent; a rejected snapshot is refused.\n\nRequires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"exceptions_note\": \"\"\n}","options":{"raw":{"language":"json"}}}}},{"id":"b373e09d-a452-4658-80ef-b0cff6befb89","name":"listCompanyAccountingJobcostWipAttachments — List attachments on a WIP snapshot","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/jobcost/wip/:id/attachments","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","jobcost","wip",":id","attachments"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"List attachments on a WIP snapshot\n\nOldest first. Needs view_ledger and the parent's entity scope. Requires the accounting:read scope."}},{"id":"38dd628f-37d7-4fe9-8986-bacbfe7d8502","name":"createCompanyAccountingJobcostWipAttachment — Attach a file to a WIP snapshot","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/jobcost/wip/:id/attachments","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","jobcost","wip",":id","attachments"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Attach a file to a WIP snapshot\n\nMultipart upload (one `file` part, allow-listed type, up to MAX_UPLOAD_BYTES). Allowed after posting: attachments are not ledger data. Writes an attachment_added audit event on the parent in the same transaction. Needs post_journal and the parent's entity scope. Requires the accounting:write scope.","body":{"mode":"formdata","formdata":[{"key":"file","type":"file","src":[]}]}}},{"id":"fdcd8a09-b450-4463-83df-42691714e95b","name":"postCompanyAccountingJobcostWip — Post an approved snapshot on journal WIP at the period end with autoReverseDate the next day; idempotent on (snapshot, revision). Supersedes an earlier posted revisio","request":{"method":"POST","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/jobcost/wip/:id/post","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","jobcost","wip",":id","post"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Post an approved snapshot on journal WIP at the period end with autoReverseDate the next day; idempotent on (snapshot, revision). Supersedes an earlier posted revision for the period.\n\nRequires the accounting:write scope."}},{"id":"0dff94c9-f55d-47b4-87bd-f72290bcf77f","name":"rejectCompanyAccountingJobcostWip — Reject a draft or approved snapshot (approveJournal; terminal, compute a new revision), or with return_to_draft send an approved one back to draft (approval and ack","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/jobcost/wip/:id/reject","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","jobcost","wip",":id","reject"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Reject a draft or approved snapshot (approveJournal; terminal, compute a new revision), or with return_to_draft send an approved one back to draft (approval and acknowledgment cleared). Audited with the reason.\n\nRequires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"reason\": \"\",\n  \"return_to_draft\": false\n}","options":{"raw":{"language":"json"}}}}},{"id":"525c3d1c-376c-4fa7-8a9b-242f38325eea","name":"listCompanyAccountingJournalEntries — List journal entries","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/journal_entries","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","journal_entries"],"query":[{"key":"filters[status]","value":"","disabled":true,"description":"draft, pending_approval, posted, reversed"},{"key":"filters[journal]","value":"","disabled":true,"description":"GJ, AP, AR, PR, CM, JC, FA, CL, IC, WIP"},{"key":"filters[source_type]","value":"","disabled":true,"description":"e.g. manual, recurring, reversal"},{"key":"filters[entity_id]","value":"","disabled":true,"description":"Entity ids"},{"key":"filters[period_id]","value":"","disabled":true,"description":"Period ids"},{"key":"filters[account_id]","value":"","disabled":true,"description":"Entries with a line on these accounts"},{"key":"filters[project_id]","value":"","disabled":true,"description":"Entries with a line on these projects"},{"key":"from","value":"","disabled":true,"description":"Posting date on or after"},{"key":"to","value":"","disabled":true,"description":"Posting date on or before"},{"key":"search","value":"","disabled":true,"description":"Number or memo"},{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true},{"key":"updated_since","value":"","disabled":true,"description":"Delta sync: only rows created or changed at or after this time (ISO 8601 with offset). Switches the list to ascending (updated_at, id) order; page is ignored and Next-Cursor continues it. Re-read with a small overlap (a few seconds) and dedupe by id."},{"key":"cursor","value":"","disabled":true,"description":"Opaque keyset cursor from a previous response's Next-Cursor header; each page costs the same however deep it is."}],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"List journal entries\n\nJournal entries newest first. Filter with `filters[status]`, `filters[journal]`, `filters[source_type]`, `filters[entity_id]`, `filters[period_id]`, `filters[account_id]`, `filters[project_id]`, a `from`/`to` posting-date range, or `search` (number or memo). Requires the accounting:read scope."}},{"id":"92755856-ca53-4079-8790-e3958a0d481f","name":"createCompanyAccountingJournalEntry — Create a draft journal entry","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/journal_entries","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","journal_entries"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Create a draft journal entry\n\nSaves a manual entry as a draft. Each line has either a debit or a credit (never both), and may carry dimensions (project, cost code, cost type, vendor, customer, department, ...). Drafts may be unbalanced; balance, open period, account and dimension rules are enforced at submit and post. Control accounts (AP, AR, retainage) post only from their subledgers. Needs post_journal. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"journal_entry\": {\n    \"lines\": [\n      {\n        \"account_id\": 0\n      }\n    ],\n    \"posting_date\": \"2026-01-31\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"dd2e25fc-8e24-48bc-8e93-ee9a9e20e920","name":"getCompanyAccountingJournalEntry — Show a journal entry","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/journal_entries/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","journal_entries",":id"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Show a journal entry\n\nHeader, lines with account numbers, totals and a balanced flag. Requires the accounting:read scope."}},{"id":"dde4d153-4d5c-42ee-80b0-a8d73cd71694","name":"updateCompanyAccountingJournalEntry — Update a draft journal entry","request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/journal_entries/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","journal_entries",":id"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Update a draft journal entry\n\nEdits a draft or pending entry; `lines` replaces every line. Any edit returns a pending entry to draft and clears its approval. Posted entries are immutable. Needs post_journal. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"journal_entry\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"26d366dd-f0f9-440d-8ca3-fd231e537f52","name":"deleteCompanyAccountingJournalEntry — Delete a draft journal entry","request":{"method":"DELETE","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/journal_entries/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","journal_entries",":id"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Delete a draft journal entry\n\nRemoves a draft or pending entry. Posted entries cannot be deleted; reverse them. Needs post_journal. Requires the accounting:write scope."}},{"id":"a10d1d89-18ed-4011-8628-ddff8f02d6bf","name":"approveCompanyAccountingJournalEntry — Approve a journal entry","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/journal_entries/:id/approve","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","journal_entries",":id","approve"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Approve a journal entry\n\nRecords one approval on a pending entry's route. Submit resolves the route from the lowest-priority active journal_entry approval rule matching the entry (amount, entities, projects; N-of-M groups); with none, one approve_journal user approves. Delegates may act within an active delegation. The vote that completes the route stamps approved_by_id, which posting needs at or above the approval threshold. Segregation of duties: a user who prepared or edited the entry can't approve it (403); one vote per user (409 already_approved); a caller not on the current step gets 403 approver_role_required. In small-team SoD mode (settings sod_mode) a maker may approve their own document by sending approve.reason; the event is audited as self_approved and listed by approvals/self_approved. Needs approve_journal. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"approve\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"95eb4316-3ba8-4285-8694-4f108f48c6b4","name":"listCompanyAccountingJournalEntryAttachments — List attachments on a journal entry","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/journal_entries/:id/attachments","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","journal_entries",":id","attachments"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"List attachments on a journal entry\n\nOldest first. Needs view_ledger and the parent's entity scope. Requires the accounting:read scope."}},{"id":"597623df-3ed9-4bd4-8ac9-e61ff39e4bf1","name":"createCompanyAccountingJournalEntryAttachment — Attach a file to a journal entry","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/journal_entries/:id/attachments","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","journal_entries",":id","attachments"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Attach a file to a journal entry\n\nMultipart upload (one `file` part, allow-listed type, up to MAX_UPLOAD_BYTES). Allowed after posting: attachments are not ledger data. Writes an attachment_added audit event on the parent in the same transaction. Needs post_journal and the parent's entity scope. Requires the accounting:write scope.","body":{"mode":"formdata","formdata":[{"key":"file","type":"file","src":[]}]}}},{"id":"1b2fcbdf-7f46-42ce-81e3-9bcc2a24827e","name":"postCompanyAccountingJournalEntry — Post a journal entry","request":{"method":"POST","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/journal_entries/:id/post","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","journal_entries",":id","post"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Post a journal entry\n\nPosts a draft or pending entry to the ledger and assigns its JE-YYYY-##### number. Entries at or above the settings approval threshold must be approved by a second person first. An entry routed by a journal_entry approval rule must complete that route first, whatever the threshold (422). Writes job cost rows for job-cost lines, an audit record in the same transaction, and emits `accounting.journal_entry.posted` (ids and links only). Needs post_journal. Requires the accounting:write scope. An unapproved entry is refused (422) at or above the approval threshold, and also below it when an active journal_entry approval rule matches the entry as it stands at post time (a draft never submitted, or edited after a reject, must be submitted and approved first). An approval any of whose voters (each approved route step, or the final approver) has since lost approve_journal (or the entities on the lines) no longer counts: the entry is treated as unapproved and the approval is cleared. Allocation run and year-end close entries also need close_period."}},{"id":"008851db-ce06-4cd0-89fe-7be385344e4a","name":"rejectCompanyAccountingJournalEntry — Reject a journal entry (return to the preparer)","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/journal_entries/:id/reject","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","journal_entries",":id","reject"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Reject a journal entry (return to the preparer)\n\nNeeds approve_journal and every line's entity. A pending_approval entry returns to draft; its approval route is spent, so resubmission routes afresh. The reason is required and audited (action rejected). Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"reject\": {\n    \"reason\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"8fae9af2-ba85-4204-8fa0-7b63e9f00bff","name":"reverseCompanyAccountingJournalEntry — Reverse a posted journal entry","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/journal_entries/:id/reverse","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","journal_entries",":id","reverse"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Reverse a posted journal entry\n\nPosts a mirror entry (debits and credits swapped) on `date`, links the two both ways and marks the original reversed. Repeating the call returns the same reversal. Entries from a subledger document reverse through that document instead. At or above the approval threshold, or when an active journal_entry approval rule matches the original (amount, entities, projects, vendor risk) at any amount, the reverser must hold approve_journal and not be one of its authors (403); under a rule they also fill the rule's route as its approver (403 approver_role_required when no slot fits), and a route needing more than one approval is refused (422): enter the reversing entry as a journal entry and submit it. Needs post_journal. Emits `accounting.journal_entry.reversed`. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"reversal\": {\n    \"date\": \"2026-01-31\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"12872de5-0193-4a91-8a9f-91821ab306a3","name":"submitCompanyAccountingJournalEntry — Submit a journal entry for approval","request":{"method":"POST","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/journal_entries/:id/submit","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","journal_entries",":id","submit"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Submit a journal entry for approval\n\nValidates the draft in full (balanced per entity, postable active accounts, required dimensions, open period) and moves it to pending_approval. An intercompany entry (journal IC) gets its generated due-to/due-from lines stored now (line source_type `intercompany`, total updated), so approvers see the entry as it will post; editing the draft drops them and the next submit regenerates them. Needs post_journal. Requires the accounting:write scope."}},{"id":"95aaff17-cc89-4877-8773-6f02e9e2c356","name":"listCompanyAccountingLeases — List leases","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/leases","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","leases"],"query":[{"key":"page","value":"1","disabled":true,"description":"Page number"},{"key":"per_page","value":"100","disabled":true,"description":"Page size"}],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"List leases\n\nThe ASC 842 lessee lease register with each lease's commencement liability and ROU. Requires the accounting:read scope. Entity-wide: a project-scoped (project_manager_view) grant gets 403."}},{"id":"5a7fb344-dbdd-4af4-8fa0-4ff6f6117329","name":"createCompanyAccountingLease — Add a lease","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/leases","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","leases"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Add a lease\n\nAdds a lessee lease (LS-#### numbering) and, unless it is a short-term election, posts the commencement entry Dr right-of-use asset / Cr lease liability at the present value of the payments (annual rate / 12, monthly). Accounts default to 1841/1842 ROU, 2741/2742 and 2535/2536 liabilities, 6200 (operating and short-term) or 6710 (finance amortization) cost, 8100 interest and 2130 payments. Terms are locked once added. Needs post_journal. Audited. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"lease\": {\n    \"asset_class\": \"\",\n    \"classification\": \"operating\",\n    \"commencement_date\": \"2026-01-31\",\n    \"discount_rate\": \"\",\n    \"name\": \"\",\n    \"payment\": \"\",\n    \"term_months\": 0\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"befe9397-cb31-46dc-8508-0f528325203b","name":"listCompanyAccountingLeasesDisclosures — Lease disclosures","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/leases/disclosures","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","leases","disclosures"],"query":[{"key":"from","value":"","disabled":true,"description":"Start date (default: January 1 of the year of `to`)"},{"key":"to","value":"","disabled":true,"description":"End date (default: today)"}],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Lease disclosures\n\nASC 842-20-50 lessee disclosures from the lease schedules: lease cost by type, cash paid (operating vs financing), ROU assets obtained for new lease liabilities (noncash), and at `to` the balances, weighted average remaining term and discount rate, and the maturity analysis (years 1-5, thereafter, less imputed interest, which equals the liability). Payments count as paid when due. Requires the accounting:read scope. Entity-wide: a project-scoped (project_manager_view) grant gets 403."}},{"id":"66b45975-d5c3-44c8-8a67-8036ffdc08c8","name":"listCompanyAccountingLeasesRuns — List lease runs","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/leases/runs","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","leases","runs"],"query":[{"key":"page","value":"1","disabled":true,"description":"Page number"},{"key":"per_page","value":"100","disabled":true,"description":"Page size"}],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"List lease runs\n\nPosted monthly lease runs, newest first. Requires the accounting:read scope. Entity-wide: a project-scoped (project_manager_view) grant gets 403."}},{"id":"5a8d3169-917c-44cb-8fc9-7ae7520e88eb","name":"createCompanyAccountingLeasesRun — Preview or post a lease run","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/leases/runs","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","leases","runs"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Preview or post a lease run\n\nWith `preview: true` returns what the run would post (200). Otherwise posts one entry for the calendar-month period (201): per lease, the schedule to date minus what its lines already hold (catch-up), covering lease cost, interest, ROU amortization, payments and the current/noncurrent reclass. Refused when nothing is due, when a later lease entry exists, or when the period is closed. Needs post_journal to post. Audited. The accounting:read scope is enough for a preview. Requires the accounting:write scope. A project-scoped (project_manager_view) grant gets 403, preview included.","body":{"mode":"raw","raw":"{\n  \"lease_run\": {\n    \"period_id\": 0\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"629c69a9-4149-4c1a-8bf5-47dac1d7da6a","name":"getCompanyAccountingLeasesRun — Show a lease run","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/leases/runs/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","leases","runs",":id"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Show a lease run\n\nThe run with its journal lines. Requires the accounting:read scope. Entity-wide: a project-scoped (project_manager_view) grant gets 403."}},{"id":"781dbd93-ba02-459d-8b1b-445e8f807836","name":"reverseCompanyAccountingLeasesRun — Reverse a lease run","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/leases/runs/:id/reverse","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","leases","runs",":id","reverse"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Reverse a lease run\n\nPosts the mirror entry on `date` and marks the run's entry reversed; the next run catches the leases up again. Idempotent for the same date and reason. Needs post_journal. Audited. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"reversal\": {\n    \"date\": \"2026-01-31\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"71888928-ebd2-478d-83da-c5c69f9b6802","name":"getCompanyAccountingLease — Show a lease","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/leases/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","leases",":id"],"query":[{"key":"version","value":"","disabled":true,"description":"Schedule version: 0 = the original schedule, k = after the k-th remeasurement. Default: the schedule in force."}],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Show a lease\n\nThe lease with its monthly schedule (liability, interest, principal, current portion, lease cost, ROU) and the GL lines that carry it. Requires the accounting:read scope. Entity-wide: a project-scoped (project_manager_view) grant gets 403."}},{"id":"49082e26-0bd9-426a-8544-99a57aa02018","name":"listCompanyAccountingLeaseModifications — List lease modifications","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/leases/:id/modifications","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","leases",":id","modifications"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"List lease modifications\n\nThe lease's modifications, oldest first. Append-only history: each remeasurement creates a schedule version. Requires the accounting:read scope. A project-scoped grant gets 403."}},{"id":"47ecf369-fef0-4990-8d6f-c8b07447ee4f","name":"createCompanyAccountingLeaseModification — Modify a lease (ASC 842 remeasurement)","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/leases/:id/modifications","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","leases",":id","modifications"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Modify a lease (ASC 842 remeasurement)\n\nRecords an audited modification effective on the first day of a month. term_change, payment_change and partial_termination remeasure the liability at the revised discount_rate (required) as the PV of the revised remaining payments, adjust the ROU asset, recognize a gain or loss on a partial termination (f x ROU vs f x liability) or on a decrease beyond the ROU carrying amount, post one noncash entry on the effective date, and re-run the schedule from that month (earlier months unchanged: a new schedule version). separate_contract records the added right of use as a new lease (separate_lease) and leaves this one unchanged. Refused for a voided (409) or short-term lease, out of order, or while lease lines are posted on or after the effective date (422). preview: true returns the remeasurement, entry lines and revised schedule without posting (200). Lease terms themselves are locked: this is the only way to change them. Needs post_journal (preview: view). Audited. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"modification\": {\n    \"effective_date\": \"2026-01-31\",\n    \"kind\": \"term_change\",\n    \"reason\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"5c2ba953-e4ae-496f-8a78-0de7332126b2","name":"voidCompanyAccountingLease — Void a lease","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/leases/:id/void","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","leases",":id","void"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Void a lease\n\nFor a lease entered by mistake: reverses its commencement entry and posts one entry negating every other line the lease carries, on `date`. Runs, the daily job and the disclosures skip a voided lease. Idempotent for the same date and reason. Needs post_journal. Audited. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"void\": {\n    \"date\": \"2026-01-31\",\n    \"reason\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"74bb80df-63cb-44cf-88b9-2bc2f5e2bc04","name":"listCompanyAccountingLifecycleExports — Latest 50 full export requests; accounting:read and unrestricted owner plus step-up","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/lifecycle/exports","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","lifecycle","exports"],"variable":[{"key":"company_id","value":"{{companyId}}"}]},"description":"Latest 50 full export requests; accounting:read and unrestricted owner plus step-up\n\nList is capped to the latest 50 requests; extract contents have no row cap."}},{"id":"59f0daed-a123-4d2b-8e6e-4bda39ffcf58","name":"createCompanyAccountingLifecycleExport — Queue full extract; accounting:write and unrestricted owner plus step-up","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/lifecycle/exports","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","lifecycle","exports"],"variable":[{"key":"company_id","value":"{{companyId}}"}]},"description":"Queue full extract; accounting:write and unrestricted owner plus step-up\n\nSupports Idempotency-Key; retries with the same key replay the original result."}},{"id":"af88130a-2252-4ad6-8736-2aad967177b5","name":"getCompanyAccountingLifecycleExport — Export status, checksummed manifest and user-bound 15-minute download link","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/lifecycle/exports/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","lifecycle","exports",":id"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Export status, checksummed manifest and user-bound 15-minute download link\n\nRequires accounting:read token scope."}},{"id":"09fb2487-1008-4d2b-8bc8-86175a4f5878","name":"listCompanyAccountingLifecycleExportDownload — Stream signed ZIP64 archive; rechecks current owner access, MFA/step-up and authenticated recipient","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/lifecycle/exports/:id/download","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","lifecycle","exports",":id","download"],"query":[{"key":"expires","value":"","disabled":false},{"key":"signature","value":"","disabled":false}],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Stream signed ZIP64 archive; rechecks current owner access, MFA/step-up and authenticated recipient\n\nRequires accounting:read token scope."}},{"id":"d8180796-55f1-4d31-8b52-eb3b93b77525","name":"createCompanyAccountingLifecycleHold — Record an outstanding filing or legal hold for employee/vendor","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/lifecycle/holds","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","lifecycle","holds"],"variable":[{"key":"company_id","value":"{{companyId}}"}]},"description":"Record an outstanding filing or legal hold for employee/vendor\n\nRequires accounting:write token scope. Supports Idempotency-Key; retries with the same key replay the original result.","body":{"mode":"raw","raw":"{\n  \"retention_hold\": {\n    \"reason\": \"\",\n    \"subject_id\": 0,\n    \"subject_type\": \"employee\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"ffea4058-8d54-4622-8e30-b13e0f36595d","name":"deleteCompanyAccountingLifecycleHold — Release an explicit retention hold with owner step-up","request":{"method":"DELETE","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/lifecycle/holds/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","lifecycle","holds",":id"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Release an explicit retention hold with owner step-up\n\nRequires accounting:write token scope."}},{"id":"7eb5590b-2105-45ab-81b8-aed354e7594f","name":"listCompanyAccountingLifecycleOffboarding — Super-admin retrieves retained offboarding certificate","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/lifecycle/offboarding","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","lifecycle","offboarding"],"variable":[{"key":"company_id","value":"{{companyId}}"}]},"description":"Super-admin retrieves retained offboarding certificate\n\nRequires accounting:read token scope."}},{"id":"3d137203-46db-406f-87dc-1f8f78c2da89","name":"createCompanyAccountingLifecycleOffboarding — Super-admin irreversibly deletes tenant accounting after durable/fresh export verification","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/lifecycle/offboarding","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","lifecycle","offboarding"],"variable":[{"key":"company_id","value":"{{companyId}}"}]},"description":"Super-admin irreversibly deletes tenant accounting after durable/fresh export verification\n\nRequires accounting:write token scope.","body":{"mode":"raw","raw":"{\n  \"offboarding\": {\n    \"acknowledge_irreversible\": null,\n    \"confirm\": \"\",\n    \"export_id\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"87e1d3ba-9b2d-48d1-88f1-1e277472b449","name":"listCompanyAccountingLifecycleRetention — Explicit policy or disabled defaults","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/lifecycle/retention","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","lifecycle","retention"],"variable":[{"key":"company_id","value":"{{companyId}}"}]},"description":"Explicit policy or disabled defaults\n\nThe approved employee SSN (employee_days) and vendor TIN (vendor_days) retention periods from the retention register (null when none is approved) and the company legal hold flag. Requires accounting:read."}},{"id":"e1311328-8d84-4ca5-8c5f-4d6e8a50abef","name":"replaceCompanyAccountingLifecycleRetention — Set the company legal hold flag; request subject retention periods through the register","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/lifecycle/retention","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","lifecycle","retention"],"variable":[{"key":"company_id","value":"{{companyId}}"}]},"description":"Set the company legal hold flag; request subject retention periods through the register\n\nlegal_hold applies at once (a company-wide hold blocks every retention purge). A non-null employee_days or vendor_days different from the approved period files maker-checker change requests in the retention register (employee_ssn and employee_bank, or vendor_tin and vendor_bank) that another unrestricted owner must approve; a period below a class's hard floor (1461 days for SSN/TIN, 730 for bank details) is 422. Unrestricted owner, view_payroll_pii and step-up. Requires accounting:write.","body":{"mode":"raw","raw":"{\n  \"retention_policy\": {\n    \"employee_days\": 0,\n    \"legal_hold\": false,\n    \"reason\": \"\",\n    \"vendor_days\": 0\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"c1e78c63-6888-4119-8465-54153015b955","name":"listCompanyAccountingPartyProfiles — List party profiles","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/party_profiles","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","party_profiles"],"query":[{"key":"filters[role]","value":"","disabled":true,"description":"Vendors or customers"},{"key":"search","value":"","disabled":true,"description":"Vendor name"},{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true},{"key":"updated_since","value":"","disabled":true,"description":"Delta sync: only rows created or changed at or after this time (ISO 8601 with offset). Switches the list to ascending (updated_at, id) order; page is ignored and Next-Cursor continues it. Re-read with a small overlap (a few seconds) and dedupe by id."},{"key":"cursor","value":"","disabled":true,"description":"Opaque keyset cursor from a previous response's Next-Cursor header; each page costs the same however deep it is."}],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"List party profiles\n\nAccounting profiles of company vendors and customers: 1099 settings, W-9 status, terms, remit-to, payment method, retainage, compliance hold and credit limit. Tax ids and bank numbers are always masked. Filter with `filters[role]` (vendor or customer) or `search` by vendor name. Delta sync: updated_since and/or cursor return changes in ascending (updated_at, id) order with Next-Cursor. Requires the accounting:read scope. Entity-wide: a project-scoped (project_manager_view) grant gets 403."}},{"id":"23632040-9c92-4534-8823-4e347a93b9b1","name":"createCompanyAccountingPartyProfile — Create a party profile","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/party_profiles","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","party_profiles"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Create a party profile\n\nCreates a party profile. Changed W-9 status/date, tax classification, 1099 flag/form/box and clearing a compliance hold need (ap_approve AND release_payments) OR manage_vendor_banking, including configured MFA checks. Unchanged fields and safe create defaults need no sensitive permission. AR-only users may edit customer role, billing/contact, credit limit and terms, never vendor-only fields. Customer-only creates must explicitly set is_vendor=false (the server default is true). Bank account ownership still needs manage_vendor_banking. Remit-to and payment_method changes, including non-default create values, require a reason and step-up and become pending_sensitive_change alongside bank/TIN proposals. Effective routing stays unchanged until a different manage_vendor_banking user approves the reviewed change_hash. Any new proposal replaces the entire pending change; stale hashes and self-approval are refused. Approval arms the existing non-overridable payment cool-off. Authorization and step-up run before Idempotency-Key replay as well as inside the mutation. Requires accounting:write.","body":{"mode":"raw","raw":"{\n  \"party_profile\": {\n    \"vendor_id\": 0\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"b721bafb-16ff-4fd3-8c26-976fa4ecb234","name":"getCompanyAccountingPartyProfile — Show a party profile","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/party_profiles/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","party_profiles",":id"],"query":[{"key":"reveal","value":"","disabled":true,"description":"Decrypt TIN and bank numbers"}],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Show a party profile\n\nOne profile with masked tax id and bank account. `reveal=true` adds the decrypted values; it needs the accounting:write scope and manage_vendor_banking, writes an audit record, counts toward the per-user export limit (429), and is never cached. Requires the accounting:read scope (accounting:write with reveal=true). Entity-wide: a project-scoped (project_manager_view) grant gets 403."}},{"id":"58fde09e-a647-4c63-80a6-039f1bc7f60b","name":"updateCompanyAccountingPartyProfile — Update a party profile","request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/party_profiles/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","party_profiles",":id"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Update a party profile\n\nUpdates changed profile fields. Changed W-9 status/date, tax classification, 1099 flag/form/box and clearing a compliance hold need (ap_approve AND release_payments) OR manage_vendor_banking, including configured MFA checks. Unchanged fields and safe create defaults need no sensitive permission. AR-only users may edit customer role, billing/contact, credit limit and terms, never vendor-only fields. Customer-only creates must explicitly set is_vendor=false (the server default is true). Bank account ownership still needs manage_vendor_banking. Remit-to and payment_method changes, including non-default create values, require a reason and step-up and become pending_sensitive_change alongside bank/TIN proposals. Effective routing stays unchanged until a different manage_vendor_banking user approves the reviewed change_hash. Any new proposal replaces the entire pending change; stale hashes and self-approval are refused. Approval arms the existing non-overridable payment cool-off. Ordinary edits need ap_enter, ar_enter or manage_vendor_banking. Requires accounting:write.","body":{"mode":"raw","raw":"{\n  \"party_profile\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"231ec070-b111-425e-8801-c8f6e5387060","name":"sensitiveChangeCompanyAccountingPartyProfile — Approve or reject a routing/bank/TIN change","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/party_profiles/:id/sensitive_change","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","party_profiles",":id","sensitive_change"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Approve or reject a routing/bank/TIN change\n\nApplies (`approve`) or discards (`reject`) the pending remit-to, payment method, tax id and bank change. Send the `change_hash` from the profile's `pending_sensitive_change` you reviewed: if the change was replaced since (any new request replaces it and gets a new hash), the decision is refused with 409 stale_change. A legacy pending change without reviewable values can only be rejected (409 unreviewable_change). The requester cannot decide their own change. Needs manage_vendor_banking. Requires the accounting:write scope. Step-up is required. Routing before/after and the request reason are shown in pending_sensitive_change; approval starts the non-overridable payment cool-off.","body":{"mode":"raw","raw":"{\n  \"change_hash\": \"\",\n  \"decision\": \"approve\"\n}","options":{"raw":{"language":"json"}}}}},{"id":"e0766663-9763-4dda-83d3-9a718c2976f5","name":"createCompanyAccountingPayrollAccrual — Post the month-end payroll accrual","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/payroll/accrual","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","payroll","accrual"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Post the month-end payroll accrual\n\n{ month: YYYY-MM }: approved timecards dated in the month that no posted run has paid, at each hourly employee's rate: Dr job labor by job (with hours) / Cr accrued wages (2150 → 2315) on the month's last day, auto-reversing on the 1st. 201 with the entry, 200 with journal_entry_id null when nothing is unpaid, 409 when the month is already accrued; an accrual reversed on its own date (a correction) no longer counts, so the month can be re-run as a new revision. Employer-wide: needs payroll_run on all entities. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"month\": \"\"\n}","options":{"raw":{"language":"json"}}}}},{"id":"585c10e1-8c6c-43fe-82c6-79ae955a7ed0","name":"createCompanyAccountingPayrollBurdenTrueUp — Post the standard-rate burden true-up","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/payroll/burden_true_up","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","payroll","burden_true_up"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Post the standard-rate burden true-up\n\n{ month: YYYY-MM }: clears the month's Burden Applied balance to the jobs it was applied to (pro rata) or to overhead. Each entity's Burden Applied clears in that entity: one entry per entity with a balance (a pay group posts to its own entity). The job split is net of payroll run reversals and single-check voids posted in the month, so a voided run's or check's job gets no share; a check voided this month from an earlier month's run clears its own residue to that check's jobs (or overhead). 422 when the month holds a reversal of an earlier month's payroll run and that earlier month was already trued up (reconcile the job allocation manually), or when a payroll run in the month was reversed after the month's true-up was posted (reverse that true-up and re-run). Reversed true-ups never block. 201 with the entries (journal_entries lists each with its entity_id; the deprecated journal_entry_id / journal_entry_number name only the first), or 200 with journal_entry_id null when the balance is zero. Needs payroll_run. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"month\": \"\"\n}","options":{"raw":{"language":"json"}}}}},{"id":"17565ddf-45d4-4b1b-85ad-5d2b56ff9dec","name":"listCompanyAccountingPayrollCertifiedPayroll — Certified payroll (WH-347)","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/payroll/certified_payroll","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","payroll","certified_payroll"],"query":[{"key":"project_id","value":"","disabled":true,"description":"Project with a wage determination"},{"key":"week_ending","value":"","disabled":true,"description":"YYYY-MM-DD"},{"key":"format","value":"","disabled":true,"description":"Output"},{"key":"pwcr","value":"","disabled":true,"description":"format=ecpr_v2: the contractor's 10-digit DIR public works registration"},{"key":"prc_number","value":"","disabled":true,"description":"format=ny_xml: the project's 10-character NYS DOL Prevailing Rate Case number"}],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Certified payroll (WH-347)\n\nWithout project_id: prevailing-wage projects and the weeks that need reports. With project_id and week_ending: the WH-347 dataset (json; column 1E is the last four SSN digits), csv, pdf, or the CA DIR eCPR XML (ecpr: V1 layout, accepted by DIR until 2027-01-13; ecpr_v2: XML Schema V2.0 with pwcr=<10-digit DIR registration>; ny_xml: NYS DOL certified payroll XML with prc_number=<10-character PRC>; ecpr and ecpr_v2 carry the full SSN and ny_xml the home address: all need the accounting:write scope and view_payroll_pii, audited, per-user export limit). A week with no work returns the statement of no work performed. Covers every entity: an entity-scoped grant gets 403. Requires the accounting:read scope (accounting:write for ecpr)."}},{"id":"d1dd8ce6-9d57-47d0-831d-aaccbf91626e","name":"reissueCompanyAccountingPayrollCheck — Reissue a printed paper check under a new number","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/payroll/checks/:id/reissue","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","payroll","checks",":id","reissue"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Reissue a printed paper check under a new number\n\nFor a lost or damaged paper check of an approved or posted run: the old number is voided in the bank account's shared check register (positive pay sends the void) and the same net pay takes the next number on that account, issued on `date` (default today). No journal entry, wage or tax effect: the run's cash line for the check stays outstanding until the new check clears. A voided check or a direct deposit is refused (422); a check whose cash line cleared the bank returns 409. Requires the accounting:write scope and release_payments.","body":{"mode":"raw","raw":"{\n  \"date\": \"2026-01-31\",\n  \"reason\": \"\"\n}","options":{"raw":{"language":"json"}}}}},{"id":"2a702ecb-6a83-4cc5-865f-65f6c6c2f2b6","name":"voidCompanyAccountingPayrollCheck — Void one check of a posted run","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/payroll/checks/:id/void","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","payroll","checks",":id","void"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Void one check of a posted run\n\nReverses only this check's journal lines and job cost hours (source payroll_check_void), dated `date` (default today, never before the pay date or in a filed quarter). The voider did not prepare, edit or calculate the run. A direct deposit whose NACHA file exists needs confirm_paid. A paper check whose cash line cleared the bank (bank-matched, or cleared or reconciled in a reconciliation) returns 409. Standard-rate burden is reversed at the rate and per-check share captured at approval, not the current setup. Payroll reports keep the check on its pay date and add a negative row on the void date. `reissue` creates a correction run (draft) with the check's time and earnings, paid on reissue_pay_date. A run with a voided check can no longer be voided whole. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"confirm_paid\": false,\n  \"date\": \"2026-01-31\",\n  \"reason\": \"\",\n  \"reissue\": false,\n  \"reissue_pay_date\": \"2026-01-31\"\n}","options":{"raw":{"language":"json"}}}}},{"id":"84451d31-5b65-429f-836c-cf11f33e7ac1","name":"listCompanyAccountingPayrollCodes — List payroll codes","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/payroll/codes","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","payroll","codes"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"List payroll codes\n\nEarning, deduction, benefit and employer-tax codes. Needs payroll_view. Requires the accounting:read scope."}},{"id":"e78ee029-2e04-4c17-832e-cddfcb749a6a","name":"createCompanyAccountingPayrollCode — Create a code","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/payroll/codes","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","payroll","codes"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Create a code\n\nNeeds payroll_run; audited. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"code\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"6abce5d2-9041-4f2a-8802-06f08306134d","name":"listCompanyAccountingPayrollEmployees — List employees","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/payroll/employees","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","payroll","employees"],"query":[{"key":"page","value":"1","disabled":true,"description":"Page (1-based)"},{"key":"per_page","value":"100","disabled":true,"description":"Page size (max 1000)"},{"key":"search","value":"","disabled":true,"description":"Name or number"}],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"List employees\n\nPII masked (***-**-1234, ****6789). Filters: filters[status], filters[pay_group_id], search. Needs payroll_view. Requires the accounting:read scope."}},{"id":"1d705048-571c-4a70-8d06-780ddc8ecf5c","name":"createCompanyAccountingPayrollEmployee — Create an employee","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/payroll/employees","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","payroll","employees"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Create an employee\n\nssn, bank_routing_number and bank_account_number are write-only: encrypted at rest (AES-256-GCM), never returned. Audit rows carry field names only. Needs payroll_run. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"employee\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"0dd2d998-fbec-4cf2-8fdd-8bcc799aea89","name":"getCompanyAccountingPayrollEmployee — Show an employee","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/payroll/employees/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","payroll","employees",":id"],"query":[{"key":"reveal","value":"","disabled":true,"description":"Decrypt PII (view_payroll_pii; audited)"}],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Show an employee\n\nWith deductions. Deprecated `?reveal=true` (use POST employees/{id}/reveal, which takes a reason and keeps the request out of URLs and access logs) adds the decrypted SSN and bank numbers: needs the accounting:write scope and view_payroll_pii, writes an audit entry (the app's reveal is a POST server action with a required reason, stored in the audit event; it is never a URL parameter), and counts toward the per-user export limit (429). Employees outside the grant's entities (by pay group posting entity) are 404. Requires the accounting:read scope (accounting:write with reveal=true)."}},{"id":"2bf6ae0b-a7cc-41a1-85bc-c5fd90b54cf5","name":"updateCompanyAccountingPayrollEmployee — Update an employee","request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/payroll/employees/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","payroll","employees",":id"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Update an employee\n\nPartial update; rate changes are audited as rate_changed. Needs payroll_run. Requires the accounting:write scope. Pay-rate fields (pay_type, hourly_rate, salary_per_period, classification, union_local_id, plan_credit_per_hour) are not applied: they become a pending rate change (pending_rate_change_id) that a different user approves. Bank fields (bank_routing_number, bank_account_number, bank_account_type) likewise become a pending bank change (pending_bank_change_id).","body":{"mode":"raw","raw":"{\n  \"employee\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"c67691f3-f4bc-43f8-873e-38fa54357c30","name":"createCompanyAccountingPayrollEmployeeDeduction — Add a deduction, match or garnishment","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/payroll/employees/:id/deductions","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","payroll","employees",":id","deductions"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Add a deduction, match or garnishment\n\nkind deduction (pretax_401k, roth_401k, section125, hsa, post_tax, union_dues), garnishment (child_support, federal_tax_levy, state_tax_levy, bankruptcy, student_loan, creditor) or match (params.tiers). Needs payroll_run. One active row per code across every kind (a match cannot share a deduction's code, so use e.g. 401K and 401K_MATCH): a second active row with the same code is 409 (end the first). Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"deduction\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"89cdda3d-5648-4631-8f4a-28859c46d408","name":"deleteCompanyAccountingPayrollEmployeeDeduction — End a deduction","request":{"method":"DELETE","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/payroll/employees/:id/deductions/:deduction_id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","payroll","employees",":id","deductions",":deduction_id"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""},{"key":"deduction_id","value":""}]},"description":"End a deduction\n\nMarks it inactive (kept for history). Needs payroll_run. Requires the accounting:write scope."}},{"id":"7528e3fd-a5d5-4141-8e48-51e5aa88dda3","name":"revealCompanyAccountingPayrollEmployee — Reveal an employee SSN and bank numbers","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/payroll/employees/:id/reveal","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","payroll","employees",":id","reveal"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Reveal an employee SSN and bank numbers\n\n{ reason }: the employee with the decrypted SSN and bank numbers (revealed). Needs the accounting:write scope and view_payroll_pii; writes a pii_revealed audit entry with the reason; counts toward the per-user export limit (429). Cache-Control: no-store. Employees outside the grant entities are 404. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"reason\": \"\"\n}","options":{"raw":{"language":"json"}}}}},{"id":"55ef3edf-f7e4-4904-8886-05aea18ccb41","name":"listCompanyAccountingPayrollEmployers — List payroll employer entities","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/payroll/employers","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","payroll","employers"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"List payroll employer entities\n\nEntities with their own EIN that employ: state withholding / UI account numbers and the ACH origin (account masked). Checks of a pay group whose posting entity has an EIN other than payroll setup's carry that entity as employer_entity_id. Requires the accounting:read scope."}},{"id":"a5c1ee84-95bb-4f03-8b14-fb644d76bda9","name":"replaceCompanyAccountingPayrollEmployer — Set an employer entity's payroll identity","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/payroll/employers/:entity_id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","payroll","employers",":entity_id"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"entity_id","value":""}]},"description":"Set an employer entity's payroll identity\n\nUpsert state_account_ids, ach_odfi_routing, ach_bank_name and ach_account_number (write-only, encrypted) for an entity with an EIN. Employer-wide: needs payroll_run on all entities. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"employer\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"9f33f34b-8e0b-4c40-8150-7aace2010cc7","name":"createCompanyAccountingPayrollFiling — Mark a payroll return period filed","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/payroll/filings","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","payroll","filings"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Mark a payroll return period filed\n\n{ period: \"2026-Q1\" (941) | \"2026-Q1-UI\" (state UI report) | \"2026\" (W-2 / 940), filed?: true }. A void of posted payroll may not be dated into a filed period (409); voiding payroll paid in a filed quarter or year records an amended_return_required audit event (Form 941-X / W-2c) and form_941 lists corrections_required. filed=false reopens the period and also needs close_period (a payroll runner alone cannot reopen a filed return). Needs payroll_run for every entity. Audited. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"filed\": false,\n  \"period\": \"\"\n}","options":{"raw":{"language":"json"}}}}},{"id":"37ca0fea-9f1b-481e-801e-f2bfcc126345","name":"createCompanyAccountingPayrollFutaOverride — Request or approve a provisional FUTA credit reduction override","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/payroll/futa_override","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","payroll","futa_override"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Request or approve a provisional FUTA credit reduction override\n\nWhile the year's FUTA credit reduction is DOL's provisional list (final after November 10), Form 940 returns 422 \"credit reduction provisional\". { action: \"request\", year, reason } by one payroll runner, then { action: \"approve\", year } by a different one (403 for the requester). A new request replaces the old one; a change to the provisional rates voids the approval. 422 when the year is not provisional. Audited. Needs payroll_run. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"action\": \"request\",\n  \"reason\": \"\",\n  \"year\": 0\n}","options":{"raw":{"language":"json"}}}}},{"id":"807adb6f-ddf7-4712-898c-b5bc7fc356e7","name":"createCompanyAccountingPayrollManualCheck — Enter a manual (handwritten) check","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/payroll/manual_checks","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","payroll","manual_checks"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Enter a manual (handwritten) check\n\nGross, taxes and deductions as written become a one-check run of run_type manual, status calculated. Net = gross − employee taxes − deductions (a given net must match). A second person approves it and it posts like any run; it is never recalculated (calculate returns 422). Its accounts are the payroll account map's job labor (5000), overhead labor (6000) and net pay (1010) keys, as for any run. check_number requires bank_account_id: the check is entered in that account's shared check register (positive pay sends it), the account must be the checking account on the net pay GL account, and a number already used on the account returns 409. Idempotent on request_key or the Idempotency-Key header (one run and one check per key). Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"manual_check\": {\n    \"employee_id\": 0,\n    \"gross\": \"\",\n    \"pay_date\": \"2026-01-31\",\n    \"pay_group_id\": 0\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"e59b4f03-9616-4842-8359-23c42bde71a0","name":"listCompanyAccountingPayrollPayGroups — List pay groups","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/payroll/pay_groups","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","payroll","pay_groups"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"List pay groups\n\nPay groups with frequency and overtime rule set (FLSA, CA, AK, NV, CO). Needs payroll_view. Requires the accounting:read scope."}},{"id":"a18c7950-c79d-44be-8f90-73df092a42fb","name":"createCompanyAccountingPayrollPayGroup — Create a pay group","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/payroll/pay_groups","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","payroll","pay_groups"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Create a pay group\n\nNeeds payroll_run; audited. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"pay_group\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"0f2e98d6-e550-446f-8f84-ce5aa5bc1e22","name":"updateCompanyAccountingPayrollPayGroup — Update a pay group","request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/payroll/pay_groups/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","payroll","pay_groups",":id"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Update a pay group\n\nName, frequency, OT rule set, OT method (weighted_average | rate_in_effect) or is_active. Needs payroll_run; audited. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"pay_group\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"8a2a7529-99a7-466f-8adf-0e98ddc64935","name":"createCompanyAccountingPayrollPiiRotation — Rotate payroll PII encryption","request":{"method":"POST","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/payroll/pii_rotation","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","payroll","pii_rotation"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Rotate payroll PII encryption\n\nRe-encrypts SSNs, employee and pending bank numbers and the ACH account still under an older key version (or the legacy format) with the current key, bound to its row (company, employee, field). Refused (409) while any run is approved. Returns counts only. Needs payroll_run + view_payroll_pii; audited. Requires the accounting:write scope. Also rewrites decided bank-change rows, employer-entity ACH accounts (AcctPayrollEmployer), employee ACH prenote records and employee NOC corrections. `remaining` counts the company's rows, vendor and banking included, still holding a value under an older key id or the legacy format: drop an old key id only once it is 0."}},{"id":"3f2f0882-eb53-4847-83fd-2ecf6c68bcc5","name":"listCompanyAccountingPayrollRateChanges — List pay-rate changes","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/payroll/rate_changes","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","payroll","rate_changes"],"query":[{"key":"employee_id","value":"","disabled":true},{"key":"status","value":"","disabled":true},{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true}],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"List pay-rate changes\n\nNewest first. Paginated (page/per_page; Total and Link headers). Requested by one person, approved or rejected by another (SoD). Filters: employee_id, status. Needs payroll_view. Requires the accounting:read scope."}},{"id":"35d6fa4e-f797-487e-87f8-4e40c32b99c9","name":"createCompanyAccountingPayrollRateChange — Approve or reject a pay-rate change","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/payroll/rate_changes/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","payroll","rate_changes",":id"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Approve or reject a pay-rate change\n\n{ approve, reason }. Approving applies the rates. 403 when the approver requested the change or prepared an open run for the employee's pay group. Needs payroll_run; audited. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"approve\": false,\n  \"reason\": \"\"\n}","options":{"raw":{"language":"json"}}}}},{"id":"dfe13ba8-35f5-4acf-8104-545b4d091cca","name":"listCompanyAccountingPayrollRemittances — List payroll liability remittances","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/payroll/remittances","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","payroll","remittances"],"query":[{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true}],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"List payroll liability remittances\n\nNewest first. Paginated (page/per_page; Total and Link headers). Needs payroll_view. Requires the accounting:read scope."}},{"id":"ab4f9495-ceda-46dc-85cc-a67638e1dacb","name":"createCompanyAccountingPayrollRemittance — Remit a payroll liability","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/payroll/remittances","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","payroll","remittances"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Remit a payroll liability\n\n{ remittance: { request_key, account_key, amount, through_date, paid_date, method: bank | ap_bill, bank_account_id (bank) | vendor_id (ap_bill), entity_id?, memo } }. entity_id defaults to the bank account's entity, else the company default; the liability is cleared, and the open balance checked, in that entity (the actor needs access to it; a bank account of another entity is 422). bank moves cash: it needs release_payments (403 without it) and posts Dr liability / Cr the bank's GL account (shown in the bank register), or, at or above the journal approval threshold (settings require_approval_above), is saved as status pending_approval with no journal until a different user releases it (POST remittances/{id}/approve); ap_bill drafts an AP bill coded to the liability. The amount may not exceed the open balance through through_date less unposted remittance bills and pending bank remittances (422). Idempotent on request_key (a replay returns the first remittance; a different body with the same key is 409). Needs payroll_run; audited. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"remittance\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"bc9eed0b-d95e-415f-8dec-77496171cd95","name":"createCompanyAccountingPayrollRemittancePost — Release or reject a pending bank remittance","request":{"method":"POST","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/payroll/remittances/:id/:decision","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","payroll","remittances",":id",":decision"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""},{"key":"decision","value":""}]},"description":"Release or reject a pending bank remittance\n\napprove posts the bank remittance journal (Dr liability / Cr bank GL), dated its paid date; reject leaves it rejected with no journal. Needs payroll_run and release_payments; the creator cannot approve their own remittance (403). Only pending_approval remittances (409 otherwise). Audited. Requires the accounting:write scope."}},{"id":"220c5091-cd0b-45b1-808e-5765cbff5eb6","name":"getCompanyAccountingPayrollReport — Payroll tax and remittance data","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/payroll/reports/:report","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","payroll","reports",":report"],"query":[{"key":"year","value":"","disabled":true,"description":"Tax year"},{"key":"quarter","value":"","disabled":true,"description":"1-4"},{"key":"month","value":"","disabled":true,"description":"YYYY-MM"},{"key":"format","value":"","disabled":true,"description":"w2: json | efw2 | pdf; state_ui: json | csv; union_local_remittance: json | csv"},{"key":"local","value":"","disabled":true,"description":"union_local_remittance: one remit-to local code"},{"key":"bso_user_id","value":"","disabled":true,"description":"Required for efw2: attesting BSO user ID"},{"key":"contact_name","value":"","disabled":true,"description":"Required for efw2"},{"key":"contact_phone","value":"","disabled":true,"description":"Required for efw2: ten-digit domestic telephone (formatting allowed)"},{"key":"contact_email","value":"","disabled":true,"description":"Required for efw2: printable ASCII email"},{"key":"state","value":"","disabled":true,"description":"state_ui: two-letter state"},{"key":"employer_entity_id","value":"","disabled":true,"description":"form_941, form_940, deposit_calendar, w3, state_ui: the employer (EIN) to file for. 0 = the company employer in payroll setup, an entity id = that entity. Omitted: the only employer that paid in the period (422 when several did). W-2 rows carry employer_entity_id: an employee paid by two EINs gets two W-2s."}],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"report","value":""}]},"description":"Payroll tax and remittance data\n\nFrom posted runs. form_941 (year, quarter), form_940 (year; credit_reduction {provisional, rates, override} with Schedule A from the year's FUTA credit reduction list; 422 \"credit reduction provisional\" while DOL's list is provisional and wages fall in a listed state, until an approved futa_override; 422 when no list is loaded for the year and wages fall in a state on any loaded list), w2 (year; format=efw2 supports domestic tax years 2024-2026 and needs the accounting:write scope and view_payroll_pii, audited; BSO/contact inputs required; provisional requests rejected; incomplete or unsupported populated payroll source fields return 422), union_remittance (month YYYY-MM: per fund, remit-to local, employees with hours and amounts; hours and gross are the CBA rate group's), union_local_remittance (month YYYY-MM, optional local; format=json|csv: one report per remit-to local with each employee's hours, gross, employer fringe by fund, dues actually withheld and the amount to remit, plus a reconciliation of the month's fringe (engine key 2120) and dues (2124) to the payroll journal and the GL accounts they map to: report vs engine and engine vs GL payroll postings must both be 0.00 for an account to tie; opening, other activity (remittances) and closing balances), state_ui (year, quarter; rows carry employee_tax: NJ/PA/AK employee unemployment withheld; the csv adds an employee_sui column). Requires the accounting:read scope. deposit_calendar (year, quarter): each liability date's 941 deposit due date under the monthly or semiweekly schedule (next-day for $100k). w2 format=pdf: employee W-2 copies (view_payroll_pii, audited). w3 (year): W-3 transmittal totals. w2 and w3 boxes include W (box 12 code W: HSA contributions through the cafeteria plan). state_ui accepts state=XX; format=csv returns the state SUI wage file (accounting:write scope and view_payroll_pii, audited). Tax filings cover every entity of the employer: an entity-scoped grant gets 403. EFW2 and the SUI file count toward the per-user export limit (429). form_941 also returns filed (the quarter is marked filed) and corrections_required ([{ run, voided_on, form: 941-X }]: posted payroll of the filed quarter voided after it ended). Reports use effective dates: a run voided after posting stays in its pay-date period, and its void adds negative rows on the void (reversal) date. deposit_calendar counts only posted (paid) remittances toward remitted; a deposit period whose net liability is negative (a void) has amount 0.00 and the rest as credit. w2 rows carry correction_required: \"W-2c\" when a void of prior-year pay leaves a box negative (left out of EFW2, W-3 and the PDF); state_ui rows carry correction_required: \"amended_report\" likewise (left out of the SUI file). form_940 caps FUTA wages on cumulative wages, so a void gives back only the wages it had made taxable."}},{"id":"b2cca9a0-86bf-4bae-844d-b17aa9e975ee","name":"listCompanyAccountingPayrollRuns — List pay runs","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/payroll/runs","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","payroll","runs"],"query":[{"key":"page","value":"1","disabled":true,"description":"Page (1-based)"},{"key":"per_page","value":"100","disabled":true,"description":"Page size (max 1000)"}],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"List pay runs\n\nNewest pay date first. Filters: filters[status], filters[pay_group_id]. Needs payroll_view. Requires the accounting:read scope."}},{"id":"786c7752-9d50-4140-8611-62a35dbec9c3","name":"createCompanyAccountingPayrollRun — Create a pay run","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/payroll/runs","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","payroll","runs"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Create a pay run\n\npay_group_id, period_start, period_end, pay_date. Refuses a period that overlaps another open run of the group. Imports approved timecards unless import_time is false. Needs payroll_run. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"pay_run\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"9a15f34b-9dfa-44f2-814d-7811c33e82dd","name":"getCompanyAccountingPayrollRun — Show a pay run","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/payroll/runs/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","payroll","runs",":id"],"query":[{"key":"explain","value":"","disabled":true,"description":"Include calculation traces"}],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Show a pay run\n\nChecks (PII masked) with taxes and deductions, and time lines. `?explain=true` adds each check's calculation trace. Requires the accounting:read scope."}},{"id":"bce69253-e8a4-4e83-8087-a66add50172b","name":"getCompanyAccountingPayrollRunGet — Pay run outputs","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/payroll/runs/:id/:action","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","payroll","runs",":id",":action"],"query":[{"key":"format","value":"","disabled":true,"description":"register: csv"}],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""},{"key":"action","value":"","description":"GET: preview | register | nacha. POST: nacha | import_time | time | earnings | calculate | acknowledge | override | approve | post | void | print_checks | nacha_resend."}]},"description":"Pay run outputs\n\npreview: the payroll journal entry and the labor/burden job cost lines it will post. register: per-check register (JSON, or CSV with format=csv). nacha: the PPD direct deposit file (payroll_run + view_payroll_pii; audited; approved or posted runs). The file is never stored; each generation is recorded (file id modifier, sha256, entries, total, generated by). It is generated once (file id modifier A): a second GET is 409; re-send with POST nacha_resend. Response headers: X-Ach-File-Id-Modifier, and X-Ach-Warning when the effective entry date (pay date) is fewer than 2 banking days away. preview and register require the accounting:read scope; nacha (the direct deposit file) requires the accounting:write scope. Payroll resends require previous_file_id_modifier from the run detail last_ach_file_id_modifier. Missing acknowledgement is 422; stale or replayed acknowledgement is 409 with no new file. Confirm bank non-processing before refreshing and requesting another distinct resend."}},{"id":"d6a44157-1c3f-4c9f-8849-f63200335415","name":"createCompanyAccountingPayrollRunPost — Pay run workflow step","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/payroll/runs/:id/:action","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","payroll","runs",":id",":action"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""},{"key":"action","value":"","description":"GET: preview | register | nacha. POST: nacha | import_time | time | earnings | calculate | acknowledge | override | approve | post | void | print_checks | nacha_resend."}]},"description":"Pay run workflow step\n\nimport_time: approved TimecardEntry rows of the group's linked users in the period (each imported once; they become completed when the run posts). time: { time: [...] } hand-entered lines. calculate: gross-to-net for every employee with time or a salary (replaces prior checks, bumps the revision). acknowledge: { key, reason } for a warning. approve: a different person than the preparer; errors block, warnings must be acknowledged; 422 when a check already in a bank's register (a manual check) is on a bank whose GL is not the net pay account (map key 1010). post: one PR journal entry (sourceType payroll_run) with labor and burden job cost; timecards → completed. void: { reason, date?, confirm_paid? } reverses a posted entry (dated today by default, never before the pay date) and reopens the timecards; a posted run is voided by someone other than its preparers, and an approved or posted run whose direct deposit file was generated needs confirm_paid: true (409 otherwise), and a bank-reconciled entry is refused (409). Needs payroll_run. Requires the accounting:write scope. override: { key, reason } clears an apprentice_over_ratio error (only when the over-ratio hours are already paid at least the journeyworker rate), a missing_suta_rate error or a local_tax_stub error; the person overriding must not be the run's preparer. approve refuses with 409 'Recalculate: YTD changed' when another run paying any of the same employees in the same tax year was approved after this run was calculated (its YTD wage bases are stale); recalculate and approve again. Checks localized to NJ, PA or AK withhold employee unemployment (tax code SUI, accrued to payroll key 2116); with no employee rate loaded for the pay date the check fails with calc_failed. Earnings coded to a project are taxed in the job site state and rated for workers comp there. Calculation raises sdi_rate_unconfirmed (error), one per payer side, when a work state's SDI/PFML program has no rate loaded or that side's rate depends on employer size and payroll setup has no confirmed rate for that side. earnings: { earnings: [{ employee_id, code_id, amount | hours (+ rate), project_id, cost_code_id, memo }] } replaces the run's extra earnings (bonus, PTO, holiday); each code's tax_treatment decides supplemental withholding. print_checks: { bank_account_id } numbers the run's paper checks from that checking account's shared check register (approved or posted runs; re-printing keeps the numbers; the bank account's GL must be the account the run credited for net pay, map key 1010, else 422 naming both) and returns { checks: [{ check_id, employee_id, employee_number, check_number, net, print }] }; needs release_payments. nacha: generates the direct deposit file the first time (422 when the payroll ACH origin routing/account differs from the numbered bank account on the run's net-pay GL; a warning when that GL has no numbered bank account) (same as GET nacha, which is kept for older clients; prefer POST so a retry or prefetch does not spend the one generation). nacha_resend: { resend: { reason, previous_file_id_modifier } } re-sends the direct deposit file with the next file id modifier (B, then C; at most 2 re-sends, then 409); needs payroll_run, view_payroll_pii and release_payments; returns the ACH file (text/plain) with the same headers as GET nacha; audited (nacha_resent, with the reason). Payroll resends require previous_file_id_modifier from the run detail last_ach_file_id_modifier. Missing acknowledgement is 422; stale or replayed acknowledgement is 409 with no new file. Confirm bank non-processing before refreshing and requesting another distinct resend.","body":{"mode":"raw","raw":"{\n  \"resend\": {\n    \"previous_file_id_modifier\": \"\",\n    \"reason\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"2c41c115-b9a8-408b-859b-62c9d5ed1cf6","name":"listCompanyAccountingPayrollSetup — Show payroll setup","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/payroll/setup","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","payroll","setup"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Show payroll setup\n\nTax engine (builtin or a registered provider adapter), burden method, SUTA, employer identity (EIN masked), ACH origin (account masked) and the payroll account map. Needs payroll_view. Requires the accounting:read scope."}},{"id":"cbf82a81-a428-4393-82d5-eb940fef03e5","name":"updateCompanyAccountingPayrollSetup — Update payroll setup","request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/payroll/setup","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","payroll","setup"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Update payroll setup\n\nPartial update; an unknown tax_provider is refused. The ACH account number is encrypted. Needs payroll_run; audited. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"payroll_setup\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"a8e07c5a-6c6c-4d67-8f87-9e1fd78ec822","name":"listCompanyAccountingPayrollUnionLocals — List union locals","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/payroll/union_locals","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","payroll","union_locals"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"List union locals\n\nLocals with their effective-dated CBA rates and benefit rules. Needs payroll_view. Requires the accounting:read scope."}},{"id":"c4b3146a-088c-4424-86a9-3e8105adb413","name":"createCompanyAccountingPayrollUnionLocal — Create a union local","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/payroll/union_locals","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","payroll","union_locals"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Create a union local\n\nNeeds payroll_run; audited. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"union_local\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"2762c35e-6a0b-4734-81f4-910bc564e635","name":"updateCompanyAccountingPayrollUnionLocal — Update a union local","request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/payroll/union_locals/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","payroll","union_locals",":id"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Update a union local\n\nName, remit_to, or cba_rules ({ day_multipliers: { \"0\"..\"6\": multiplier }, holidays: [date], holiday_multiplier }; null clears). Needs payroll_run; audited. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"union_local\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"2e31c733-8aa1-4a9f-8e05-744a24e63814","name":"createCompanyAccountingPayrollUnionRate — Add a CBA rate","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/payroll/union_rates","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","payroll","union_rates"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Add a CBA rate\n\nEffective-dated wage and benefit rules (per hour, % of gross, per day; employer fringe or employee deduction such as dues; reciprocity). Needs payroll_run. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"union_rate\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"dcadd3f9-0cf1-48ee-860a-170764c067be","name":"listCompanyAccountingPayrollWageDeterminations — List wage determinations","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/payroll/wage_determinations","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","payroll","wage_determinations"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"List wage determinations\n\nPrevailing wage BHR + fringe per project and classification, with the apprentice ratio. Needs payroll_view. Requires the accounting:read scope."}},{"id":"44359d3d-6024-4c83-8b28-5a9a4e9b2341","name":"createCompanyAccountingPayrollWageDetermination — Create a wage determination","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/payroll/wage_determinations","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","payroll","wage_determinations"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Create a wage determination\n\nNeeds payroll_run; audited. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"wage_determination\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"21f61a22-0d74-4633-8a48-c0bbaf871f60","name":"listCompanyAccountingPayrollWcClasses — List workers' comp classes","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/payroll/wc_classes","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","payroll","wc_classes"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"List workers' comp classes\n\nEffective-dated class rates per $100 (or per hour); OT premium excluded by default. Needs payroll_view. Requires the accounting:read scope."}},{"id":"faac538b-2b85-4085-8cc0-138f06910a8a","name":"createCompanyAccountingPayrollWcClass — Create a wc class","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/payroll/wc_classes","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","payroll","wc_classes"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Create a wc class\n\nNeeds payroll_run; audited. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"wc_class\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"b7edd1e7-a592-4d5b-8906-f6e4ae61727f","name":"listCompanyAccountingPeriods — List fiscal periods","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/periods","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","periods"],"query":[{"key":"filters[fiscal_year]","value":"","disabled":true,"description":"Fiscal year label"},{"key":"filters[status]","value":"","disabled":true,"description":"open, soft_closed or closed (comma-separated)"}],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"List fiscal periods\n\nPeriods in date order with the overall status and the close status of each module (AP, AR, payroll, job cost, cash management, GL). Filter with `filters[fiscal_year]` and `filters[status]`. Requires the accounting:read scope."}},{"id":"26b1f04c-5c69-4562-8b88-23f9cb877819","name":"createCompanyAccountingPeriodsRebuildBalance — Rebuild period balance snapshots","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/periods/rebuild_balances","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","periods","rebuild_balances"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Rebuild period balance snapshots\n\nRecomputes acct_period_balances (what TB, balance sheet and income statement read for whole periods) from the posted journal lines, under every period row lock, and audits the number of corrected rows. Use when the integrity check period_balances_parity fails. Needs close_period and unrestricted entity access (403 otherwise). Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"reason\": \"\"\n}","options":{"raw":{"language":"json"}}}}},{"id":"91d0e1dd-7afb-4565-813d-c4e89df0d136","name":"getCompanyAccountingPeriod — Show a fiscal period","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/periods/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","periods",":id"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Show a fiscal period\n\nOne period with its per-module close status. Requires the accounting:read scope."}},{"id":"6e2f479c-6642-443f-8db8-711ebce0fe00","name":"closeCompanyAccountingPeriod — Close or soft-close a period","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/periods/:id/close","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","periods",":id","close"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Close or soft-close a period\n\nCloses one module (`ap`, `ar`, `payroll`, `jc`, `cm`, `gl`) or the whole period (`all`, the default). A closed period refuses postings, enforced again by a database trigger; a soft-closed one accepts postings only from users who can close periods. Needs close_period. With `entity_id` (per-entity close enabled), only that entity's lines are refused; an entity's readiness, checklist and evidence cover that entity only, and the elimination entity closes last (every entity closed, eliminations current). Without per-entity close enabled, `entity_id` answers 422 `entity_close_disabled`. Audited and emits `accounting.period.closed` or `accounting.period.soft_closed`. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"close\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"48c69e2d-6642-4309-8476-c8f2dfe93f26","name":"eliminateIntercompanyCompanyAccountingPeriod — Eliminate intercompany at a period end","request":{"method":"POST","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/periods/:id/eliminate_intercompany","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","periods",":id","eliminate_intercompany"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Eliminate intercompany at a period end\n\nPosts one CL entry in the elimination entity dated the period end, auto-reversing the next day, that reverses every matched pair of intercompany due-to/due-from balances (by line counterparty), so the Consolidated column of the entity-pivot statements nets intercompany to zero. Refuses (422) when no elimination entity exists, when a pair of entities does not net to zero, or when intercompany lines with a balance name no counterparty. A rerun compares with what earlier runs still contribute at the period end, even after their auto-reversal: unchanged returns the latest entry (200, created false); otherwise a still-posted revision is reversed, an already auto-reversed one is offset on the period end, and a new revision posts (201). It also posts a second CL entry (pl_journal_entry) dated the period end, not auto-reversing, that reverses the period's intercompany revenue and cost: income-statement lines naming a counterparty entity (the intercompany pre-pass tags them only when an entry's P&L sits in exactly two entities and nets to zero), so the consolidated income statement leaves out EquipCo rent charged to OpCo jobs; only pairs that net to zero are eliminated, the others stay in consolidation and are listed in pl_mismatches without blocking the balance-sheet elimination, and a rerun reverses the standing revision when the period's activity changed. Needs close_period and unrestricted entity access (403 otherwise). Requires the accounting:write scope."}},{"id":"3eff7b10-2fd8-4727-84fe-591b8cde8377","name":"reopenCompanyAccountingPeriod — Reopen a period","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/periods/:id/reopen","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","periods",":id","reopen"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Reopen a period\n\nReopens one module or the whole period. A reason is required and recorded in the audit trail. Refused with 422 while a later period is closed, unless cascade is true: then every later closed period is reopened too, its close reviews are invalidated, and each reopen is audited. Reopening a hard-closed scope (a closed period or module, or a cascade over closed periods) needs two close_period users: the first call records a request and answers 202 with the unchanged period and pending_reopen; a different user's call with the same module and cascade within 7 days applies the reopen (200). Soft-closed scopes reopen on one call. With `entity_id`, the reopen, cascade and two-person request apply to that entity's rows; reopening a real entity also reopens the elimination entity where it is closed in that period or later. Needs close_period. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"reopen\": {\n    \"reason\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"9ac00010-256b-4653-8c04-dda398226247","name":"createCompanyAccountingPiiRotation — Rotate vendor and bank PII encryption","request":{"method":"POST","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/pii_rotation","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","pii_rotation"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Rotate vendor and bank PII encryption\n\nData migration and key rotation: re-encrypts vendor/customer TIN and bank numbers (live and pending) and company bank account and routing numbers still in the legacy format, under an older key, or written before row binding (empty AAD), with the current key and bound to their row (company, row, field), so a value copied to another row no longer decrypts. A rewritten pending change gets a new change_hash. Returns counts only. Needs manage_vendor_banking; audited. Requires the accounting:write scope. Also rewrites AP payment release snapshots and vendor ACH prenote records (profile binding), vendor and unmatched NOC corrections, ERP connection OAuth tokens and webhook signing secrets. `remaining` counts the company's rows, payroll included, still holding a value under an older key id or the legacy format: drop an old key id only once it is 0."}},{"id":"a1419b67-5a8e-4836-8a51-7632e649494e","name":"listCompanyAccountingPrepaidsForecast — Upcoming amortization forecast","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/prepaids/forecast","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","prepaids","forecast"],"query":[{"key":"from","value":"","disabled":true},{"key":"months","value":"","disabled":true},{"key":"entity_id","value":"","disabled":true}],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Upcoming amortization forecast\n\nScheduled prepaid amortization and deferred revenue recognition by recognition account and month for `months` months (1-36, default 12) from `from` (YYYY-MM, default this month), from the schedules in force; `overdue` is what is scheduled before `from` and not yet posted. Noncash (`cash_impact` none): the payments were cash when the bill or receipt was. Needs view_ledger. Requires the accounting:read scope."}},{"id":"e9820444-e500-4715-838c-7724017f668c","name":"listCompanyAccountingPrepaidsRollForward — Prepaid and deferred revenue roll-forward","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/prepaids/roll_forward","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","prepaids","roll_forward"],"query":[{"key":"from","value":"","disabled":false},{"key":"to","value":"","disabled":false},{"key":"entity_id","value":"","disabled":true}],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Prepaid and deferred revenue roll-forward\n\nPer balance account, in its normal direction, for from..to: opening (GL) + additions (funding, deferred bill lines, other increases) − amortization (posted runs net of reversals) + adjustments (amount changes, cancellations, voids, other decreases) = closing (GL), with the subledger balance and the difference; `foots` checks the identity and `ties` that every account foots and agrees with the subledger. Per schedule: opening, posted amortization and closing from the subledger. Needs view_ledger. Requires the accounting:read scope."}},{"id":"2b0550cf-64f1-47ac-88f7-0af9db27b875","name":"listCompanyAccountingPrepaidsRuns — List amortization runs","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/prepaids/runs","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","prepaids","runs"],"query":[{"key":"period_id","value":"","disabled":true},{"key":"entity_id","value":"","disabled":true}],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"List amortization runs\n\nRuns of the grant's entities, latest period first (at most 200). Needs view_ledger. Requires the accounting:read scope."}},{"id":"63d45df8-344a-4458-8808-6f49632d8644","name":"createCompanyAccountingPrepaidsRun — Prepare an amortization run","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/prepaids/runs","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","prepaids","runs"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Prepare an amortization run\n\nNeeds post_journal. Computes, for every schedule of the entity funded by the period end, the cumulative scheduled amortization through the period less what is posted, and stores the lines without posting (201). The same evidence returns the prepared run (200, unchanged true); changed evidence supersedes it. Refused (409) when a posted run covers the period and entity; (422) for a non-calendar-month or closed period, when a later period's run is posted, or when nothing is due. A second user approves it. Audited. Honors Idempotency-Key. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"prepaid_run\": {\n    \"entity_id\": 0,\n    \"period_id\": 0\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"cefe7a84-2c00-455e-80cb-65972bd1e420","name":"getCompanyAccountingPrepaidsRun — Show an amortization run","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/prepaids/runs/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","prepaids","runs",":id"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Show an amortization run\n\nThe run with its items and lines. Needs view_ledger. Requires the accounting:read scope."}},{"id":"7219f49f-9beb-455c-8b92-71f731d397f9","name":"decisionCompanyAccountingPrepaidsRun — Approve and post, or cancel, a prepared run","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/prepaids/runs/:id/decision","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","prepaids","runs",":id","decision"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Approve and post, or cancel, a prepared run\n\napprove needs approve_journal and is refused (403) for the preparer; the run is recomputed and refused (409) if schedules or postings moved; the entry posts on the period end with both users recorded. cancel needs post_journal and a reason. A repeat returns the run. Audited. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"decision\": {\n    \"action\": \"approve\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"89529306-4c8b-422d-827a-d8b33f9204ab","name":"reverseCompanyAccountingPrepaidsRun — Reverse a posted run","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/prepaids/runs/:id/reverse","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","prepaids","runs",":id","reverse"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Reverse a posted run\n\nNeeds approve_journal. Reverses the run's entry on `date` with a reason; the period and entity can then be run again, and the next run catches the schedules up. A repeat with the same date and reason returns the run. Audited. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"reversal\": {\n    \"date\": \"2026-01-31\",\n    \"reason\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"de4c5d4f-041f-49dc-8e0d-e4944586e9f7","name":"listCompanyAccountingPrepaidsSchedules — List prepaid and deferred revenue schedules","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/prepaids/schedules","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","prepaids","schedules"],"query":[{"key":"kind","value":"","disabled":true},{"key":"status","value":"","disabled":true},{"key":"entity_id","value":"","disabled":true},{"key":"as_of","value":"","disabled":true}],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"List prepaid and deferred revenue schedules\n\nSchedules of the grant's entities, newest start first (at most 500), with posted amortization and the unamortized balance as of `as_of` (default today in the company's time zone). Needs view_ledger. Requires the accounting:read scope."}},{"id":"fe40d0a7-7266-4967-8b31-47d615fa1e1c","name":"createCompanyAccountingPrepaidsSchedule — Create a schedule, or defer an AP bill line","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/prepaids/schedules","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","prepaids","schedules"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Create a schedule, or defer an AP bill line\n\nNeeds post_journal. Manual: `funding_mode` entry (default) posts Dr balance / Cr `funding_offset_account_id` (Dr offset / Cr balance for deferred revenue) on `funding_date` (default the start date); existing records a balance already on the account (an opening balance). From a posted AP bill line (`ap_bill_line_id`): a line coded to the prepaid account funds the schedule itself (deferred in full); a line coded to an expense is reclassified to the prepaid account on `funding_date` (default the bill's posting date). Accounts default by category (1330 insurance and bonds, 1340 others; 6300, 5520, 6200, 6240, 6250 expense; 4150 revenue for deferred revenue). The funding date must be in a period open for the entity. `preview: true` returns the months and the funding lines and writes nothing (200). Audited. Honors Idempotency-Key. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"schedule\": {\n    \"category\": \"insurance\",\n    \"end_date\": \"2026-01-31\",\n    \"kind\": \"prepaid\",\n    \"method\": \"daily\",\n    \"name\": \"\",\n    \"start_date\": \"2026-01-31\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"8b3ff635-f7f5-461f-8dcc-b93e3acec553","name":"getCompanyAccountingPrepaidsSchedule — Show a schedule with its versions","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/prepaids/schedules/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","prepaids","schedules",":id"],"query":[{"key":"version","value":"","disabled":true},{"key":"as_of","value":"","disabled":true}],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Show a schedule with its versions\n\nThe schedule, its months in force (or of `version`, 0 = original) and every version. Needs view_ledger. Requires the accounting:read scope."}},{"id":"79618e34-66cd-47b0-856a-d48f6a3c5186","name":"createCompanyAccountingPrepaidsScheduleModification — Modify or cancel a schedule","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/prepaids/schedules/:id/modifications","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","prepaids","schedules",":id","modifications"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Modify or cancel a schedule\n\nNeeds post_journal. Appends a version that keeps every month before the effective month. term_change (new_end_date) and amount_change (new_amount and offset_account_id; optional new_end_date) are prospective by default (the balance left at the effective date spreads over the revised remaining window) or catch_up (the revised terms from the start, the difference in the effective month). cancel stops amortization at the effective date and posts the unamortized balance: refund_amount to refund_account_id, the rest written off to the recognition account. Monthly and custom schedules change on the first of a month. Refused for a cancelled or voided schedule (409), when amortization is posted on or after the effective date (409; reverse that run), and for a closed period (422). `preview: true` writes nothing (200). Audited. Honors Idempotency-Key. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"modification\": {\n    \"effective_date\": \"2026-01-31\",\n    \"kind\": \"term_change\",\n    \"reason\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"396e6957-2ffb-4080-8a53-4ec560177a33","name":"voidCompanyAccountingPrepaidsSchedule — Void a schedule entered by mistake","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/prepaids/schedules/:id/void","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","prepaids","schedules",":id","void"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Void a schedule entered by mistake\n\nNeeds post_journal. Reverses the funding entry (if any) on `date`. Refused (409) once amortization is posted (reverse the runs first) or after a modification (cancel instead). A repeat with the same date and reason returns the schedule. Audited. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"void\": {\n    \"date\": \"2026-01-31\",\n    \"reason\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"f13290b2-44dd-4d9b-8d22-fc1ac43f043f","name":"listCompanyAccountingPrivacyHolds — List legal holds","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/privacy/holds","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","privacy","holds"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"List legal holds\n\nEvery hold, newest first (500), active and released. Needs an unrestricted company owner (company-wide access, every flag including view_payroll_pii and manage_grants) and step-up: a token needs accounting:step_up. Requires accounting:read."}},{"id":"5d2bd4e9-d80e-4961-85db-a2daa545463c","name":"createCompanyAccountingPrivacyHold — Place a legal hold","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/privacy/holds","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","privacy","holds"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Place a legal hold\n\nPlaces a hold on the company, an entity, a project, a vendor or an employee. Effective at once: retention skips every record it covers (an employee: their pay group's or a check's employer entity, projects they logged time on; a vendor: entities of its bills, payments and 1099 filings, projects on its bill lines). Any active hold also suspends outbox and job-error redaction. Audited. Honors Idempotency-Key. Needs an unrestricted company owner (company-wide access, every flag including view_payroll_pii and manage_grants) and step-up: a token needs accounting:step_up. Requires accounting:write.","body":{"mode":"raw","raw":"{\n  \"hold\": {\n    \"reason\": \"\",\n    \"subject_type\": \"company\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"246d4c58-6fc7-4f7e-8e43-5046bd7037e5","name":"releaseCompanyAccountingPrivacyHold — Release a legal hold","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/privacy/holds/:id/release","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","privacy","holds",":id","release"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Release a legal hold\n\nReleases an active hold with a reason; audited. 409 when already released. Needs an unrestricted company owner (company-wide access, every flag including view_payroll_pii and manage_grants) and step-up: a token needs accounting:step_up. Requires accounting:write.","body":{"mode":"raw","raw":"{\n  \"release\": {\n    \"reason\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"a6a6f007-872f-41bf-8539-f74982c99f32","name":"listCompanyAccountingPrivacyPiiInventory — PII inventory","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/privacy/pii_inventory","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","privacy","pii_inventory"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"PII inventory\n\nEvery accounting column holding personal or sensitive identifying data: category, subject, protection (sealed, masked, plain, hashed) and governing retention class, plus pattern-matching columns classified as not personal data with the reason. Needs an unrestricted company owner (company-wide access, every flag including view_payroll_pii and manage_grants) and step-up: a token needs accounting:step_up. Requires accounting:read."}},{"id":"6fffe1bc-a663-475a-8170-02165f24406e","name":"listCompanyAccountingPrivacyRequests — List data subject requests","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/privacy/requests","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","privacy","requests"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"List data subject requests\n\nNewest first (500). Needs an unrestricted company owner (company-wide access, every flag including view_payroll_pii and manage_grants) and step-up: a token needs accounting:step_up. Requires accounting:read."}},{"id":"5bff0cc4-781a-4305-872e-c81a63d57367","name":"createCompanyAccountingPrivacyRequest — Log a data subject request","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/privacy/requests","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","privacy","requests"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Log a data subject request\n\nAccess, rectification or erasure about an employee or vendor contact; due 45 days after receipt (a proposal for counsel). Audited. Honors Idempotency-Key. Needs an unrestricted company owner (company-wide access, every flag including view_payroll_pii and manage_grants) and step-up: a token needs accounting:step_up. Requires accounting:write.","body":{"mode":"raw","raw":"{\n  \"privacy_request\": {\n    \"description\": \"\",\n    \"kind\": \"access\",\n    \"received_on\": \"2026-01-31\",\n    \"subject_id\": 0,\n    \"subject_type\": \"employee\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"6fe76125-eab3-4efc-845b-1d23845fb5fa","name":"getCompanyAccountingPrivacyRequest — Data subject request","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/privacy/requests/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","privacy","requests",":id"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Data subject request\n\nWith, while open, the live assessment of each data item: erasable, retained (with the reason: retention period, ledger integrity, legal hold, open item) or already minimized. Needs an unrestricted company owner (company-wide access, every flag including view_payroll_pii and manage_grants) and step-up: a token needs accounting:step_up. Requires accounting:read."}},{"id":"e95113ae-395f-4ce2-8f70-c328d80f485a","name":"decisionCompanyAccountingPrivacyRequest — Complete or reject a data subject request","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/privacy/requests/:id/decision","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","privacy","requests",":id","decision"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Complete or reject a data subject request\n\nA different owner than the one who logged it. Access completes only after a subject export since the request was logged (409). Erasure clears exactly what the assessment marks erasable (sealed values past their approved period, optional vendor contact fields) and records what was retained and why; financial records, payroll records and the audit trail are never erased. Audited. Needs an unrestricted company owner (company-wide access, every flag including view_payroll_pii and manage_grants) and step-up: a token needs accounting:step_up. Requires accounting:write.","body":{"mode":"raw","raw":"{\n  \"decision\": {\n    \"decision\": \"complete\",\n    \"note\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"e93ce904-3fc9-4227-8a7f-2179a04108c5","name":"listCompanyAccountingPrivacyRetentionRegister — Retention register","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/privacy/retention_register","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","privacy","retention_register"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Retention register\n\nEvery record class with its hard floor, proposed period and basis (proposals, not in force), the approved rule in force and any pending change, plus the latest 200 change requests. Needs an unrestricted company owner (company-wide access, every flag including view_payroll_pii and manage_grants) and step-up: a token needs accounting:step_up. Requires accounting:read."}},{"id":"c674f417-b7aa-4ebf-867b-3d3030606f41","name":"createCompanyAccountingPrivacyRetentionRegisterChange — Request a retention period change (maker)","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/privacy/retention_register/changes","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","privacy","retention_register","changes"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Request a retention period change (maker)\n\nRequests a period for a record class. Refused below the class's hard floor (422; the database also refuses it) and while another change for the class is pending (409). Not in force until a different owner approves it. Audited. Honors Idempotency-Key. Needs an unrestricted company owner (company-wide access, every flag including view_payroll_pii and manage_grants) and step-up: a token needs accounting:step_up. Requires accounting:write.","body":{"mode":"raw","raw":"{\n  \"change\": {\n    \"basis\": \"\",\n    \"jurisdiction\": \"\",\n    \"reason\": \"\",\n    \"record_class\": \"ledger\",\n    \"retention_days\": 0\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"0f273c0d-b278-46ad-87b4-3c43dec79cbc","name":"decisionCompanyAccountingPrivacyRetentionRegisterChange — Approve or reject a retention change (checker)","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/privacy/retention_register/changes/:id/decision","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","privacy","retention_register","changes",":id","decision"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Approve or reject a retention change (checker)\n\nA different unrestricted owner than the requester approves (the rule takes effect, version + 1) or rejects a pending change; 403 for your own request, 409 once decided. Audited with before and after. Needs an unrestricted company owner (company-wide access, every flag including view_payroll_pii and manage_grants) and step-up: a token needs accounting:step_up. Requires accounting:write.","body":{"mode":"raw","raw":"{\n  \"decision\": {\n    \"decision\": \"approve\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"d3f8645f-22c8-4d6c-869b-6472cc7f3499","name":"listCompanyAccountingPrivacyRetentionRuns — List retention runs","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/privacy/retention_runs","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","privacy","retention_runs"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"List retention runs\n\nLatest 50 previews and executions with per-class summaries. Needs an unrestricted company owner (company-wide access, every flag including view_payroll_pii and manage_grants) and step-up: a token needs accounting:step_up. Requires accounting:read."}},{"id":"4e87e514-011c-412e-8154-7d59952d9885","name":"createCompanyAccountingPrivacyRetentionRun — Preview retention (dry run)","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/privacy/retention_runs","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","privacy","retention_runs"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Preview retention (dry run)\n\nComputes and records what retention would change now (or at the end of as_of, not in the future): per class, records past the approved period, those kept by holds and those that would change, with a plan hash. Nothing is changed. Honors Idempotency-Key. Needs an unrestricted company owner (company-wide access, every flag including view_payroll_pii and manage_grants) and step-up: a token needs accounting:step_up. Requires accounting:write.","body":{"mode":"raw","raw":"{\n  \"preview\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"ce3ae7ae-f790-4d3e-84c0-4ac24189fffa","name":"getCompanyAccountingPrivacyRetentionRun — Retention run with its evidence report","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/privacy/retention_runs/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","privacy","retention_runs",":id"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Retention run with its evidence report\n\nNeeds an unrestricted company owner (company-wide access, every flag including view_payroll_pii and manage_grants) and step-up: a token needs accounting:step_up. Requires accounting:read."}},{"id":"197e16a6-4275-4db8-8e14-9045fa98f905","name":"executeCompanyAccountingPrivacyRetentionRun — Execute a retention preview","request":{"method":"POST","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/privacy/retention_runs/:id/execute","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","privacy","retention_runs",":id","execute"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Execute a retention preview\n\nRecomputes the plan at the preview's date; it must hash to the preview (409 otherwise: preview again). Then applies it in batches that re-check eligibility and holds under row locks, and records the execution evidence (applied ids against the plan, ledger fingerprint, integrity checks and audit count before and after). A preview executes once and within 24 hours (409). Needs an unrestricted company owner (company-wide access, every flag including view_payroll_pii and manage_grants) and step-up: a token needs accounting:step_up. Requires accounting:write."}},{"id":"03b206ab-f8d4-46cc-80db-817923553214","name":"createCompanyAccountingPrivacySubjectExport — Export the personal data held about a subject","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/privacy/subject_exports","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","privacy","subject_exports"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Export the personal data held about a subject\n\nEmployee or vendor contact: identity, contact, bank (masked), payroll or AP history, portal users, the audit trail about them (actions only), active holds covering them and the retention disposition of each data item. reveal=true decrypts sealed SSN/TIN/bank values for this response only (rate limited). Every export is audited with the sections and the reveal flag, never the values. Creates no record. Needs an unrestricted company owner (company-wide access, every flag including view_payroll_pii and manage_grants) and step-up: a token needs accounting:step_up. Requires accounting:write.","body":{"mode":"raw","raw":"{\n  \"subject_export\": {\n    \"subject_id\": 0,\n    \"subject_type\": \"employee\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"16ca304b-d651-4097-8296-2bfa9c0d347e","name":"listCompanyAccountingRecurringJournals — List recurring journals","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/recurring_journals","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","recurring_journals"],"query":[{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true}],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"List recurring journals\n\nRecurring journal templates in the caller's entities, active first by next run date. Paginated (page/per_page; Total and Link headers). Requires the accounting:read scope. Entity-wide: a project-scoped (project_manager_view) grant gets 403."}},{"id":"0ffa8f52-db13-4418-86c7-4849d9be9d46","name":"createCompanyAccountingRecurringJournal — Create a recurring journal","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/recurring_journals","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","recurring_journals"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Create a recurring journal\n\nSaves a template that generates a journal entry on each run date (daily scheduler, as of today in the company time zone). Lines must balance. Starts unapproved; an auto_post template posts only after a second person approves it, and generates drafts until then. Needs post_journal. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"recurring_journal\": {\n    \"lines\": [\n      {\n        \"account_id\": 0\n      }\n    ],\n    \"name\": \"\",\n    \"start_date\": \"2026-01-31\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"67c03ee8-a491-4498-8502-50c2caa0b803","name":"getCompanyAccountingRecurringJournal — Show a recurring journal","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/recurring_journals/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","recurring_journals",":id"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Show a recurring journal\n\nOne template with its lines. Requires the accounting:read scope. Entity-wide: a project-scoped (project_manager_view) grant gets 403."}},{"id":"1ab13dca-8197-4303-87f8-572ef71c8628","name":"updateCompanyAccountingRecurringJournal — Update a recurring journal","request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/recurring_journals/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","recurring_journals",":id"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Update a recurring journal\n\nEdits a template. Any edit clears its approval, so an auto_post template needs a second-person re-approval before it posts again. Sending lines replaces them. The start date is fixed once the template has run. Needs post_journal. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"recurring_journal\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"9742a454-d951-440f-88d1-0d899273819a","name":"deleteCompanyAccountingRecurringJournal — Delete a recurring journal","request":{"method":"DELETE","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/recurring_journals/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","recurring_journals",":id"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Delete a recurring journal\n\nRemoves a template that never generated an entry; otherwise deactivate it (is_active false). Needs post_journal. Requires the accounting:write scope."}},{"id":"cf6c1bbe-4656-438c-813b-fef0aaeb6bc6","name":"approveCompanyAccountingRecurringJournal — Approve a recurring journal","request":{"method":"POST","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/recurring_journals/:id/approve","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","recurring_journals",":id","approve"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Approve a recurring journal\n\nRecords a second-person approval. The creator and every editor of the template can never approve it (403). Needs approve_journal. Requires the accounting:write scope."}},{"id":"264ceefc-f1f5-4eb1-85f0-9a9556b921b3","name":"listCompanyAccountingReportDefinitions — List report definitions","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/report_definitions","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","report_definitions"],"query":[{"key":"source","value":"","disabled":true,"description":"Only this data source"},{"key":"page","value":"1","disabled":true,"description":"Page"},{"key":"per_page","value":"100","disabled":true,"description":"Page size"}],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"List report definitions\n\nDefinitions the caller may see: their own, shared with the company, and shared with their grant role. Paginated (Total, Per-Page, Link). Requires accounting:read."}},{"id":"f0479e21-1a62-401d-8687-ea1048b05344","name":"createCompanyAccountingReportDefinition — Save a report definition","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/report_definitions","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","report_definitions"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Save a report definition\n\nSaves version 1, owned by the caller, private or shared with roles or the whole company. The spec is checked against the source's columns; data access is checked whenever it runs. Honors Idempotency-Key. Requires accounting:write.","body":{"mode":"raw","raw":"{\n  \"report_definition\": {\n    \"name\": \"\",\n    \"spec\": {\n      \"columns\": [\n        \"\"\n      ],\n      \"source\": \"gl_detail\"\n    }\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"c2f72a91-1475-4510-865b-b38b8c985650","name":"createCompanyAccountingReportDefinitionsPreview — Preview an unsaved definition","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/report_definitions/preview","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","report_definitions","preview"],"query":[{"key":"as_of","value":"","disabled":true,"description":"Balance date (as-of sources); overrides the saved parameter"},{"key":"from","value":"","disabled":true,"description":"Start of the activity range; overrides the saved parameter"},{"key":"to","value":"","disabled":true,"description":"End of the activity range; overrides the saved parameter"},{"key":"entity_id","value":"","disabled":true,"description":"Entity (must be inside the caller's grant)"},{"key":"project_id","value":"","disabled":true,"description":"Job (must be inside the caller's grant)"},{"key":"department_id","value":"","disabled":true,"description":"Department"},{"key":"budget_id","value":"","disabled":true,"description":"GL budget for compare=budget"},{"key":"basis","value":"","disabled":true,"description":"Aging basis for open-item sources"}],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Preview an unsaved definition\n\nRuns a spec without saving it (the builder's live preview), scoped by the caller's grant. Reads only: accounting:read is enough. Query parameters override the spec's saved parameters.","body":{"mode":"raw","raw":"{\n  \"report_definition\": {\n    \"spec\": {\n      \"columns\": [\n        \"\"\n      ],\n      \"source\": \"gl_detail\"\n    }\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"a0c1868b-c23e-4d95-8b2d-7052b91ed424","name":"listCompanyAccountingReportDefinitionsSources — Report builder data sources","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/report_definitions/sources","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","report_definitions","sources"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Report builder data sources\n\nThe whitelisted sources (GL lines, trial balance, cash, AP/AR open items, job cost, job cost entries, library reports) with their columns, groupable dimensions, amounts and comparisons. Requires accounting:read."}},{"id":"1de48f28-19ee-4815-8ee6-d3786164d2e1","name":"getCompanyAccountingReportDefinition — Show a report definition","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/report_definitions/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","report_definitions",":id"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Show a report definition\n\nA definition the caller may see (404 otherwise). Requires accounting:read."}},{"id":"3df34611-7f04-431b-86d8-8f57f7b5a777","name":"updateCompanyAccountingReportDefinition — Update a report definition","request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/report_definitions/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","report_definitions",":id"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Update a report definition\n\nOwner or company administrator only. Every save is a new version (the previous one stays in versions). Requires accounting:write.","body":{"mode":"raw","raw":"{\n  \"report_definition\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"ab91ed6e-137e-4974-8618-1ac2e72b1144","name":"deleteCompanyAccountingReportDefinition — Delete a report definition","request":{"method":"DELETE","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/report_definitions/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","report_definitions",":id"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Delete a report definition\n\nOwner or company administrator only; its versions go with it. Requires accounting:write."}},{"id":"654c348d-ffb8-4d24-8402-18b8ef9820a5","name":"listCompanyAccountingReportDefinitionExport — Export a report definition","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/report_definitions/:id/export","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","report_definitions",":id","export"],"query":[{"key":"format","value":"","disabled":true,"description":"File format (default csv)"},{"key":"as_of","value":"","disabled":true,"description":"Balance date (as-of sources); overrides the saved parameter"},{"key":"from","value":"","disabled":true,"description":"Start of the activity range; overrides the saved parameter"},{"key":"to","value":"","disabled":true,"description":"End of the activity range; overrides the saved parameter"},{"key":"entity_id","value":"","disabled":true,"description":"Entity (must be inside the caller's grant)"},{"key":"project_id","value":"","disabled":true,"description":"Job (must be inside the caller's grant)"},{"key":"department_id","value":"","disabled":true,"description":"Department"},{"key":"budget_id","value":"","disabled":true,"description":"GL budget for compare=budget"},{"key":"basis","value":"","disabled":true,"description":"Aging basis for open-item sources"},{"key":"version","value":"","disabled":true,"description":"Run an earlier saved version"}],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Export a report definition\n\nThe run's output as CSV, XLSX or PDF, with the report library's encoders, per-user rate limit and export audit. Requires accounting:read."}},{"id":"cbfc899b-43f8-49ec-87b6-b8addd0ab67c","name":"listCompanyAccountingReportDefinitionRun — Run a report definition","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/report_definitions/:id/run","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","report_definitions",":id","run"],"query":[{"key":"as_of","value":"","disabled":true,"description":"Balance date (as-of sources); overrides the saved parameter"},{"key":"from","value":"","disabled":true,"description":"Start of the activity range; overrides the saved parameter"},{"key":"to","value":"","disabled":true,"description":"End of the activity range; overrides the saved parameter"},{"key":"entity_id","value":"","disabled":true,"description":"Entity (must be inside the caller's grant)"},{"key":"project_id","value":"","disabled":true,"description":"Job (must be inside the caller's grant)"},{"key":"department_id","value":"","disabled":true,"description":"Department"},{"key":"budget_id","value":"","disabled":true,"description":"GL budget for compare=budget"},{"key":"basis","value":"","disabled":true,"description":"Aging basis for open-item sources"},{"key":"version","value":"","disabled":true,"description":"Run an earlier saved version"}],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Run a report definition\n\nRuns the definition as the caller: their grant's entities and projects scope every row, whoever owns or shared it. Query parameters override the saved ones. `checks` prove the grouped rows add back to the base total (and the comparison column to its own base). Requires accounting:read."}},{"id":"d68fbaae-5a9f-4d76-811f-2c250079ca95","name":"listCompanyAccountingReportDefinitionVersions — Report definition versions","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/report_definitions/:id/versions","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","report_definitions",":id","versions"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Report definition versions\n\nEvery saved version, newest first. Requires accounting:read."}},{"id":"a9684319-2405-47c0-8b9a-2848b6465eb9","name":"listCompanyAccountingReports — Report library","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/reports","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","reports"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Report library\n\nEvery report with its group and accepted parameters. Requires the accounting:read scope and an accounting grant."}},{"id":"c98cfc70-9a44-45a4-8ce5-7e3495790253","name":"getCompanyAccountingReport — Run a report","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/reports/:report_key","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","reports",":report_key"],"query":[{"key":"as_of","value":"","disabled":true,"description":"Balance date (default `to`, else today)"},{"key":"from","value":"","disabled":true,"description":"Start of the activity range (default the start of the fiscal year holding `to`)"},{"key":"to","value":"","disabled":true,"description":"End of the activity range (default today)"},{"key":"adj_from","value":"","disabled":true,"description":"Trial balance worksheet: start of the adjustments and closing window (default the start of the fiscal period holding `as_of`); income and expense adjustments before the fiscal year start roll into retained earnings. For trial_balance a `from` sent without `adj_from` is read as `adj_from` (deprecated alias)"},{"key":"compare","value":"","disabled":true,"description":"Comparative column (balance sheet, income statement, cash flow; the cash flow's prior column has its own opening balances). `budget` (income statement only) adds Budget and Variance (actual - budget, per account and row) columns for `budget_id`."},{"key":"budget_id","value":"","disabled":true,"description":"With compare=budget: the GL budget version to compare with"},{"key":"columns","value":"","disabled":true,"description":"Income statement columns; the balance sheet takes total or entity. Entity columns end with Eliminations (the elimination entity) and Consolidated. Month and quarter views allow at most 36 periods; narrow the date range or choose total columns for longer ranges. Entity, department and job views show at most 50 columns: past that, the values with the least revenue are combined in an All other column."},{"key":"entity_id","value":"","disabled":true,"description":"One entity (within the grant entities)"},{"key":"project_id","value":"","disabled":true,"description":"One job"},{"key":"department_id","value":"","disabled":true,"description":"One department"},{"key":"dimension","value":"","disabled":true,"description":"User-defined dimension code (or id) to group by: trial_balance becomes one net column per value plus No <dimension> and Total (checked against the ungrouped trial balance), general_ledger adds the line's value as a column, and income_statement with columns=dimension pivots by value."},{"key":"dimension_level","value":"","disabled":true,"description":"Roll grouped values up to this hierarchy level (1 = top-level values); omitted = the posted value."},{"key":"dimension_value_ids","value":"","disabled":true,"description":"Comma-separated dimension value ids: lines carrying one of them or a child value (values of one dimension OR, dimensions AND)."},{"key":"account_id","value":"","disabled":true,"description":"One account (general ledger)"},{"key":"journal","value":"","disabled":true,"description":"One journal (journal report)"},{"key":"basis","value":"","disabled":true,"description":"Aging basis"},{"key":"include_zero","value":"","disabled":true,"description":"Also show rows with no balance"},{"key":"jtd","value":"","disabled":true,"description":"Job profitability: job to date through `to` (ignores `from`)"},{"key":"actor_id","value":"","disabled":true,"description":"Audit log: only events by this user"},{"key":"item_type","value":"","disabled":true,"description":"Audit log: only events on this accounting record type (e.g. AcctAccount)"},{"key":"action","value":"","disabled":true,"description":"Audit log: only events with this action (e.g. updated)"},{"key":"rollup","value":"","disabled":true,"description":"Balance sheet and income statement: group account rows under their parent account with a subtotal row"}],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"report_key","value":"","description":"Report key"}]},"description":"Run a report\n\nBalance sheet, income statement (comparative or by month, quarter, entity, department or job), indirect cash flow, trial balance worksheet (unadjusted, adjustments, adjusted, closing, post-closing), GL detail, journal, AR/AP aging as of a date, job profitability, subledger reconciliation, the integrity check, the surety package (completed contracts, WIP to GL reconciliation, backlog roll-forward) and the CECL allowance. The cash flow statement ends with supplemental interest and income taxes paid and the noncash schedule (entries tagged noncash); the balance sheet presents receivables net of the allowance, and the loss provision and the current portion of long-term debt on their own lines. `checks` are the report's own proofs (assets = liabilities + equity, debits = credits, cash flow ties to cash). Requires accounting:read."}},{"id":"cfacd199-6673-4ea6-8cfd-efc825153fe0","name":"listCompanyAccountingReportExport — Export a report","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/reports/:report_key/export","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","reports",":report_key","export"],"query":[{"key":"format","value":"","disabled":true,"description":"File format (default csv)"},{"key":"as_of","value":"","disabled":true,"description":"Balance date (default `to`, else today)"},{"key":"from","value":"","disabled":true,"description":"Start of the activity range (default the start of the fiscal year holding `to`)"},{"key":"to","value":"","disabled":true,"description":"End of the activity range (default today)"},{"key":"adj_from","value":"","disabled":true,"description":"Trial balance worksheet: start of the adjustments and closing window (default the start of the fiscal period holding `as_of`); income and expense adjustments before the fiscal year start roll into retained earnings. For trial_balance a `from` sent without `adj_from` is read as `adj_from` (deprecated alias)"},{"key":"compare","value":"","disabled":true,"description":"Comparative column (balance sheet, income statement, cash flow; the cash flow's prior column has its own opening balances). `budget` (income statement only) adds Budget and Variance (actual - budget, per account and row) columns for `budget_id`."},{"key":"budget_id","value":"","disabled":true,"description":"With compare=budget: the GL budget version to compare with"},{"key":"columns","value":"","disabled":true,"description":"Income statement columns; the balance sheet takes total or entity. Entity columns end with Eliminations (the elimination entity) and Consolidated. Month and quarter views allow at most 36 periods; narrow the date range or choose total columns for longer ranges. Entity, department and job views show at most 50 columns: past that, the values with the least revenue are combined in an All other column."},{"key":"entity_id","value":"","disabled":true,"description":"One entity (within the grant entities)"},{"key":"project_id","value":"","disabled":true,"description":"One job"},{"key":"department_id","value":"","disabled":true,"description":"One department"},{"key":"dimension","value":"","disabled":true,"description":"User-defined dimension code (or id) to group by: trial_balance becomes one net column per value plus No <dimension> and Total (checked against the ungrouped trial balance), general_ledger adds the line's value as a column, and income_statement with columns=dimension pivots by value."},{"key":"dimension_level","value":"","disabled":true,"description":"Roll grouped values up to this hierarchy level (1 = top-level values); omitted = the posted value."},{"key":"dimension_value_ids","value":"","disabled":true,"description":"Comma-separated dimension value ids: lines carrying one of them or a child value (values of one dimension OR, dimensions AND)."},{"key":"account_id","value":"","disabled":true,"description":"One account (general ledger)"},{"key":"journal","value":"","disabled":true,"description":"One journal (journal report)"},{"key":"basis","value":"","disabled":true,"description":"Aging basis"},{"key":"include_zero","value":"","disabled":true,"description":"Also show rows with no balance"},{"key":"jtd","value":"","disabled":true,"description":"Job profitability: job to date through `to` (ignores `from`)"},{"key":"actor_id","value":"","disabled":true,"description":"Audit log: only events by this user"},{"key":"item_type","value":"","disabled":true,"description":"Audit log: only events on this accounting record type (e.g. AcctAccount)"},{"key":"action","value":"","disabled":true,"description":"Audit log: only events with this action (e.g. updated)"},{"key":"rollup","value":"","disabled":true,"description":"Balance sheet and income statement: group account rows under their parent account with a subtotal row"}],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"report_key","value":"","description":"Report key"}]},"description":"Export a report\n\nThe same report as a CSV, XLSX or PDF download. Rate-limited per user (429 with Retry-After) and recorded in the audit log. Requires the accounting:read scope."}},{"id":"b4f5bd51-5bd3-4a60-83e9-70d5d40f9109","name":"listCompanyAccountingSalesTaxArInvoiceDeterminations — An invoice's sales tax determinations","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/sales_tax/ar_invoices/:id/determinations","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","sales_tax","ar_invoices",":id","determinations"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"An invoice's sales tax determinations\n\nOne row per line and job-site jurisdiction: taxability, base, rate, tax, certificate and liability account. AR read access (project-scoped grants refused). Requires the accounting:read scope."}},{"id":"0786b30d-1371-4ee6-8ae7-4affffa45981","name":"listCompanyAccountingSalesTaxCategoryMappings — List cost type taxability categories","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/sales_tax/category_mappings","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","sales_tax","category_mappings"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"List cost type taxability categories\n\nAP lines without their own tax category take their cost type's. Any accounting grant. Requires the accounting:read scope."}},{"id":"43df3055-f9f9-4929-846c-6f76e0c17cf0","name":"replaceCompanyAccountingSalesTaxCategoryMappings — Set a cost type taxability category","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/sales_tax/category_mappings","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","sales_tax","category_mappings"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Set a cost type taxability category\n\ncategory null clears it (response null). Needs manage_coa; audited. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"mapping\": {\n    \"category\": \"material\",\n    \"cost_type_id\": 0\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"12b6d196-465c-4e52-8228-7e66ba86f202","name":"listCompanyAccountingSalesTaxCertificates — List exemption and resale certificates","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/sales_tax/certificates","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","sales_tax","certificates"],"query":[{"key":"party_type","value":"","disabled":true,"description":"Filter by party type"},{"key":"party_id","value":"","disabled":true,"description":"Filter by party"}],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"List exemption and resale certificates\n\nCustomer exemption or resale certificates (exempt their invoices) and resale certificates given to vendors. Any accounting grant; a project-scoped grant sees company-wide and its projects' certificates. Requires the accounting:read scope."}},{"id":"b3582233-8889-45ff-85dd-d86b66f368e0","name":"createCompanyAccountingSalesTaxCertificate — Add a certificate","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/sales_tax/certificates","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","sales_tax","certificates"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Add a certificate\n\nCovers its jurisdiction and descendants, optionally one project, from effective_from to expires_on. Needs manage_coa; audited. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"certificate\": {\n    \"certificate_number\": \"\",\n    \"effective_from\": \"2026-01-31\",\n    \"jurisdiction_id\": 0,\n    \"kind\": \"exemption\",\n    \"party_id\": 0,\n    \"party_type\": \"customer\",\n    \"reason\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"007a73ff-ce85-4ac9-8f22-dcb0b2673ff7","name":"getCompanyAccountingSalesTaxCertificate — Show a certificate","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/sales_tax/certificates/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","sales_tax","certificates",":id"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Show a certificate\n\nAny accounting grant. Requires the accounting:read scope."}},{"id":"dd1a5a1b-c613-49b6-8606-73c40b62831e","name":"updateCompanyAccountingSalesTaxCertificate — Renew or revoke a certificate","request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/sales_tax/certificates/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","sales_tax","certificates",":id"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Renew or revoke a certificate\n\nexpires_on renews; revoke_reason revokes (final). Needs manage_coa; audited. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"certificate\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"04b4ee57-912d-43dd-8605-f1dfd5ce3eca","name":"listCompanyAccountingSalesTaxFilings — List sales tax returns","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/sales_tax/filings","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","sales_tax","filings"],"query":[{"key":"jurisdiction_id","value":"","disabled":true,"description":"Filter by jurisdiction"}],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"List sales tax returns\n\nProject-scoped grants refused; entity-scoped grants see their entities. Requires the accounting:read scope."}},{"id":"037a7bf0-dfba-4f19-8327-2fde1abe8830","name":"createCompanyAccountingSalesTaxFiling — Prepare a sales tax return","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/sales_tax/filings","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","sales_tax","filings"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Prepare a sales tax return\n\nFor a filing jurisdiction (with those that file with it), entity and whole-month period matching its frequency: figures frozen with an evidence hash. The same figures return the prepared return (200); new figures supersede it. A filed period needs amendment true. Needs post_journal. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"filing\": {\n    \"entity_id\": 0,\n    \"jurisdiction_id\": 0,\n    \"period_end\": \"2026-01-31\",\n    \"period_start\": \"2026-01-31\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"775abf44-6ca2-48ff-8b89-fe7d841d3b98","name":"getCompanyAccountingSalesTaxFiling — Show a sales tax return","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/sales_tax/filings/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","sales_tax","filings",":id"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Show a sales tax return\n\nstale is true when the period's figures changed since it was prepared or filed. Requires the accounting:read scope."}},{"id":"53405e84-0da6-4f23-8abe-adab634bf51b","name":"decisionCompanyAccountingSalesTaxFiling — Mark a return filed, or cancel it","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/sales_tax/filings/:id/decision","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","sales_tax","filings",":id","decision"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Mark a return filed, or cancel it\n\nmark_filed (approve_journal, never the preparer) recomputes the figures (409 if they moved) and records filed_on and the confirmation number; cancel (post_journal) needs a reason. No e-filing. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"decision\": {\n    \"action\": \"mark_filed\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"3efbd6bc-605c-42a5-8e08-e46433646e7e","name":"listCompanyAccountingSalesTaxFilingExport — Filing-prep export (CSV)","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/sales_tax/filings/:id/export","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","sales_tax","filings",":id","export"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Filing-prep export (CSV)\n\nJurisdiction and rate lines, exempt certificates and the GL tie-out of a return. Text only; no e-filing. Requires the accounting:read scope."}},{"id":"6ba6fec0-08ca-41ae-8dae-b92eb3b13ac4","name":"paymentCompanyAccountingSalesTaxFiling — Link a return's payment","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/sales_tax/filings/:id/payment","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","sales_tax","filings",":id","payment"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Link a return's payment\n\nA posted journal entry, or a posted AP bill's entry, in the return's entity that debits its liability accounts. One entry pays one return. Needs approve_journal; audited. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"payment\": {\n    \"id\": 0,\n    \"source\": \"journal_entry\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"5f233f40-ac6e-464c-8e73-6ad93910f306","name":"listCompanyAccountingSalesTaxJurisdictionSets — List jurisdiction sets","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/sales_tax/jurisdiction_sets","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","sales_tax","jurisdiction_sets"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"List jurisdiction sets\n\nThe jurisdictions that tax one place, chosen per job site. Any accounting grant. Requires the accounting:read scope."}},{"id":"4d10a3ce-5adf-4931-8e8b-b3c56b8aa28c","name":"createCompanyAccountingSalesTaxJurisdictionSet — Add a jurisdiction set","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/sales_tax/jurisdiction_sets","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","sales_tax","jurisdiction_sets"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Add a jurisdiction set\n\nJurisdictions of one state. Needs manage_coa; audited. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"jurisdiction_set\": {\n    \"code\": \"\",\n    \"jurisdiction_ids\": [\n      0\n    ],\n    \"name\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"36401c2d-951c-4e1e-8c25-87f5cd1966a2","name":"getCompanyAccountingSalesTaxJurisdictionSet — Show a jurisdiction set","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/sales_tax/jurisdiction_sets/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","sales_tax","jurisdiction_sets",":id"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Show a jurisdiction set\n\nAny accounting grant. Requires the accounting:read scope."}},{"id":"12559eb5-5641-4783-8f99-f9d4d2508bae","name":"updateCompanyAccountingSalesTaxJurisdictionSet — Change a jurisdiction set","request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/sales_tax/jurisdiction_sets/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","sales_tax","jurisdiction_sets",":id"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Change a jurisdiction set\n\nDocuments already taxed keep their jurisdictions. Needs manage_coa; audited. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"jurisdiction_set\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"408db8ee-7480-4326-8d01-3216c3a85ac0","name":"listCompanyAccountingSalesTaxJurisdictions — List tax jurisdictions","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/sales_tax/jurisdictions","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","sales_tax","jurisdictions"],"query":[{"key":"state_code","value":"","disabled":true,"description":"Filter by state"}],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"List tax jurisdictions\n\nState, county, city and special-district jurisdictions the company maintains. Any accounting grant. Requires the accounting:read scope."}},{"id":"92246ce3-73f2-4902-800e-e96d7d72fe6c","name":"createCompanyAccountingSalesTaxJurisdiction — Add a tax jurisdiction","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/sales_tax/jurisdictions","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","sales_tax","jurisdictions"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Add a tax jurisdiction\n\nNeeds manage_coa over every entity; audited. State code ZZ marks fictional demo data. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"jurisdiction\": {\n    \"code\": \"\",\n    \"level\": \"state\",\n    \"name\": \"\",\n    \"state_code\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"8f069849-1b0c-4c0d-8cc0-a5ef93d1b330","name":"getCompanyAccountingSalesTaxJurisdiction — Show a tax jurisdiction","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/sales_tax/jurisdictions/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","sales_tax","jurisdictions",":id"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Show a tax jurisdiction\n\nWith its rate history, newest first. Any accounting grant. Requires the accounting:read scope."}},{"id":"bf4f4ffe-b30e-4ad4-8ca5-ee20b777f141","name":"updateCompanyAccountingSalesTaxJurisdiction — Change a tax jurisdiction","request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/sales_tax/jurisdictions/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","sales_tax","jurisdictions",":id"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Change a tax jurisdiction\n\nName, parent, files-with, filing frequency, liability accounts, active. Needs manage_coa; audited. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"jurisdiction\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"68a3d711-08d9-4a0e-8051-eb904316d51f","name":"listCompanyAccountingSalesTaxLiability — Sales and use tax liability by jurisdiction","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/sales_tax/liability","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","sales_tax","liability"],"query":[{"key":"from","value":"","disabled":false,"description":"Period start"},{"key":"to","value":"","disabled":false,"description":"Period end"},{"key":"entity_id","value":"","disabled":true,"description":"Entity"},{"key":"jurisdiction_id","value":"","disabled":true,"description":"A filing jurisdiction and those that file with it"}],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Sales and use tax liability by jurisdiction\n\nTax collected and use tax accrued from GL lines tagged to determinations; taxable, exempt (with certificates) and nontaxable bases from documents posted or reversed in the period; rates; and the GL tie-out per liability account. Project-scoped grants refused. Requires the accounting:read scope."}},{"id":"a8a5e8d4-692d-4105-8554-6256cd02948a","name":"listCompanyAccountingSalesTaxProjectSites — List job sites","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/sales_tax/project_sites","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","sales_tax","project_sites"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"List job sites\n\nEach project's job-site address and chosen jurisdiction set. A project-scoped grant sees its projects only. Requires the accounting:read scope."}},{"id":"a3369b03-333f-4dfc-8027-960f9f22555c","name":"getCompanyAccountingSalesTaxProjectSite — Show a project's job site","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/sales_tax/project_sites/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","sales_tax","project_sites",":id"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Show a project's job site\n\n{id} is the project id. Requires the accounting:read scope."}},{"id":"434340a6-be2d-430a-84af-3d9258b324fc","name":"replaceCompanyAccountingSalesTaxProjectSite — Set a project's job site","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/sales_tax/project_sites/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","sales_tax","project_sites",":id"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Set a project's job site\n\nThe address as entered and the jurisdiction set the user chose (no geocoding), with the contract type and nature the rules key on. Needs manage_coa; audited. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"site\": {\n    \"address_line1\": \"\",\n    \"city\": \"\",\n    \"contract_nature\": \"real_property\",\n    \"contract_type\": \"lump_sum\",\n    \"jurisdiction_set_id\": 0,\n    \"postal_code\": \"\",\n    \"region\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"ae695abc-58d9-4e15-86a8-4c58986c94c8","name":"listCompanyAccountingSalesTaxRates — List tax rates","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/sales_tax/rates","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","sales_tax","rates"],"query":[{"key":"jurisdiction_id","value":"","disabled":true,"description":"Filter by jurisdiction"},{"key":"needs_review","value":"","disabled":true,"description":"Filter by qualified-review state"}],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"List tax rates\n\nEffective-dated sales and use rates (percent). A used rate is immutable. Any accounting grant. Requires the accounting:read scope."}},{"id":"54282d63-c87a-4aa3-8ba9-a4e2f4ddb198","name":"createCompanyAccountingSalesTaxRatesImport — Import tax rates from CSV","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/sales_tax/rates/import","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","sales_tax","rates","import"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Import tax rates from CSV\n\nAll or nothing. Columns jurisdiction_code, effective_from, sales_rate, use_rate, source_citation; plus jurisdiction_name, level, state_code, parent_code to create a missing jurisdiction. A real (non-ZZ) jurisdiction's rate needs a citation and is stored needing qualified review. Equal rows are unchanged (a repeat is a no-op); a changed row, a date on or before an already-taxed date, or inside a closed period is refused. Needs manage_coa over every entity; audited. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"import\": {\n    \"csv\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"3bd59638-5115-489c-8ac5-7b26156d1976","name":"createCompanyAccountingSalesTaxRatesProviderSync — Import rates from a provider adapter","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/sales_tax/rates/provider_sync","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","sales_tax","rates","provider_sync"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Import rates from a provider adapter\n\nOnly the fake provider ships (no network call; fictional ZZ rates). Imported under the CSV rules. Needs manage_coa over every entity. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"sync\": {\n    \"as_of\": \"2026-01-31\",\n    \"jurisdiction_codes\": [\n      \"\"\n    ],\n    \"provider\": \"fake\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"fe6cc042-dd5b-4973-8eb2-81713634fb5d","name":"deleteCompanyAccountingSalesTaxRate — Delete an unused tax rate","request":{"method":"DELETE","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/sales_tax/rates/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","sales_tax","rates",":id"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Delete an unused tax rate\n\nA mistaken import; a rate a determination used is locked (409). Needs manage_coa; audited. Requires the accounting:write scope."}},{"id":"6bc3b814-4b39-4081-8a00-cec6ee1cd59a","name":"reviewCompanyAccountingSalesTaxRate — Record a qualified review of a rate","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/sales_tax/rates/:id/review","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","sales_tax","rates",":id","review"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Record a qualified review of a rate\n\nBy a different user than the one who imported it; once. Demo (ZZ) rates are never reviewed. Needs manage_coa; audited. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"review\": {\n    \"note\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"4405f8a7-97f9-4eec-8a2f-80cff41ec651","name":"listCompanyAccountingSalesTaxRules — List taxability rules","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/sales_tax/rules","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","sales_tax","rules"],"query":[{"key":"jurisdiction_id","value":"","disabled":true,"description":"Filter by jurisdiction"}],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"List taxability rules\n\nPer jurisdiction (and its descendants), contract nature and type, and category: contractor role and whether sales and use tax apply. Any accounting grant. Requires the accounting:read scope."}},{"id":"f703764b-4e75-4c95-826d-3ccb899b19b6","name":"createCompanyAccountingSalesTaxRule — Add a taxability rule","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/sales_tax/rules","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","sales_tax","rules"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Add a taxability rule\n\nA real jurisdiction's rule needs a source citation and is stored needing qualified review; it may not take effect on or before a date already taxed. Needs manage_coa; audited. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"rule\": {\n    \"category\": \"material\",\n    \"contractor_role\": \"consumer\",\n    \"effective_from\": \"2026-01-31\",\n    \"jurisdiction_id\": 0,\n    \"sales_taxable\": false,\n    \"use_taxable\": false\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"3c91769c-1a9f-4566-8a39-8911cb582d64","name":"updateCompanyAccountingSalesTaxRule — Change or end a taxability rule","request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/sales_tax/rules/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","sales_tax","rules",":id"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Change or end a taxability rule\n\nAn unused rule may change; a used rule may only be ended (effective_to) on or after its last use. Needs manage_coa; audited. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"rule\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"20394020-4994-4e7a-8c5e-1a716c676a6e","name":"listCompanyAccountingSalesTaxSettings — Sales tax settings","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/sales_tax/settings","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","sales_tax","settings"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Sales tax settings\n\nRounding method (line or invoice) and default sales and use tax payable accounts; unset accounts fall back to the chart's SALES_TAX_PAYABLE and USE_TAX_PAYABLE. Any accounting grant. Requires the accounting:read scope."}},{"id":"4bb41c4c-8b90-4590-8818-93fabd4b38a3","name":"replaceCompanyAccountingSalesTaxSettings — Update sales tax settings","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/sales_tax/settings","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","sales_tax","settings"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Update sales tax settings\n\nNeeds manage_coa over every entity; audited. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"settings\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"235905b0-be39-45fd-8dbc-1cf8bf402782","name":"listCompanyAccountingSalesTaxUseTaxAccruals — List use tax accruals","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/sales_tax/use_tax/accruals","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","sales_tax","use_tax","accruals"],"query":[{"key":"bill_id","value":"","disabled":true,"description":"Filter by bill"}],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"List use tax accruals\n\nProject-scoped grants refused; entity-scoped grants see their entities. Requires the accounting:read scope."}},{"id":"6c384b2c-d49e-4a90-8aef-f5e470289184","name":"createCompanyAccountingSalesTaxUseTaxAccrual — Accrue use tax on a posted bill","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/sales_tax/use_tax/accruals","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","sales_tax","use_tax","accruals"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Accrue use tax on a posted bill\n\nDr each line's cost (job cost or expense) / Cr each jurisdiction's use tax payable, on the bill's posting date or the date given (closed periods refused). vendor_tax_charged is credited against the tax owed. Overrides (exclude or include a line) need a reason and are audited. One posted accrual per bill: the same request returns it (200), a different one is 409. Needs post_journal. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"accrual\": {\n    \"bill_id\": 0\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"fda3d107-2719-4857-8fba-064b2152278d","name":"getCompanyAccountingSalesTaxUseTaxAccrual — Show a use tax accrual","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/sales_tax/use_tax/accruals/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","sales_tax","use_tax","accruals",":id"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Show a use tax accrual\n\nWith its determinations. Project-scoped grants refused. Requires the accounting:read scope."}},{"id":"84d2bc7a-8069-4563-8dfb-316397f27d96","name":"reverseCompanyAccountingSalesTaxUseTaxAccrual — Reverse a use tax accrual","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/sales_tax/use_tax/accruals/:id/reverse","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","sales_tax","use_tax","accruals",":id","reverse"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Reverse a use tax accrual\n\nPosts the reversal on the date given; the bill may then be accrued again. Needs approve_journal; audited. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"reversal\": {\n    \"date\": \"2026-01-31\",\n    \"reason\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"29a9019e-9d03-442d-879d-d9798c853a34","name":"listCompanyAccountingSalesTaxUseTaxCandidates — Bills that may owe use tax","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/sales_tax/use_tax/candidates","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","sales_tax","use_tax","candidates"],"query":[{"key":"from","value":"","disabled":false,"description":"Posting date from"},{"key":"to","value":"","disabled":false,"description":"Posting date to"},{"key":"entity_id","value":"","disabled":true,"description":"Entity"}],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Bills that may owe use tax\n\nPosted bills in [from, to] with no accrual, each with the line review and the use tax owed if the vendor charged none. Preview only. Project-scoped grants refused. Requires the accounting:read scope."}},{"id":"e0fa6332-d018-4012-8780-474730d8cc65","name":"listCompanyAccountingSettings — Show accounting settings","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/settings","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","settings"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Show accounting settings\n\nBase currency, fiscal year start month, default entity, the manual journal approval threshold and the control-account map (one account per system role such as AP_CONTROL or RETAINED_EARNINGS). Any accounting grant can read it. Requires the accounting:read scope."}},{"id":"386b89c4-760d-45f3-82f9-43eb5fb9f6a3","name":"updateCompanyAccountingSettings — Update accounting settings","request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/settings","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","settings"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Update accounting settings\n\nChanges settings and remaps control accounts: `control_accounts` maps a system role to a postable account id (null clears it). Needs the manage_coa permission. Audited in the same transaction. Requires the accounting:write scope. Changing require_mfa_for, require_mfa_for_accounting or step_up_minutes needs an accounting owner or manage_grants (403), is audited as mfa_policy_changed, and, like a sod_mode change, needs step-up. Step-up: from a browser session this needs an authenticator code re-entered within settings step_up_minutes (401 step_up_required); a user without a factor is refused (403 mfa_required) unless the MFA policy is off entirely (require_mfa_for empty and require_mfa_for_accounting off). An API token cannot re-enter a code: it passes only when it holds the accounting:step_up scope (403 step_up_required otherwise; the MFA policy still applies to its user); each such use writes a step_up_token audit row.","body":{"mode":"raw","raw":"{\n  \"settings\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"17bc4770-bf69-4cbb-895d-130d191df35c","name":"listCompanyAccountingSettingsEdition — Get the accounting edition","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/settings/edition","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","settings","edition"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Get the accounting edition\n\nThe edition, its areas with admin overrides, the control policies in force, kept controls, recommended roles and the edition catalog. Any accounting grant (view_ledger). Requires the accounting:read scope."}},{"id":"6727b1da-50ad-4e02-8f70-b752a25d9b69","name":"replaceCompanyAccountingSettingsEdition — Apply an edition","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/settings/edition","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","settings","edition"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Apply an edition\n\nApplies the edition previewed with GET settings/edition/preview: confirm_hash must equal that preview's hash (409 edition_preview_stale otherwise). A weaker control needs a reason (422 edition_weaker_reason_required) unless keep_controls keeps every weaker control at its current value; an in-use control (required reconciliations or close tasks in open periods, or dunning while open invoices are mid-cadence) is refused (422 edition_downgrade_blocked) unless keep_controls. Area overrides reset to the edition. Dunning is written to the AR collections settings (ar_approve), creating the default policy when switched on in a company with none. Never deletes data. Audited (edition_applied, plus the settings control actions). Needs manage_coa and manage_grants on an unrestricted grant, and step-up. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"edition\": {\n    \"confirm_hash\": \"\",\n    \"key\": \"essentials\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"4814a7ac-cd33-42b0-8eb2-644e5ae8305a","name":"updateCompanyAccountingSettingsEdition — Override edition areas","request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/settings/edition","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","settings","edition"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Override edition areas\n\nShows or hides individual areas on top of the edition (setting an area back to its edition default clears the override) and switches AR dunning reminders (written to the collections settings; a reason is needed to switch them off, and switching off is refused while invoices are mid-cadence). Areas are navigation only. Audited (edition_overridden). Needs manage_coa on an unrestricted grant and an edition. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"edition\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"ed51cc14-bcd3-48ca-8a0a-ee09c5eadf3b","name":"listCompanyAccountingSettingsEditionPreview — Preview an edition change","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/settings/edition/preview","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","settings","edition","preview"],"query":[{"key":"edition","value":"","disabled":true}],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Preview an edition change\n\nEvery area and policy the edition would change, the direction of each control change (stronger or weaker), warnings for hidden areas that hold data, blocked in-use controls, and the hash to confirm with. `edition` defaults to the current edition. Needs manage_coa. Requires the accounting:read scope."}},{"id":"253407bf-1950-49c4-8455-b09cf680fd8c","name":"listCompanyAccountingSettingsSetup — Get guided setup progress","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/settings/setup","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","settings","setup"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Get guided setup progress\n\nEach step's status (an explicit mark, else what the data proves), the first open step, the profile and its recommendation, and the go-live checklist. Needs manage_coa. Requires the accounting:read scope."}},{"id":"94c1473c-a3c6-4b95-829f-57f739e7cfb2","name":"replaceCompanyAccountingSettingsSetup — Record a setup step","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/settings/setup","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","settings","setup"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Record a setup step\n\nMarks a step done, skipped (bank accounts, opening balances, users only) or pending again. Idempotent: the same mark again writes nothing. Steps proved by data (edition, chart, entities, bank accounts, opening balances) are done only when the data exists; go_live only when every checklist item passes. Audited (setup_step_recorded, setup_completed). Needs manage_coa on an unrestricted grant. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"setup\": {\n    \"status\": \"done\",\n    \"step\": \"profile\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"846bc3f9-7b80-47d4-8ed4-0c28b9fa71f0","name":"listCompanyAccountingSodConflicts — Segregation of duties conflict report","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/sod_conflicts","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","sod_conflicts"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Segregation of duties conflict report\n\nEvery member whose effective duties (grant flags plus approval flags reached through active or scheduled delegations) match an enabled rule, with each duty's source and the evidence: the grant, its last audited change and SoD reason, and the delegations completing the combination. Company administrators are implicit owners. Needs manage_grants on an unrestricted grant. Requires accounting:read."}},{"id":"809850e1-4b07-4caf-8af3-ab59bd4ca5b2","name":"listCompanyAccountingSodRules — List segregation of duties rules","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/sod_rules","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","sod_rules"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"List segregation of duties rules\n\nThe built-in default rules (source default, or customized when the company changed their severity, wording or on/off) followed by the company's custom rules. Needs manage_grants on an unrestricted grant. Requires accounting:read."}},{"id":"14b32a7b-d186-4211-89db-c720f01468c7","name":"replaceCompanyAccountingSodRule — Create or change a segregation of duties rule","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/sod_rules/:rule_key","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","sod_rules",":rule_key"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"rule_key","value":"","description":"Rule key (lowercase letters, digits and underscores)"}]},"description":"Create or change a segregation of duties rule\n\nCreates a custom rule (name, 2-4 duties, severity, risk) or changes one: a built-in rule's severity, wording and on/off (its duties are fixed), a custom rule's duties too. Every change needs a reason and is audited with before and after; weakening (block to warn, off, other duties) is flagged as sod_rule_weakened. Existing grants are never changed: current_holders lists who already holds the combination; their next grant change needs a reason. Needs manage_grants on an unrestricted grant and step-up (a token needs accounting:step_up). Requires accounting:write.","body":{"mode":"raw","raw":"{\n  \"sod_rule\": {\n    \"enabled\": false,\n    \"reason\": \"\",\n    \"severity\": \"warn\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"13889cbc-72d1-4e37-8b0e-a684415a7d17","name":"listCompanyAccountingTaxCodes — List tax codes","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/tax_codes","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","tax_codes"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"List tax codes\n\nSales and use tax codes. Each code has one or more components, each with its own rate and liability account; `total_rate` is their sum. Requires the accounting:read scope."}},{"id":"c6ad8f13-a6fe-4eab-8dbf-87d4749c19ba","name":"createCompanyAccountingTaxCode — Create a tax code","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/tax_codes","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","tax_codes"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Create a tax code\n\nAdds a tax code with its components. Component accounts must be postable accounts of this company. Needs manage_coa. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"tax_code\": {\n    \"code\": \"\",\n    \"components\": [\n      {\n        \"account_id\": 0,\n        \"name\": \"\",\n        \"rate\": \"\"\n      }\n    ],\n    \"name\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"ed40aae9-03eb-479d-8981-90d6783d1162","name":"updateCompanyAccountingTaxCode — Update a tax code","request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/tax_codes/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","tax_codes",":id"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Update a tax code\n\nEdits a tax code; `components` replaces every component. Needs manage_coa. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"tax_code\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"808b620a-f2c0-4e10-8935-2f7783aec2ef","name":"listCompanyAccountingTaxExemptionCertificates — List customer tax exemption certificates","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/tax_exemption_certificates","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","tax_exemption_certificates"],"query":[{"key":"customer_id","value":"","disabled":true}],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"List customer tax exemption certificates\n\nUp to 500, optionally for one customer. Requires the accounting:read scope."}},{"id":"8a3ab2a7-291d-41f9-8bc2-d365d7b3d305","name":"createCompanyAccountingTaxExemptionCertificate — Record a customer tax exemption certificate","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/tax_exemption_certificates","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","tax_exemption_certificates"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Record a customer tax exemption certificate\n\nA certificate valid on the invoice date in the job state removes sales tax from pay-app invoices and blocks it on manual invoices; once expired, tax applies and the invoice carries a warning. Needs manage_coa. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"certificate\": {\n    \"certificate_number\": \"\",\n    \"customer_id\": 0,\n    \"effective_from\": \"2026-01-31\",\n    \"reason\": \"\",\n    \"state_code\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"9670be82-4928-43cb-8ab6-305ca3cb51e4","name":"updateCompanyAccountingTaxExemptionCertificate — Change a certificate expiry","request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/tax_exemption_certificates/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","tax_exemption_certificates",":id"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Change a certificate expiry\n\nOnly expires_on changes; enter a new certificate for other corrections. Needs manage_coa. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"certificate\": {\n    \"expires_on\": \"2026-01-31\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"4a3c3e2b-276b-411a-8782-6b6186c471bc","name":"listCompanyAccountingTerms — List payment terms","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/terms","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","terms"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"List payment terms\n\nCompany payment terms with due days and optional early-payment discount. Requires the accounting:read scope."}},{"id":"65c8e490-751a-4505-8a86-5e631876df0a","name":"createCompanyAccountingTerm — Create a payment term","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/terms","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","terms"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Create a payment term\n\nAdds a term such as Net 30 or 2% 10, net 30. Needs manage_coa. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"term\": {\n    \"code\": \"\",\n    \"due_days\": 0,\n    \"name\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"373ad666-3029-4396-8303-776a51613ee4","name":"updateCompanyAccountingTerm — Update a payment term","request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/terms/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","terms",":id"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"},{"key":"id","value":""}]},"description":"Update a payment term\n\nEdits or deactivates a term. Needs manage_coa. Requires the accounting:write scope.","body":{"mode":"raw","raw":"{\n  \"term\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"95d19237-3371-4abe-8d93-5ce18337efc9","name":"listCompanyAccountingTrialBalance — Trial balance","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/accounting/trial_balance","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","accounting","trial_balance"],"query":[{"key":"as_of","value":"","disabled":true,"description":"Inclusive end date (default today)"},{"key":"from","value":"","disabled":true,"description":"Inclusive start date (activity only)"},{"key":"entity_id","value":"","disabled":true,"description":"One entity"},{"key":"project_id","value":"","disabled":true,"description":"One project"},{"key":"department_id","value":"","disabled":true,"description":"One department"},{"key":"group_by","value":"","disabled":true,"description":"Split rows by a dimension. `dimension:<code>` groups by a user-defined dimension: dimension_id on each row is then the value id (null = lines with no value), rolled up by dimension_level; the rows of each account sum to its ungrouped balance."},{"key":"dimension_level","value":"","disabled":true,"description":"With group_by=dimension:<code>: roll values up to this hierarchy level (1 = top-level values); omitted = the posted value."},{"key":"dimension_value_ids","value":"","disabled":true,"description":"Comma-separated dimension value ids: lines carrying one of them or a child value (values of one dimension OR, dimensions AND)."},{"key":"include_zero","value":"","disabled":true,"description":"Also list postable accounts with no activity"}],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company id; must be the token's company"}]},"description":"Trial balance\n\nDebit and credit totals and the net balance per account from posted lines up to `as_of` (default today), optionally from `from`. Split by a dimension with `group_by` (entity, project, department, cost_code), or restrict to one entity, project or department. Net debit and net credit totals are always equal. Requires the accounting:read scope."}}]},{"name":"Action Plans","description":"Module: action_plans","item":[{"id":"bdf43d51-679d-46c2-8d94-b730f298df1e","name":"listCompanyActionPlansPlanTemplates — GET /rest/v1.0/companies/{company_id}/action_plans/plan_templates","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/action_plans/plan_templates","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","action_plans","plan_templates"],"variable":[{"key":"company_id","value":"{{companyId}}"}]},"description":"GET /rest/v1.0/companies/{company_id}/action_plans/plan_templates"}},{"id":"4c60b047-f013-49f6-8e17-70a0eb7c0a9f","name":"createCompanyActionPlansPlanTemplate — POST /rest/v1.0/companies/{company_id}/action_plans/plan_templates","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/action_plans/plan_templates","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","action_plans","plan_templates"],"variable":[{"key":"company_id","value":"{{companyId}}"}]},"description":"POST /rest/v1.0/companies/{company_id}/action_plans/plan_templates"}},{"id":"5dd1a83e-2c1d-447c-8a7f-40b19bd8737b","name":"listCompanyActionPlansPlanTemplatesRecycleBin — List recycled action plan templates","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/action_plans/plan_templates/recycle_bin","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","action_plans","plan_templates","recycle_bin"],"query":[{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true},{"key":"filters[status]","value":"","disabled":true,"description":"Comma-separated or repeated draft, in_revision, published values; unsupported values are ignored."},{"key":"filters[query]","value":"","disabled":true,"description":"First supplied value searches title or description case-insensitively."}],"variable":[{"key":"company_id","value":"{{companyId}}"}]},"description":"List recycled action plan templates\n\nRequires action_plans:read. Requires authentication and a matching token company. Returns soft-deleted company templates ordered by ID, including deleted=true and deleted_at. Catalog presence does not grant authorization."}},{"id":"0170f349-e49d-4a79-8ad9-ec2c36f898c6","name":"getCompanyActionPlansPlanTemplate — GET /rest/v1.0/companies/{company_id}/action_plans/plan_templates/{id}","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/action_plans/plan_templates/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","action_plans","plan_templates",":id"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"GET /rest/v1.0/companies/{company_id}/action_plans/plan_templates/{id}"}},{"id":"db9b539c-ee1f-442e-83c3-7b2e68e65a4a","name":"updateCompanyActionPlansPlanTemplate — PATCH /rest/v1.0/companies/{company_id}/action_plans/plan_templates/{id}","request":{"method":"PATCH","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/action_plans/plan_templates/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","action_plans","plan_templates",":id"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"PATCH /rest/v1.0/companies/{company_id}/action_plans/plan_templates/{id}"}},{"id":"cf4222d6-abb5-49cb-8747-ee11b3ed838d","name":"deleteCompanyActionPlansPlanTemplate — Recycle an action plan template","request":{"method":"DELETE","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/action_plans/plan_templates/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","action_plans","plan_templates",":id"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Recycle an action plan template\n\nRequires action_plans:write. Requires matching token company and company delete permission. Soft-deletes the company template. Returns HTTP 200 with no body. Catalog presence does not grant authorization."}},{"id":"49a1c00d-fabb-4cbd-8938-12702cce36ec","name":"publishCompanyActionPlansPlanTemplate — Publish an action plan template","request":{"method":"PATCH","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/action_plans/plan_templates/:id/publish","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","action_plans","plan_templates",":id","publish"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Publish an action plan template\n\nRequires action_plans:write. Requires matching token company and company edit permission. Sets status to published so the template can be used to create plans. Catalog presence does not grant authorization."}},{"id":"9fa943ca-0871-4d20-85ed-b38d5f2fbc92","name":"reviseCompanyActionPlansPlanTemplate — Revise an action plan template","request":{"method":"PATCH","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/action_plans/plan_templates/:id/revise","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","action_plans","plan_templates",":id","revise"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Revise an action plan template\n\nRequires action_plans:write. Requires matching token company and company edit permission. Sets status to in_revision, allowing edits to assignments and blocking configuration. Catalog presence does not grant authorization."}},{"id":"aabdb8e5-5def-4983-857e-08067d716cb2","name":"listProjectActionPlansFilterOptionsStatus — GET /rest/v1.0/projects/{project_id}/action_plans/filter_options/status","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/action_plans/filter_options/status","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","action_plans","filter_options","status"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"GET /rest/v1.0/projects/{project_id}/action_plans/filter_options/status"}},{"id":"37c433ac-27e1-4446-89fe-65f40736392c","name":"listProjectActionPlansParties — GET /rest/v1.0/projects/{project_id}/action_plans/parties","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/action_plans/parties","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","action_plans","parties"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"GET /rest/v1.0/projects/{project_id}/action_plans/parties"}},{"id":"eccc28ed-8455-4cc1-8fd8-631ec9349fa1","name":"listProjectActionPlansPlanApprovers — GET /rest/v1.0/projects/{project_id}/action_plans/plan_approvers","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/action_plans/plan_approvers","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","action_plans","plan_approvers"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"GET /rest/v1.0/projects/{project_id}/action_plans/plan_approvers"}},{"id":"c777b595-d431-4f17-89cf-e2a3fa6cfd59","name":"createProjectActionPlansPlanApprover — POST /rest/v1.0/projects/{project_id}/action_plans/plan_approvers","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/action_plans/plan_approvers","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","action_plans","plan_approvers"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"POST /rest/v1.0/projects/{project_id}/action_plans/plan_approvers"}},{"id":"3e02c812-9b55-4ea0-8550-cbf78496ddfe","name":"getProjectActionPlansPlanApprover — GET /rest/v1.0/projects/{project_id}/action_plans/plan_approvers/{plan_approver_id}","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/action_plans/plan_approvers/:plan_approver_id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","action_plans","plan_approvers",":plan_approver_id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"plan_approver_id","value":""}]},"description":"GET /rest/v1.0/projects/{project_id}/action_plans/plan_approvers/{plan_approver_id}"}},{"id":"b9164f58-97c9-4bea-81a1-e72b7c2a0077","name":"deleteProjectActionPlansPlanApprover — Remove a plan approver","request":{"method":"DELETE","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/action_plans/plan_approvers/:plan_approver_id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","action_plans","plan_approvers",":plan_approver_id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"plan_approver_id","value":""}]},"description":"Remove a plan approver\n\nRequires action_plans:write. Requires project action_plans delete permission, an enabled tool, matching tenant and visible plan. Permanently removes the party record from the visible plan. Catalog presence does not grant authorization."}},{"id":"fd4e868e-7a3b-4f1f-8c2e-4552844b9e4b","name":"signatureProjectActionPlansPlanApprover — Capture a plan approver signature","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/action_plans/plan_approvers/:plan_approver_id/signature","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","action_plans","plan_approvers",":plan_approver_id","signature"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"plan_approver_id","value":""}]},"description":"Capture a plan approver signature\n\nRequires action_plans:write. Requires project action_plans edit permission, an enabled tool, matching tenant and visible plan. The signer must be the assigned party user. Omitted or null signed_off_by_id uses the actor; representing another signer requires project action_plans admin permission. Replaces a previous signature. filename and url store metadata only; this endpoint does not upload or fetch image bytes. Catalog presence does not grant authorization.","body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}}}},{"id":"3c25f77b-c791-4acf-8bd1-cf69b72ae799","name":"signatureProjectActionPlansPlanApproverPatch — PATCH /rest/v1.0/projects/{project_id}/action_plans/plan_approvers/{plan_approver_id}/signature","request":{"method":"PATCH","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/action_plans/plan_approvers/:plan_approver_id/signature","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","action_plans","plan_approvers",":plan_approver_id","signature"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"plan_approver_id","value":""}]},"description":"PATCH /rest/v1.0/projects/{project_id}/action_plans/plan_approvers/{plan_approver_id}/signature"}},{"id":"b05124c4-2d4a-45fd-87e5-5e61d3c89350","name":"deleteSignatureProjectActionPlansPlanApprover — Clear a plan approver signature","request":{"method":"DELETE","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/action_plans/plan_approvers/:plan_approver_id/signature","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","action_plans","plan_approvers",":plan_approver_id","signature"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"plan_approver_id","value":""}]},"description":"Clear a plan approver signature\n\nRequires action_plans:write. Requires project action_plans edit permission, an enabled tool, matching tenant and visible plan. Clears signature metadata without removing the party. Only the assigned user or a project action_plans administrator may clear it. Catalog presence does not grant authorization."}},{"id":"5f995bce-136a-4b74-87a4-0f8e6ceaace1","name":"listProjectActionPlansPlanReceivers — GET /rest/v1.0/projects/{project_id}/action_plans/plan_receivers","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/action_plans/plan_receivers","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","action_plans","plan_receivers"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"GET /rest/v1.0/projects/{project_id}/action_plans/plan_receivers"}},{"id":"d4add757-4006-461f-85b1-dc0d4a4f3d3a","name":"createProjectActionPlansPlanReceiver — POST /rest/v1.0/projects/{project_id}/action_plans/plan_receivers","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/action_plans/plan_receivers","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","action_plans","plan_receivers"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"POST /rest/v1.0/projects/{project_id}/action_plans/plan_receivers"}},{"id":"5259039b-5910-4c9d-8729-1786f2d16b63","name":"getProjectActionPlansPlanReceiver — GET /rest/v1.0/projects/{project_id}/action_plans/plan_receivers/{plan_receiver_id}","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/action_plans/plan_receivers/:plan_receiver_id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","action_plans","plan_receivers",":plan_receiver_id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"plan_receiver_id","value":""}]},"description":"GET /rest/v1.0/projects/{project_id}/action_plans/plan_receivers/{plan_receiver_id}"}},{"id":"65010385-d293-4943-8c81-56556de0613d","name":"deleteProjectActionPlansPlanReceiver — Remove a plan receiver","request":{"method":"DELETE","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/action_plans/plan_receivers/:plan_receiver_id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","action_plans","plan_receivers",":plan_receiver_id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"plan_receiver_id","value":""}]},"description":"Remove a plan receiver\n\nRequires action_plans:write. Requires project action_plans delete permission, an enabled tool, matching tenant and visible plan. Permanently removes the party record from the visible plan. Catalog presence does not grant authorization."}},{"id":"b24188a8-e343-4166-8630-b281c72fc580","name":"signatureProjectActionPlansPlanReceiver — Capture a plan receiver signature","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/action_plans/plan_receivers/:plan_receiver_id/signature","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","action_plans","plan_receivers",":plan_receiver_id","signature"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"plan_receiver_id","value":""}]},"description":"Capture a plan receiver signature\n\nRequires action_plans:write. Requires project action_plans edit permission, an enabled tool, matching tenant and visible plan. The signer must be the assigned party user. Omitted or null signed_off_by_id uses the actor; representing another signer requires project action_plans admin permission. Replaces a previous signature. filename and url store metadata only; this endpoint does not upload or fetch image bytes. Catalog presence does not grant authorization.","body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}}}},{"id":"a5a5f7c9-83a6-4cb2-89b9-a8f00f7d299d","name":"signatureProjectActionPlansPlanReceiverPatch — PATCH /rest/v1.0/projects/{project_id}/action_plans/plan_receivers/{plan_receiver_id}/signature","request":{"method":"PATCH","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/action_plans/plan_receivers/:plan_receiver_id/signature","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","action_plans","plan_receivers",":plan_receiver_id","signature"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"plan_receiver_id","value":""}]},"description":"PATCH /rest/v1.0/projects/{project_id}/action_plans/plan_receivers/{plan_receiver_id}/signature"}},{"id":"4e6b62c5-455d-40b4-8f56-efc3827304ba","name":"deleteSignatureProjectActionPlansPlanReceiver — Clear a plan receiver signature","request":{"method":"DELETE","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/action_plans/plan_receivers/:plan_receiver_id/signature","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","action_plans","plan_receivers",":plan_receiver_id","signature"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"plan_receiver_id","value":""}]},"description":"Clear a plan receiver signature\n\nRequires action_plans:write. Requires project action_plans edit permission, an enabled tool, matching tenant and visible plan. Clears signature metadata without removing the party. Only the assigned user or a project action_plans administrator may clear it. Catalog presence does not grant authorization."}},{"id":"13791e52-d782-4da0-8653-92c3fc01a1c6","name":"listProjectActionPlansPlans — GET /rest/v1.0/projects/{project_id}/action_plans/plans","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/action_plans/plans","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","action_plans","plans"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"GET /rest/v1.0/projects/{project_id}/action_plans/plans"}},{"id":"ab96bb3b-f83c-4e25-87a8-b7e19296bb76","name":"createProjectActionPlansPlan — POST /rest/v1.0/projects/{project_id}/action_plans/plans","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/action_plans/plans","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","action_plans","plans"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"POST /rest/v1.0/projects/{project_id}/action_plans/plans"}},{"id":"f972f9e2-c383-41df-817f-75f214dd8b50","name":"createProjectActionPlansPlansCreateFromTemplate — Create an action plan from a published template","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/action_plans/plans/create_from_template","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","action_plans","plans","create_from_template"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Create an action plan from a published template\n\nRequires action_plans:write. Requires project action_plans create permission, an enabled tool, matching tenant and visible plan. The template must be live, published and in the same company. Creates a draft plan with copied template items and assignments. Null or blank title falls back to the template title. Referenced users and plan visibility are validated. Catalog presence does not grant authorization.","body":{"mode":"raw","raw":"{\n  \"plan\": {\n    \"plan_template_id\": 0\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"bae98e80-a755-4e47-8e7e-992b283c9e7e","name":"listProjectActionPlansPlansRecycleBin — GET /rest/v1.0/projects/{project_id}/action_plans/plans/recycle_bin","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/action_plans/plans/recycle_bin","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","action_plans","plans","recycle_bin"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"GET /rest/v1.0/projects/{project_id}/action_plans/plans/recycle_bin"}},{"id":"804075eb-2012-4d1b-84b4-e916120fc169","name":"getProjectActionPlansPlan — GET /rest/v1.0/projects/{project_id}/action_plans/plans/{id}","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/action_plans/plans/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","action_plans","plans",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"GET /rest/v1.0/projects/{project_id}/action_plans/plans/{id}"}},{"id":"5597b81a-9acb-4ab2-8a5e-1db2fd7fc42b","name":"updateProjectActionPlansPlan — PATCH /rest/v1.0/projects/{project_id}/action_plans/plans/{id}","request":{"method":"PATCH","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/action_plans/plans/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","action_plans","plans",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"PATCH /rest/v1.0/projects/{project_id}/action_plans/plans/{id}"}},{"id":"839fd706-e230-4f9a-809c-ffd34ccab458","name":"listProjectActionPlansPlanItems — GET /rest/v1.0/projects/{project_id}/action_plans/plans/{id}/items","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/action_plans/plans/:id/items","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","action_plans","plans",":id","items"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"GET /rest/v1.0/projects/{project_id}/action_plans/plans/{id}/items"}},{"id":"4666d723-2894-4c27-8c18-1490cdfca73d","name":"createProjectActionPlansPlanItem — POST /rest/v1.0/projects/{project_id}/action_plans/plans/{id}/items","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/action_plans/plans/:id/items","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","action_plans","plans",":id","items"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"POST /rest/v1.0/projects/{project_id}/action_plans/plans/{id}/items"}},{"id":"ed683aca-06e2-4801-821d-48218fc9d8d6","name":"getProjectActionPlansPlanItem — GET /rest/v1.0/projects/{project_id}/action_plans/plans/{id}/items/{item_id}","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/action_plans/plans/:id/items/:item_id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","action_plans","plans",":id","items",":item_id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""},{"key":"item_id","value":""}]},"description":"GET /rest/v1.0/projects/{project_id}/action_plans/plans/{id}/items/{item_id}"}},{"id":"6927ab2c-fc84-4d79-8429-da904669cff3","name":"updateProjectActionPlansPlanItem — PATCH /rest/v1.0/projects/{project_id}/action_plans/plans/{id}/items/{item_id}","request":{"method":"PATCH","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/action_plans/plans/:id/items/:item_id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","action_plans","plans",":id","items",":item_id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""},{"key":"item_id","value":""}]},"description":"PATCH /rest/v1.0/projects/{project_id}/action_plans/plans/{id}/items/{item_id}"}},{"id":"44a82b47-430a-46ef-84bc-1244ff3dbcf8","name":"deleteProjectActionPlansPlanItem — Delete an action plan item","request":{"method":"DELETE","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/action_plans/plans/:id/items/:item_id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","action_plans","plans",":id","items",":item_id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""},{"key":"item_id","value":""}]},"description":"Delete an action plan item\n\nRequires action_plans:write. Requires project action_plans delete permission, an enabled tool, matching tenant and visible plan. Permanently deletes the item, despite the service recycle name. Plans with configured assignments or blocking scopes must be draft or in_revision. Recalculates plan completion. Catalog presence does not grant authorization."}},{"id":"2b2e3b00-f079-4740-8780-c48fcc11008f","name":"assignProjectActionPlansPlanItem — PATCH /rest/v1.0/projects/{project_id}/action_plans/plans/{id}/items/{item_id}/assign","request":{"method":"PATCH","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/action_plans/plans/:id/items/:item_id/assign","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","action_plans","plans",":id","items",":item_id","assign"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""},{"key":"item_id","value":""}]},"description":"PATCH /rest/v1.0/projects/{project_id}/action_plans/plans/{id}/items/{item_id}/assign"}},{"id":"90a88d0d-2c3d-43b3-8359-bacdcc0ee738","name":"signOffProjectActionPlansPlanItemAssignment — Sign an individual plan-item assignment","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/action_plans/plans/:id/items/:item_id/assignments/:assignment_id/sign_off","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","action_plans","plans",":id","items",":item_id","assignments",":assignment_id","sign_off"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""},{"key":"item_id","value":""},{"key":"assignment_id","value":""}]},"description":"Sign an individual plan-item assignment\n\nRequires action_plans:write. Requires project action_plans edit permission, an enabled tool, matching tenant and visible plan. Signs only this assignment; it does not close the item. The signer must be its assigned user; representing another signer requires project action_plans admin permission. Configured plans must be published; already signed or blocked assignments return 409. Workflow integrity is rechecked. Catalog presence does not grant authorization.","body":{"mode":"raw","raw":"{\n  \"plan_item_sign_off\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"2b99d5d0-2992-46c3-85d4-854b49bf97db","name":"deleteSignOffProjectActionPlansPlanItemAssignment — Clear an individual assignment signature","request":{"method":"DELETE","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/action_plans/plans/:id/items/:item_id/assignments/:assignment_id/sign_off","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","action_plans","plans",":id","items",":item_id","assignments",":assignment_id","sign_off"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""},{"key":"item_id","value":""},{"key":"assignment_id","value":""}]},"description":"Clear an individual assignment signature\n\nRequires action_plans:write. Requires project action_plans edit permission, an enabled tool, matching tenant and visible plan. Clears the assignment signature and recalculates plan completion. Only its assigned user or a project action_plans administrator may clear it. Configured plans must be published; downstream integrity conflicts return 409. Catalog presence does not grant authorization."}},{"id":"1edae6cc-eee5-4a2b-88fa-1e901f0adeba","name":"referenceProjectActionPlansPlanItem — Set or clear an item source reference","request":{"method":"PATCH","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/action_plans/plans/:id/items/:item_id/reference","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","action_plans","plans",":id","items",":item_id","reference"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""},{"key":"item_id","value":""}]},"description":"Set or clear an item source reference\n\nRequires action_plans:write. Requires project action_plans edit permission, an enabled tool, matching tenant and visible plan. Both fields must be non-null or both null. Linking requires the source tool read scope and live source-record visibility in this project; unavailable sources are rejected. The response redacts source details when the caller lacks source access. Catalog presence does not grant authorization.","body":{"mode":"raw","raw":"{\n  \"plan_item_reference\": {\n    \"ref_id\": 0,\n    \"ref_tool_slug\": \"submittals\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"251d580b-4703-445c-8d90-ac8fbd7bec28","name":"deleteReferenceProjectActionPlansPlanItem — Clear an item source reference","request":{"method":"DELETE","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/action_plans/plans/:id/items/:item_id/reference","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","action_plans","plans",":id","items",":item_id","reference"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""},{"key":"item_id","value":""}]},"description":"Clear an item source reference\n\nRequires action_plans:write. Requires project action_plans edit permission, an enabled tool, matching tenant and visible plan. Clears both reference fields without deleting the item; returns the updated item. Catalog presence does not grant authorization."}},{"id":"e09d079b-e3e1-45a8-8515-9926078d5cfb","name":"signOffProjectActionPlansPlanItem — POST /rest/v1.0/projects/{project_id}/action_plans/plans/{id}/items/{item_id}/sign_off","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/action_plans/plans/:id/items/:item_id/sign_off","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","action_plans","plans",":id","items",":item_id","sign_off"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""},{"key":"item_id","value":""}]},"description":"POST /rest/v1.0/projects/{project_id}/action_plans/plans/{id}/items/{item_id}/sign_off"}},{"id":"c1c63562-5603-4666-84cd-bfe4b46ed0e5","name":"deleteSignOffProjectActionPlansPlanItem — DELETE /rest/v1.0/projects/{project_id}/action_plans/plans/{id}/items/{item_id}/sign_off","request":{"method":"DELETE","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/action_plans/plans/:id/items/:item_id/sign_off","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","action_plans","plans",":id","items",":item_id","sign_off"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""},{"key":"item_id","value":""}]},"description":"DELETE /rest/v1.0/projects/{project_id}/action_plans/plans/{id}/items/{item_id}/sign_off"}},{"id":"1c31880e-afcf-46d1-83d5-833fa4bcc300","name":"publishProjectActionPlansPlan — Publish an action plan","request":{"method":"PATCH","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/action_plans/plans/:id/publish","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","action_plans","plans",":id","publish"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Publish an action plan\n\nRequires action_plans:write. Requires project action_plans edit permission, an enabled tool, matching tenant and visible plan. Sets status to in_progress. Every legacy hold point must have an explicit blocking scope or the operation returns 409. Source details retain their independent read-scope and record-visibility checks. Catalog presence does not grant authorization."}},{"id":"26ebc84b-4a95-49fc-840f-5e8c27661b14","name":"recycleProjectActionPlansPlan — Recycle an action plan","request":{"method":"PATCH","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/action_plans/plans/:id/recycle","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","action_plans","plans",":id","recycle"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Recycle an action plan\n\nRequires action_plans:write. Requires project action_plans delete permission, an enabled tool, matching tenant and visible plan. Soft-deletes the plan. PATCH and DELETE are equivalent aliases, both returning HTTP 200 with no body. Catalog presence does not grant authorization."}},{"id":"137f0933-044c-4b91-8c7c-7dfca98f510c","name":"deleteRecycleProjectActionPlansPlan — Recycle an action plan","request":{"method":"DELETE","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/action_plans/plans/:id/recycle","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","action_plans","plans",":id","recycle"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Recycle an action plan\n\nRequires action_plans:write. Requires project action_plans delete permission, an enabled tool, matching tenant and visible plan. Soft-deletes the plan. PATCH and DELETE are equivalent aliases, both returning HTTP 200 with no body. Catalog presence does not grant authorization."}},{"id":"60e7f8d0-4aa3-4e19-8cad-b6cb1e8759e8","name":"reviseProjectActionPlansPlan — Revise an action plan","request":{"method":"PATCH","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/action_plans/plans/:id/revise","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","action_plans","plans",":id","revise"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Revise an action plan\n\nRequires action_plans:write. Requires project action_plans edit permission, an enabled tool, matching tenant and visible plan. Sets status to in_revision for assignment and blocking-configuration edits. Source details retain their independent read-scope and record-visibility checks. Catalog presence does not grant authorization."}},{"id":"060d4b88-1e74-4dba-80e3-224e82588a88","name":"listProjectActionPlansPotentialAssignees — GET /rest/v1.0/projects/{project_id}/action_plans/potential_assignees","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/action_plans/potential_assignees","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","action_plans","potential_assignees"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"GET /rest/v1.0/projects/{project_id}/action_plans/potential_assignees"}}]},{"name":"Admin","description":"Module: admin","item":[{"id":"ae62ae9d-7369-4687-8f65-005e06f6aec3","name":"listCompanyProjectStages — GET /rest/v1.0/companies/{company_id}/project_stages","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/project_stages","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","project_stages"],"variable":[{"key":"company_id","value":"{{companyId}}"}]},"description":"GET /rest/v1.0/companies/{company_id}/project_stages"}},{"id":"cd92f1c0-271c-44b1-813b-6616d658ec9e","name":"getJob — Status of a single background job","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/jobs/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","jobs",":id"],"variable":[{"key":"id","value":""}]},"description":"Status of a single background job\n\nStatus of a single background job (tenant-scoped). Returns the serialized Job including status, progress, result, and any error. A scoped API token needs `jobs:read`."}},{"id":"49b063d6-3751-485d-83f0-3b50182be70d","name":"listJobDownload — Download job","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/jobs/:id/download","host":["{{baseUrl}}"],"path":["rest","v1.0","jobs",":id","download"],"variable":[{"key":"id","value":""}]},"description":"Download job\n\nA scoped API token needs `jobs:read`."}},{"id":"a54a15e9-699f-495b-88b8-d3a0bc74a483","name":"listProjects — List projects","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects","host":["{{baseUrl}}"],"path":["rest","v1.0","projects"],"query":[{"key":"company_id","value":"","disabled":true,"description":"Company the call is scoped to. Required unless the OS-Company-Id header (or, for POST, body company_id) is sent; all supplied values must agree and match the caller's company."},{"key":"filters[active]","value":"","disabled":true,"description":"true = active only, false = archived only; omit for both."},{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true}]},"description":"List projects\n\nProjects in the company that the caller can see (company admins: all; members: projects they belong to). Local subset."}},{"id":"2f49cacb-cfb6-46e4-8ace-166783d8f849","name":"createProject — Create project","request":{"method":"POST","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects","host":["{{baseUrl}}"],"path":["rest","v1.0","projects"],"query":[{"key":"company_id","value":"","disabled":true,"description":"Company the call is scoped to. Required unless the OS-Company-Id header (or, for POST, body company_id) is sent; all supplied values must agree and match the caller's company."}]},"description":"Create project\n\nCreate a project in the company (company admins only; read-only workspaces get 403). Allocates default cost codes, a Site location, project dates and the company's standard stages if missing, and adds the caller as Project Admin. With template_project_id, cost codes, team permission assignments and tool settings are copied from that project instead.","body":{"mode":"raw","raw":"{\n  \"company_id\": 0,\n  \"project\": {\n    \"name\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"7a40b16b-125e-47bb-84c8-d3fd673f7539","name":"getProject — GET /rest/v1.0/projects/{id}","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":id"],"variable":[{"key":"id","value":""}]},"description":"GET /rest/v1.0/projects/{id}"}},{"id":"44f87db3-c2cd-4f78-8c1f-28d32c0c4091","name":"updateProject — PATCH /rest/v1.0/projects/{id}","request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":id"],"variable":[{"key":"id","value":""}]},"description":"PATCH /rest/v1.0/projects/{id}","body":{"mode":"raw","raw":"{\n  \"company_id\": 0,\n  \"project\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"13263f9e-429a-482a-890a-c6239e245849","name":"listProjectActivities — Project activity feed","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/activities","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","activities"],"query":[{"key":"page","value":"1","disabled":true,"description":"Page number, starting at 1."},{"key":"per_page","value":"100","disabled":true,"description":"Records per page."},{"key":"filters","value":"","disabled":true,"description":"Filters as `filters[field]=value` query parameters."}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Project activity feed\n\nRequires the `view` permission on the project's activity tool. A scoped API token needs `activity:read`."}},{"id":"a87881de-97c2-49ac-83a4-8bf131d7fe06","name":"listProjectCostCodes — List project cost codes","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/cost_codes","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","cost_codes"],"query":[{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true,"description":"Values above 1000 are clamped."},{"key":"filters[parent_id]","value":"","disabled":true,"description":"Repeated or comma-separated parent IDs. Only positive integers are used; invalid values are ignored. No root-only filter."}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"List project cost codes\n\nRequires admin:read and current project Admin tool view permission. Project must belong to the authenticated company; company administrator status is not required when the project permission suffices. Flat array ordered by sortable code then ID. No search or sub-job filter. Catalog presence does not grant authorization."}},{"id":"b93319fb-e3d2-45bc-8d81-f4fc7a7f4a5c","name":"createProjectCostCode — Create project cost code","request":{"method":"POST","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/cost_codes","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","cost_codes"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Create project cost code\n\nRequires admin:write and current project Admin tool create permission. Project must belong to the authenticated company; company administrator status is not required when the project permission suffices. Parent must belong to this project; full_code and sortable_code derive from the current tree. Body project_id and sub_job_id are ignored. Catalog presence does not grant authorization.","body":{"mode":"raw","raw":"{\n  \"cost_code\": {\n    \"code\": \"\",\n    \"name\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"0c34dbea-d548-4c9f-8877-91917f2d9ff2","name":"getProjectCostCode — Read project cost code","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/cost_codes/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","cost_codes",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Read project cost code\n\nRequires admin:read and current project Admin tool view permission. Project must belong to the authenticated company; company administrator status is not required when the project permission suffices. budgeted is always false in this metadata serializer and is not a computed usage indicator. Catalog presence does not grant authorization."}},{"id":"f51f452d-d03c-4f82-85e2-db8f3dd88695","name":"updateProjectCostCode — Edit project cost code","request":{"method":"PATCH","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/cost_codes/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","cost_codes",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Edit project cost code\n\nRequires admin:write and current project Admin tool edit permission. Project must belong to the authenticated company; company administrator status is not required when the project permission suffices. Parent/code edits recompose full_code and sortable_code for all affected descendants in the same transaction. Missing or cross-project parents and cycles fail400. Omitted fields retain values; explicit null clears parent/position. Catalog presence does not grant authorization.","body":{"mode":"raw","raw":"{\n  \"cost_code\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"bb35a259-803f-4aa8-8755-d81f9d12fe6e","name":"deleteProjectCostCode — Delete cost code","request":{"method":"DELETE","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/cost_codes/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","cost_codes",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Delete cost code"}},{"id":"d4713d10-dbea-4682-871d-17366a21f7b1","name":"listProjectJobs — List jobs","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/jobs","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","jobs"],"query":[{"key":"page","value":"1","disabled":true,"description":"Page number, starting at 1."},{"key":"per_page","value":"100","disabled":true,"description":"Records per page."},{"key":"filters","value":"","disabled":true,"description":"Filters as `filters[field]=value` query parameters."}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"List jobs\n\nList background jobs for a project (newest first), tenant-scoped, with pagination headers. Query: ?filters[status]=completed|queued|running|failed ?filters[type]=export_csv|source_import|... Requires the `view` permission on the project's jobs tool. A scoped API token needs `jobs:read`."}},{"id":"671eba03-2963-42fd-84ff-7c55ef304329","name":"listProjectPermissionTemplates — GET /rest/v1.0/projects/{project_id}/permission_templates","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/permission_templates","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","permission_templates"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"GET /rest/v1.0/projects/{project_id}/permission_templates"}},{"id":"f43b8c03-775e-4f70-801a-4eb5b1bb799a","name":"listProjectSavedViews — List saved views","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/saved_views","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","saved_views"],"query":[{"key":"tool","value":"","disabled":false}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"List saved views\n\nA scoped API token needs `saved_views:read`.","body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}}}},{"id":"f04be5fc-b49c-4143-81f5-e80c153731d7","name":"createProjectSavedView — Create saved view","request":{"method":"POST","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/saved_views","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","saved_views"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Create saved view"}},{"id":"0657ade7-2022-4218-8596-45a1253eec5a","name":"getProjectSavedView — Get saved view","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/saved_views/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","saved_views",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Get saved view\n\nA scoped API token needs `saved_views:read`."}},{"id":"2eaef16d-28c7-4856-8e2d-51bd4763917e","name":"deleteProjectSavedView — Delete saved view","request":{"method":"DELETE","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/saved_views/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","saved_views",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Delete saved view"}},{"id":"72035603-3286-4acf-86a3-d936f92498d1","name":"listProjectSubJobs — List project sub-jobs","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/sub_jobs","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","sub_jobs"],"query":[{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true,"description":"Values above 1000 are clamped."}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"List project sub-jobs\n\nRequires admin:read and current project Admin tool view permission. Project must belong to the authenticated company; company administrator status is not required when the project permission suffices. Flat array ordered by code then ID. No search filter. Catalog presence does not grant authorization."}},{"id":"58692e89-8d64-4b65-80fb-dadfcd48cf6c","name":"createProjectSubJob — Create project sub-job","request":{"method":"POST","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/sub_jobs","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","sub_jobs"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Create project sub-job\n\nRequires admin:write and current project Admin tool create permission. Project must belong to the authenticated company; company administrator status is not required when the project permission suffices. Creates a project-scoped sub-job; code defaults empty and is returned as null. Catalog presence does not grant authorization.","body":{"mode":"raw","raw":"{\n  \"sub_job\": {\n    \"name\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"fdfb33d5-36e7-437d-83bf-7eea8882465b","name":"getProjectSubJob — Read project sub-job","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/sub_jobs/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","sub_jobs",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Read project sub-job\n\nRequires admin:read and current project Admin tool view permission. Project must belong to the authenticated company; company administrator status is not required when the project permission suffices. updated_at currently equals created_at in this serializer. Catalog presence does not grant authorization."}},{"id":"93d86a12-4329-4b40-810c-a480297a9a7c","name":"updateProjectSubJob — Edit project sub-job","request":{"method":"PATCH","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/sub_jobs/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","sub_jobs",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Edit project sub-job\n\nRequires admin:write and current project Admin tool edit permission. Project must belong to the authenticated company; company administrator status is not required when the project permission suffices. Omitted code remains unchanged; an explicit empty string clears it. Null name/code is invalid. updated_at remains the creation timestamp. Catalog presence does not grant authorization.","body":{"mode":"raw","raw":"{\n  \"sub_job\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"d3fd5c50-2e99-4e83-8b79-fd2d8d6fb6eb","name":"deleteProjectSubJob — Delete sub job","request":{"method":"DELETE","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/sub_jobs/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","sub_jobs",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Delete sub job"}},{"id":"9ac409bc-3fa9-41c5-8d98-e98c74c6b536","name":"listProjectToolEnablements — List tool enablements","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/tool_enablements","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","tool_enablements"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"List tool enablements\n\nRequires the `view` permission on the project's admin tool. A scoped API token needs `admin:read`.","body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}}}},{"id":"297e700c-6e03-4549-881d-5290af47258b","name":"updateProjectToolEnablements — Update tool enablements","request":{"method":"PATCH","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/tool_enablements","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","tool_enablements"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Update tool enablements"}}]},{"name":"Analytics","description":"Module: analytics","item":[{"id":"06ef93a2-8622-459f-8d19-f764a3a1ce1d","name":"listCompanyAnalyticsActivity — Analytics audit trail (company admins only)","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/analytics/activity","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","analytics","activity"],"query":[{"key":"filters[actor_id]","value":"","disabled":true,"description":"User id"},{"key":"filters[action]","value":"","disabled":true,"description":"e.g. updated, viewed, exported"},{"key":"filters[item_type]","value":"","disabled":true,"description":"analytics_dashboard | analytics_exploration | analytics_alert | analytics_schedule | analytics_setting | analytics_export"},{"key":"filters[from]","value":"","disabled":true,"description":"YYYY-MM-DD (inclusive)"},{"key":"filters[to]","value":"","disabled":true,"description":"YYYY-MM-DD (inclusive)"},{"key":"page","value":"1","disabled":true,"description":"1-based page"},{"key":"per_page","value":"100","disabled":true,"description":"Page size (default 100, max 1000)"}],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Your company id (the token must belong to it, else 403)."}]},"description":"Analytics audit trail (company admins only)\n\nToken scope: `analytics:read`."}},{"id":"58eef788-6d03-4185-861f-b20fac82a005","name":"listCompanyAnalyticsAdminOrphaned — Content owned by inactive users (company admins only)","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/analytics/admin/orphaned","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","analytics","admin","orphaned"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Your company id (the token must belong to it, else 403)."}]},"description":"Content owned by inactive users (company admins only)\n\nToken scope: `analytics:read`."}},{"id":"eb36a54b-9804-4397-831e-c37631530b43","name":"listCompanyAnalyticsAlerts — List KPI alert rules","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/analytics/alerts","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","analytics","alerts"],"query":[{"key":"project_id","value":"","disabled":true,"description":"Project scope; omit for company scope. Requires analytics view on that project."},{"key":"page","value":"1","disabled":true,"description":"1-based page"},{"key":"per_page","value":"100","disabled":true,"description":"Page size (default 100, max 1000)"}],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Your company id (the token must belong to it, else 403)."}]},"description":"List KPI alert rules\n\nToken scope: `analytics:read`."}},{"id":"c5ede29a-1f2e-4a81-8361-08edd07042c1","name":"createCompanyAnalyticsAlert — Create a KPI alert rule","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/analytics/alerts","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","analytics","alerts"],"query":[{"key":"project_id","value":"","disabled":true,"description":"Project scope; omit for company scope. Requires analytics view on that project."}],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Your company id (the token must belong to it, else 403)."}]},"description":"Create a KPI alert rule\n\nEvaluated per recipient with the recipient's own permissions; recipients must be active company users with analytics view. Token scope: `analytics:write`.","body":{"mode":"raw","raw":"{\n  \"alert\": {\n    \"channel\": \"in_app\",\n    \"enabled\": true,\n    \"filters\": [\n      {}\n    ],\n    \"metric_key\": \"pm.rfis_open\",\n    \"name\": \"PM weekly overview\",\n    \"op\": \"gt\",\n    \"per_project\": false,\n    \"recipient_ids\": [\n      6\n    ],\n    \"threshold\": 12.5,\n    \"window\": \"open\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"6d628414-7245-41b1-88e6-b5ff10ecc6e7","name":"getCompanyAnalyticsAlert — Show a KPI alert rule","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/analytics/alerts/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","analytics","alerts",":id"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Your company id (the token must belong to it, else 403)."},{"key":"id","value":""}]},"description":"Show a KPI alert rule\n\nToken scope: `analytics:read`."}},{"id":"7571cd0c-9905-48a4-8dfb-95f2e60f3725","name":"updateCompanyAnalyticsAlert — Update a KPI alert rule","request":{"method":"PATCH","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/analytics/alerts/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","analytics","alerts",":id"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Your company id (the token must belong to it, else 403)."},{"key":"id","value":""}]},"description":"Update a KPI alert rule\n\nToken scope: `analytics:write`.","body":{"mode":"raw","raw":"{\n  \"alert\": {\n    \"channel\": \"in_app\",\n    \"enabled\": true,\n    \"filters\": [\n      {}\n    ],\n    \"name\": \"PM weekly overview\",\n    \"op\": \"gt\",\n    \"per_project\": false,\n    \"recipient_ids\": [\n      6\n    ],\n    \"threshold\": 12.5,\n    \"window\": \"open\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"f0f908f2-6cb1-44b5-8457-83022d5f0973","name":"deleteCompanyAnalyticsAlert — Delete a KPI alert rule","request":{"method":"DELETE","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/analytics/alerts/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","analytics","alerts",":id"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Your company id (the token must belong to it, else 403)."},{"key":"id","value":""}]},"description":"Delete a KPI alert rule\n\nToken scope: `analytics:write`."}},{"id":"33f14046-8108-466a-8f8f-7126cce14f43","name":"transferCompanyAnalyticsAlert — Transfer an alert to a new owner (analytics admin only)","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/analytics/alerts/:id/transfer","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","analytics","alerts",":id","transfer"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Your company id (the token must belong to it, else 403)."},{"key":"id","value":""}]},"description":"Transfer an alert to a new owner (analytics admin only)\n\nToken scope: `analytics:write`.","body":{"mode":"raw","raw":"{\n  \"owner_id\": 6\n}","options":{"raw":{"language":"json"}}}}},{"id":"ee188430-4c80-4602-8181-171099ce370e","name":"createCompanyAnalyticsAsk — Answer a question with a governed query","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/analytics/ask","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","analytics","ask"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Your company id (the token must belong to it, else 403)."}]},"description":"Answer a question with a governed query\n\nRead semantics: token scope `analytics:read` (not :write) plus analytics view. Every metric additionally needs read access to its source tool, the tool enabled, and the source's token scope; metrics failing that are listed in `unavailable` with null values, never 0. POST is unavailable (403) on read-only (expired trial / suspended) workspaces; use the GET form with `?q=`. The answer is a QuerySpec run through the normal engine; only permission-filtered catalog metadata is used to resolve it.","body":{"mode":"raw","raw":"{\n  \"question\": \"How many RFIs are open by project?\"\n}","options":{"raw":{"language":"json"}}}}},{"id":"0cfbe79a-2978-42da-8e8e-d2ecc8cde74b","name":"listCompanyAnalyticsCatalog — Catalog of metrics and dimensions readable by the caller (company)","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/analytics/catalog","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","analytics","catalog"],"query":[{"key":"project_id","value":"","disabled":true,"description":"Project scope; omit for company scope. Requires analytics view on that project."}],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Your company id (the token must belong to it, else 403)."}]},"description":"Catalog of metrics and dimensions readable by the caller (company)\n\nRead semantics: token scope `analytics:read` (not :write) plus analytics view. Every metric additionally needs read access to its source tool, the tool enabled, and the source's token scope; metrics failing that are listed in `unavailable` with null values, never 0."}},{"id":"60bf9630-06b3-428f-859f-fea9e1a71245","name":"listCompanyAnalyticsCatalogUsage — Where a metric or dimension key is used","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/analytics/catalog/:key/usage","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","analytics","catalog",":key","usage"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Your company id (the token must belong to it, else 403)."},{"key":"key","value":"","description":"Metric (domain.metric) or dimension key."}]},"description":"Where a metric or dimension key is used\n\nRead semantics: analytics view. Dashboards, explorations, alert rules, schedules (directly or through the dashboard / exploration they deliver), company metrics and packs that reference the key, in this company only (bound, LIKE-escaped match). Analytics admins get the items; everyone else gets the count with items []. Token scope: `analytics:read`."}},{"id":"f61eebde-0bfc-45d9-89a7-82a9ee71fe98","name":"listCompanyAnalyticsComments — A thread (oldest first)","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/analytics/comments","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","analytics","comments"],"query":[{"key":"target","value":"","disabled":false,"description":"dashboard:<id> | exploration:<id> | insight:<id> | goal:<id>"}],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Your company id (the token must belong to it, else 403)."}]},"description":"A thread (oldest first)\n\n404 unless the caller can open the target (dashboards/explorations: scope + visibility + shares; insights: the feed gate; goals: the goal gate). Comments can quote numbers, so the thread is visible exactly to those people. Token scope analytics:read."}},{"id":"4b15cc37-ea22-4873-863b-e51abad68864","name":"createCompanyAnalyticsComment — Comment on a dashboard, exploration, insight or goal","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/analytics/comments","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","analytics","comments"],"query":[{"key":"target","value":"","disabled":false,"description":"dashboard:<id> | exploration:<id> | insight:<id> | goal:<id>"}],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Your company id (the token must belong to it, else 403)."}]},"description":"Comment on a dashboard, exploration, insight or goal\n\nSame gate as GET. Mentioned people who can open the target get a `mentioned` notification (target title and link only). Token scope analytics:write.","body":{"mode":"raw","raw":"{\n  \"comment\": {\n    \"anchor\": {\n      \"dims\": {}\n    },\n    \"body\": \"Open RFIs older than 14 days are trending up on two projects.\",\n    \"tile_id\": \"status\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"d37cec59-a309-4df4-8c64-978459ddbbd2","name":"listCompanyAnalyticsCommentsMentionable — People who can open the target (mention and assignee picker)","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/analytics/comments/mentionable","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","analytics","comments","mentionable"],"query":[{"key":"target","value":"","disabled":false,"description":"dashboard:<id> | exploration:<id> | insight:<id> | goal:<id>"}],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Your company id (the token must belong to it, else 403)."}]},"description":"People who can open the target (mention and assignee picker)\n\nToken scope: `analytics:read`."}},{"id":"5223d8ff-2541-45fb-8603-065d40d59f65","name":"updateCompanyAnalyticsComment — Edit (author) or resolve / reopen (anyone who can open the target) a comment","request":{"method":"PATCH","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/analytics/comments/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","analytics","comments",":id"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Your company id (the token must belong to it, else 403)."},{"key":"id","value":""}]},"description":"Edit (author) or resolve / reopen (anyone who can open the target) a comment\n\nToken scope: `analytics:write`.","body":{"mode":"raw","raw":"{\n  \"comment\": {\n    \"body\": \"Open RFIs older than 14 days are trending up on two projects.\",\n    \"resolved\": false\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"167b9e51-1344-4f9f-8fb3-612abd7cc5ea","name":"deleteCompanyAnalyticsComment — Delete a comment (author, or analytics admin at the target's scope)","request":{"method":"DELETE","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/analytics/comments/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","analytics","comments",":id"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Your company id (the token must belong to it, else 403)."},{"key":"id","value":""}]},"description":"Delete a comment (author, or analytics admin at the target's scope)\n\nToken scope: `analytics:write`."}},{"id":"7b7396d0-8f52-4937-884b-5d939f250984","name":"listCompanyAnalyticsDashboards — List dashboards (company)","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/analytics/dashboards","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","analytics","dashboards"],"query":[{"key":"project_id","value":"","disabled":true,"description":"Project scope; omit for company scope. Requires analytics view on that project."},{"key":"filters[visibility]","value":"","disabled":true,"description":"private | project | company"},{"key":"filters[certified]","value":"","disabled":true,"description":"Certified only"},{"key":"filters[favorite]","value":"","disabled":true,"description":"Caller's favorites only"},{"key":"filters[shared_with_me]","value":"","disabled":true,"description":"Only dashboards shared with you or a role you hold (not your own)."},{"key":"page","value":"1","disabled":true,"description":"1-based page"},{"key":"per_page","value":"100","disabled":true,"description":"Page size (default 100, max 1000)"},{"key":"filters[deleted]","value":"","disabled":true,"description":"Trash: your deleted items (all of them for analytics admins)."}],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Your company id (the token must belong to it, else 403)."}]},"description":"List dashboards (company)\n\nVisible = own private dashboards + project/company-visible ones the caller can view. Token scope: `analytics:read`."}},{"id":"c0a87628-6f6a-4d2f-8ed5-fce6f63f87b2","name":"createCompanyAnalyticsDashboard — Create a dashboard (company)","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/analytics/dashboards","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","analytics","dashboards"],"query":[{"key":"project_id","value":"","disabled":true,"description":"Project scope; omit for company scope. Requires analytics view on that project."}],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Your company id (the token must belong to it, else 403)."}]},"description":"Create a dashboard (company)\n\nRequires analytics standard. `spec` is a DashboardSpec, validated on write and read. Token scope: `analytics:write`.","body":{"mode":"raw","raw":"{\n  \"dashboard\": {\n    \"description\": \"Open RFIs and their status mix\",\n    \"name\": \"PM weekly overview\",\n    \"spec\": {\n      \"filters\": [\n        {\n          \"default\": {\n            \"preset\": \"last_12m\"\n          },\n          \"dim\": \"created\",\n          \"key\": \"period\",\n          \"kind\": \"date_range\",\n          \"label\": \"Created\"\n        },\n        {\n          \"dim\": \"status\",\n          \"key\": \"status\",\n          \"kind\": \"multi\",\n          \"label\": \"Status\"\n        }\n      ],\n      \"tiles\": [\n        {\n          \"id\": \"open\",\n          \"kind\": \"query\",\n          \"layout\": {\n            \"h\": 2,\n            \"w\": 3,\n            \"x\": 0,\n            \"y\": 0\n          },\n          \"query\": {\n            \"metrics\": [\n              \"pm.rfis_open\"\n            ]\n          },\n          \"title\": \"Open RFIs\",\n          \"viz\": {\n            \"options\": {},\n            \"type\": \"kpi\"\n          }\n        },\n        {\n          \"id\": \"by_status\",\n          \"kind\": \"query\",\n          \"layout\": {\n            \"h\": 4,\n            \"w\": 9,\n            \"x\": 3,\n            \"y\": 0\n          },\n          \"query\": {\n            \"dimensions\": [\n              {\n                \"key\": \"status\"\n              }\n            ],\n            \"metrics\": [\n              \"pm.rfis_total\"\n            ]\n          },\n          \"title\": \"RFIs by status\",\n          \"viz\": {\n            \"options\": {},\n            \"type\": \"bar\"\n          }\n        }\n      ],\n      \"version\": 1\n    },\n    \"visibility\": \"company\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"546b5c0f-163a-446b-85d0-ffa0512a6a9e","name":"getCompanyAnalyticsDashboard — Show a dashboard (company)","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/analytics/dashboards/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","analytics","dashboards",":id"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Your company id (the token must belong to it, else 403)."},{"key":"id","value":""}]},"description":"Show a dashboard (company)\n\nToken scope: `analytics:read`."}},{"id":"1fe11211-c71d-4b5e-8246-8b3f3ff87102","name":"updateCompanyAnalyticsDashboard — Update a dashboard (company)","request":{"method":"PATCH","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/analytics/dashboards/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","analytics","dashboards",":id"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Your company id (the token must belong to it, else 403)."},{"key":"id","value":""}]},"description":"Update a dashboard (company)\n\nOwner (standard) or analytics admin. `certified` is admin-only. Token scope: `analytics:write`.","body":{"mode":"raw","raw":"{\n  \"dashboard\": {\n    \"name\": \"PM weekly overview (FY27)\",\n    \"version\": 3\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"23535fcd-b6e1-4836-8e2f-07f20529c801","name":"deleteCompanyAnalyticsDashboard — Delete a dashboard (company)","request":{"method":"DELETE","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/analytics/dashboards/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","analytics","dashboards",":id"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Your company id (the token must belong to it, else 403)."},{"key":"id","value":""}]},"description":"Delete a dashboard (company)\n\nSoft delete. Owner or analytics admin. Token scope: `analytics:write`."}},{"id":"017bed09-4e8b-40d3-886c-0abcfb86cbd6","name":"cloneCompanyAnalyticsDashboard — Clone a dashboard into a new private copy","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/analytics/dashboards/:id/clone","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","analytics","dashboards",":id","clone"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Your company id (the token must belong to it, else 403)."},{"key":"id","value":""}]},"description":"Clone a dashboard into a new private copy\n\nToken scope: `analytics:write`.","body":{"mode":"raw","raw":"{\n  \"name\": \"PM weekly overview\"\n}","options":{"raw":{"language":"json"}}}}},{"id":"c1a6eeba-ce77-4277-83be-1ad16529fcd9","name":"listCompanyAnalyticsDashboardData — Get a dashboard's computed tile data (company)","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/analytics/dashboards/:id/data","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","analytics","dashboards",":id","data"],"query":[{"key":"f","value":"","disabled":true,"description":"base64url(JSON FilterState): dashboard filter values and cross-filter chips, as in the app URL."},{"key":"filters[<filter key>]","value":"","disabled":true,"description":"Value(s) for one of the dashboard's global filters (`spec.filters[].key`), comma-separated for several; merged over `f`."},{"key":"time_preset","value":"","disabled":true,"description":"Time window for every tile (keeps each tile's time dimension). Use either this or from/to."},{"key":"from","value":"","disabled":true,"description":"Time window start (YYYY-MM-DD), every tile."},{"key":"to","value":"","disabled":true,"description":"Time window end (YYYY-MM-DD), every tile."},{"key":"tile","value":"","disabled":true,"description":"Only this tile (`spec.tiles[].id`); 404 when there is no such tile."},{"key":"format","value":"","disabled":true,"description":"`json` (default): per-tile results. `csv` | `xlsx` | `pdf`: the rendered file, exactly as an export (a single tile is a plain CSV table; audited)."},{"key":"view_id","value":"","disabled":true,"description":"A saved filter view of this dashboard the caller can read (own or shared; anything else is 422). Applied first; `f` and `filters[...]` values win per key."}],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Your company id (the token must belong to it, else 403)."},{"key":"id","value":""}]},"description":"Get a dashboard's computed tile data (company)\n\nComputed data of a saved dashboard (company- or project-scoped: the scope comes from the dashboard): every tile runs as the token's user with the screen's own tile query (global filters, chips, date ranges), plain query tiles share one scan. Tiles the user cannot fully read report `unavailable` / `partial` on their result; a failed tile carries `error` and never fails the call. Read: `analytics:read`. Stable URL: use it from Excel / Power BI / Sheets (`format=csv`)."}},{"id":"6e7b8895-ba37-48c8-827d-48803d1d35ae","name":"restoreCompanyAnalyticsDashboard — Restore a deleted dashboard from trash (owner or analytics admin)","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/analytics/dashboards/:id/restore","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","analytics","dashboards",":id","restore"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Your company id (the token must belong to it, else 403)."},{"key":"id","value":""}]},"description":"Restore a deleted dashboard from trash (owner or analytics admin)\n\nToken scope: `analytics:write`."}},{"id":"81461648-2267-4884-8835-de1c35552d68","name":"listCompanyAnalyticsDashboardRevisions — List saved versions of a dashboard (newest first, max 50)","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/analytics/dashboards/:id/revisions","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","analytics","dashboards",":id","revisions"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Your company id (the token must belong to it, else 403)."},{"key":"id","value":""}]},"description":"List saved versions of a dashboard (newest first, max 50)\n\nToken scope: `analytics:read`."}},{"id":"923cf7d6-b481-469e-860a-44bf56ab9e73","name":"restoreCompanyAnalyticsDashboardRevision — Restore a saved version of a dashboard (as a new version)","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/analytics/dashboards/:id/revisions/:v/restore","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","analytics","dashboards",":id","revisions",":v","restore"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Your company id (the token must belong to it, else 403)."},{"key":"id","value":""},{"key":"v","value":"","description":"Revision / version number."}]},"description":"Restore a saved version of a dashboard (as a new version)\n\nToken scope: `analytics:write`.","body":{"mode":"raw","raw":"{\n  \"version\": 3\n}","options":{"raw":{"language":"json"}}}}},{"id":"f7619176-cc19-4466-8479-5a7391961993","name":"listCompanyAnalyticsDashboardShares — List who a dashboard is shared with (owner or analytics admin)","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/analytics/dashboards/:id/shares","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","analytics","dashboards",":id","shares"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Your company id (the token must belong to it, else 403)."},{"key":"id","value":""}]},"description":"List who a dashboard is shared with (owner or analytics admin)\n\nToken scope: `analytics:read`."}},{"id":"d6929649-a77f-4ff3-809b-9f72c573375d","name":"replaceCompanyAnalyticsDashboardShares — Replace the dashboard share set (owner or analytics admin; audited). Grants the dashboard, never data.","request":{"method":"PUT","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/analytics/dashboards/:id/shares","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","analytics","dashboards",":id","shares"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Your company id (the token must belong to it, else 403)."},{"key":"id","value":""}]},"description":"Replace the dashboard share set (owner or analytics admin; audited). Grants the dashboard, never data.\n\nToken scope: `analytics:write`.","body":{"mode":"raw","raw":"{\n  \"shares\": [\n    {\n      \"principal_id\": 6,\n      \"principal_type\": \"user\"\n    }\n  ]\n}","options":{"raw":{"language":"json"}}}}},{"id":"2ac35d78-1faf-41e8-80d4-42ff91a09719","name":"transferCompanyAnalyticsDashboard — Transfer a dashboard to a new owner (analytics admin; reaches private items of inactive owners only)","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/analytics/dashboards/:id/transfer","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","analytics","dashboards",":id","transfer"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Your company id (the token must belong to it, else 403)."},{"key":"id","value":""}]},"description":"Transfer a dashboard to a new owner (analytics admin; reaches private items of inactive owners only)\n\nToken scope: `analytics:write`.","body":{"mode":"raw","raw":"{\n  \"owner_id\": 6\n}","options":{"raw":{"language":"json"}}}}},{"id":"e7362d57-1e14-4eb3-83ed-0fae70b33300","name":"listCompanyAnalyticsDashboardViews — List the dashboard's saved filter views you can see (your own and shared ones)","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/analytics/dashboards/:id/views","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","analytics","dashboards",":id","views"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Your company id (the token must belong to it, else 403)."},{"key":"id","value":""}]},"description":"List the dashboard's saved filter views you can see (your own and shared ones)\n\nToken scope: `analytics:read`. Personal views are visible to their owner only (anyone else: 404); shared views to everyone who can open the dashboard. A view holds filter values, never data."}},{"id":"c0c3e659-c4c5-4645-8842-e339ebaf18f7","name":"createCompanyAnalyticsDashboardView — Save a filter view on a dashboard (personal unless shared by a dashboard editor)","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/analytics/dashboards/:id/views","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","analytics","dashboards",":id","views"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Your company id (the token must belong to it, else 403)."},{"key":"id","value":""}]},"description":"Save a filter view on a dashboard (personal unless shared by a dashboard editor)\n\nToken scope: `analytics:write`. Anyone who can open the dashboard may save a personal view (at most 50 per dashboard).","body":{"mode":"raw","raw":"{\n  \"view\": {\n    \"name\": \"Open, Riverside\",\n    \"shared\": false,\n    \"state\": {\n      \"chips\": [],\n      \"values\": {\n        \"status\": [\n          \"open\"\n        ]\n      }\n    }\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"d37102bc-2cbd-4545-8e2d-e3a3b2ee1b7f","name":"getCompanyAnalyticsDashboardView — Show a saved filter view","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/analytics/dashboards/:id/views/:view_id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","analytics","dashboards",":id","views",":view_id"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Your company id (the token must belong to it, else 403)."},{"key":"id","value":""},{"key":"view_id","value":"","description":"Saved view id."}]},"description":"Show a saved filter view\n\nToken scope: `analytics:read`. Personal views are visible to their owner only (anyone else: 404); shared views to everyone who can open the dashboard. A view holds filter values, never data."}},{"id":"364fd7ea-d2d2-4867-8153-f278249f9128","name":"updateCompanyAnalyticsDashboardView — Rename, change or (un)share a saved filter view","request":{"method":"PATCH","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/analytics/dashboards/:id/views/:view_id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","analytics","dashboards",":id","views",":view_id"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Your company id (the token must belong to it, else 403)."},{"key":"id","value":""},{"key":"view_id","value":"","description":"Saved view id."}]},"description":"Rename, change or (un)share a saved filter view\n\nToken scope: `analytics:write`. Own personal views; shared views need dashboard edit rights.","body":{"mode":"raw","raw":"{\n  \"view\": {\n    \"name\": \"Open, all projects\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"ca0b1845-98d6-41fd-8fa5-032e00745641","name":"deleteCompanyAnalyticsDashboardView — Delete a saved filter view","request":{"method":"DELETE","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/analytics/dashboards/:id/views/:view_id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","analytics","dashboards",":id","views",":view_id"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Your company id (the token must belong to it, else 403)."},{"key":"id","value":""},{"key":"view_id","value":"","description":"Saved view id."}]},"description":"Delete a saved filter view\n\nToken scope: `analytics:write`. Own personal views; shared views need dashboard edit rights. Schedules that use it stop with last_status failed until edited."}},{"id":"d3e366c7-97ec-47d8-8317-aa05dd3814d7","name":"listCompanyAnalyticsDimensions — List company value groups","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/analytics/dimensions","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","analytics","dimensions"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Your company id (the token must belong to it, else 403)."}]},"description":"List company value groups\n\nCompany value groups (grp_ dimensions). Admins also see archived ones. Token scope: `analytics:read`."}},{"id":"5384acf9-e51a-453b-8de2-cfe120314ec8","name":"createCompanyAnalyticsDimension — Create a value group","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/analytics/dimensions","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","analytics","dimensions"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Your company id (the token must belong to it, else 403)."}]},"description":"Create a value group\n\nAnalytics admin (company level). Every write is audited (analytics_value_group) and invalidates the company catalog overlay. Buckets a base dimension (static or cf_) into named groups of values, or numeric bands (max inclusive, last may be open-ended). Never SQL: values and labels are bound parameters. Live immediately. Token scope: `analytics:write`.","body":{"mode":"raw","raw":"{\n  \"dimension\": {\n    \"base\": \"open\",\n    \"description\": \"Open RFIs older than 14 days are trending up on two projects.\",\n    \"groups\": [\n      {\n        \"label\": \"Open RFIs\",\n        \"values\": [\n          \"open\"\n        ]\n      }\n    ],\n    \"label\": \"Open RFIs\",\n    \"other_label\": \"open\",\n    \"slug\": \"status\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"caf0fc73-7f55-43da-8462-322591a1f329","name":"listCompanyAnalyticsDimensionsValues — Distinct values of a dimension","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/analytics/dimensions/values","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","analytics","dimensions","values"],"query":[{"key":"dim","value":"","disabled":false},{"key":"project_id","value":"","disabled":true,"description":"Project scope; omit for company scope. Requires analytics view on that project."}],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Your company id (the token must belong to it, else 403)."}]},"description":"Distinct values of a dimension\n\nRead semantics: analytics view. The most common values (at most 500) of a dimension, run through the engine as the caller, so only values on records they can read. Feeds the value-group editor. Token scope: `analytics:read`."}},{"id":"a3f998e1-0202-4bfa-8d26-86ef94cbf2a9","name":"getCompanyAnalyticsDimension — Get a value group","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/analytics/dimensions/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","analytics","dimensions",":id"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Your company id (the token must belong to it, else 403)."},{"key":"id","value":""}]},"description":"Get a value group\n\nToken scope: `analytics:read`."}},{"id":"fc5d5844-5edb-4614-8f0d-1281dc16cb87","name":"updateCompanyAnalyticsDimension — Edit a value group","request":{"method":"PATCH","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/analytics/dimensions/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","analytics","dimensions",":id"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Your company id (the token must belong to it, else 403)."},{"key":"id","value":""}]},"description":"Edit a value group\n\nAnalytics admin (company level). Every write is audited (analytics_value_group) and invalidates the company catalog overlay. Send the version you loaded: a stale one is 409. Token scope: `analytics:write`.","body":{"mode":"raw","raw":"{\n  \"dimension\": {\n    \"base\": \"open\",\n    \"description\": \"Open RFIs older than 14 days are trending up on two projects.\",\n    \"groups\": [\n      {\n        \"label\": \"Open RFIs\",\n        \"values\": [\n          \"open\"\n        ]\n      }\n    ],\n    \"label\": \"Open RFIs\",\n    \"other_label\": \"open\"\n  },\n  \"version\": 3\n}","options":{"raw":{"language":"json"}}}}},{"id":"3e894a9c-2bc5-47fd-8e1d-65efb32da071","name":"deleteCompanyAnalyticsDimension — Archive a value group","request":{"method":"DELETE","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/analytics/dimensions/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","analytics","dimensions",":id"],"query":[{"key":"force","value":"","disabled":true,"description":"Archive even while saved content uses it."}],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Your company id (the token must belong to it, else 403)."},{"key":"id","value":""}]},"description":"Archive a value group\n\nAnalytics admin (company level). Every write is audited (analytics_value_group) and invalidates the company catalog overlay. Blocked with 409 and the usage list while dashboards, explorations, alerts or schedules use it, unless force=true. Saved tiles then get 422 \"unknown dimension\", never a 500. Publish to restore. Token scope: `analytics:write`."}},{"id":"1bbebb76-44bf-4237-8ab1-c0542dfb2a06","name":"publishCompanyAnalyticsDimension — Restore an archived value group","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/analytics/dimensions/:id/publish","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","analytics","dimensions",":id","publish"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Your company id (the token must belong to it, else 403)."},{"key":"id","value":""}]},"description":"Restore an archived value group\n\nAnalytics admin (company level). Every write is audited (analytics_value_group) and invalidates the company catalog overlay. Token scope: `analytics:write`."}},{"id":"f2dd92f2-92ec-4965-8fef-3e4bdeb277b4","name":"listCompanyAnalyticsExplorations — List saved explorations","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/analytics/explorations","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","analytics","explorations"],"query":[{"key":"project_id","value":"","disabled":true,"description":"Project scope; omit for company scope. Requires analytics view on that project."},{"key":"page","value":"1","disabled":true,"description":"1-based page"},{"key":"per_page","value":"100","disabled":true,"description":"Page size (default 100, max 1000)"},{"key":"filters[deleted]","value":"","disabled":true,"description":"Trash: your deleted items (all of them for analytics admins)."}],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Your company id (the token must belong to it, else 403)."}]},"description":"List saved explorations\n\nToken scope: `analytics:read`."}},{"id":"4d0ecece-af11-48d6-8cea-c92f62c358d9","name":"createCompanyAnalyticsExploration — Save an exploration","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/analytics/explorations","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","analytics","explorations"],"query":[{"key":"project_id","value":"","disabled":true,"description":"Project scope; omit for company scope. Requires analytics view on that project."}],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Your company id (the token must belong to it, else 403)."}]},"description":"Save an exploration\n\nToken scope: `analytics:write`.","body":{"mode":"raw","raw":"{\n  \"exploration\": {\n    \"name\": \"RFIs by status\",\n    \"query\": {\n      \"dimensions\": [\n        {\n          \"key\": \"status\"\n        }\n      ],\n      \"metrics\": [\n        \"pm.rfis_total\"\n      ]\n    },\n    \"viz\": {\n      \"options\": {},\n      \"type\": \"bar\"\n    }\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"d332e0c9-3604-42df-80fe-5c6a29a4b470","name":"getCompanyAnalyticsExploration — Show an exploration","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/analytics/explorations/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","analytics","explorations",":id"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Your company id (the token must belong to it, else 403)."},{"key":"id","value":""}]},"description":"Show an exploration\n\nToken scope: `analytics:read`."}},{"id":"69cd9866-05b1-4c18-89ae-90a822fd1486","name":"updateCompanyAnalyticsExploration — Update an exploration","request":{"method":"PATCH","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/analytics/explorations/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","analytics","explorations",":id"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Your company id (the token must belong to it, else 403)."},{"key":"id","value":""}]},"description":"Update an exploration\n\nToken scope: `analytics:write`.","body":{"mode":"raw","raw":"{\n  \"exploration\": {\n    \"description\": \"Open RFIs older than 14 days are trending up on two projects.\",\n    \"favorite\": false,\n    \"name\": \"PM weekly overview\",\n    \"query\": {\n      \"metrics\": [\n        \"pm.rfis_open\"\n      ]\n    },\n    \"version\": 3,\n    \"visibility\": \"private\",\n    \"viz\": {\n      \"type\": \"kpi\"\n    }\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"c8f0b1bc-c7f9-4cf1-8678-bf8bf8eb2288","name":"deleteCompanyAnalyticsExploration — Delete an exploration","request":{"method":"DELETE","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/analytics/explorations/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","analytics","explorations",":id"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Your company id (the token must belong to it, else 403)."},{"key":"id","value":""}]},"description":"Delete an exploration\n\nToken scope: `analytics:write`."}},{"id":"f3812f70-1726-4697-8747-6cb60139e206","name":"listCompanyAnalyticsExplorationData — Get a saved exploration's result","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/analytics/explorations/:id/data","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","analytics","explorations",":id","data"],"query":[{"key":"project_id","value":"","disabled":true,"description":"Project scope; omit for company scope. Requires analytics view on that project."},{"key":"time_preset","value":"","disabled":true,"description":"Time window for every tile (keeps each tile's time dimension). Use either this or from/to."},{"key":"from","value":"","disabled":true,"description":"Time window start (YYYY-MM-DD), every tile."},{"key":"to","value":"","disabled":true,"description":"Time window end (YYYY-MM-DD), every tile."},{"key":"format","value":"","disabled":true,"description":"`json` (default): per-tile results. `csv` | `xlsx` | `pdf`: the rendered file, exactly as an export (a single tile is a plain CSV table; audited)."}],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Your company id (the token must belong to it, else 403)."},{"key":"id","value":""}]},"description":"Get a saved exploration's result\n\nComputed data of a saved exploration (one tile, id `result`): every tile runs as the token's user with the screen's own tile query (global filters, chips, date ranges), plain query tiles share one scan. Tiles the user cannot fully read report `unavailable` / `partial` on their result; a failed tile carries `error` and never fails the call. Read: `analytics:read`. Project-scoped explorations need their `project_id`."}},{"id":"55c5a59a-d62b-4124-8a06-ecf6ead61199","name":"restoreCompanyAnalyticsExploration — Restore a deleted exploration from trash (owner or analytics admin)","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/analytics/explorations/:id/restore","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","analytics","explorations",":id","restore"],"query":[{"key":"project_id","value":"","disabled":true,"description":"Project scope; omit for company scope. Requires analytics view on that project."}],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Your company id (the token must belong to it, else 403)."},{"key":"id","value":""}]},"description":"Restore a deleted exploration from trash (owner or analytics admin)\n\nToken scope: `analytics:write`."}},{"id":"edd2e8e3-e932-4562-80b5-24bd8ab078d7","name":"listCompanyAnalyticsExplorationRevisions — List saved versions of a exploration (newest first, max 50)","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/analytics/explorations/:id/revisions","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","analytics","explorations",":id","revisions"],"query":[{"key":"project_id","value":"","disabled":true,"description":"Project scope; omit for company scope. Requires analytics view on that project."}],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Your company id (the token must belong to it, else 403)."},{"key":"id","value":""}]},"description":"List saved versions of a exploration (newest first, max 50)\n\nToken scope: `analytics:read`."}},{"id":"03e79e84-7a25-49c4-820e-344a1c39a591","name":"restoreCompanyAnalyticsExplorationRevision — Restore a saved version of a exploration (as a new version)","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/analytics/explorations/:id/revisions/:v/restore","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","analytics","explorations",":id","revisions",":v","restore"],"query":[{"key":"project_id","value":"","disabled":true,"description":"Project scope; omit for company scope. Requires analytics view on that project."}],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Your company id (the token must belong to it, else 403)."},{"key":"id","value":""},{"key":"v","value":"","description":"Revision / version number."}]},"description":"Restore a saved version of a exploration (as a new version)\n\nToken scope: `analytics:write`.","body":{"mode":"raw","raw":"{\n  \"version\": 3\n}","options":{"raw":{"language":"json"}}}}},{"id":"16bd1eec-c191-4b33-8746-49ca722cf369","name":"listCompanyAnalyticsExplorationShares — List who a exploration is shared with (owner or analytics admin)","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/analytics/explorations/:id/shares","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","analytics","explorations",":id","shares"],"query":[{"key":"project_id","value":"","disabled":true,"description":"Project scope; omit for company scope. Requires analytics view on that project."}],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Your company id (the token must belong to it, else 403)."},{"key":"id","value":""}]},"description":"List who a exploration is shared with (owner or analytics admin)\n\nToken scope: `analytics:read`."}},{"id":"b8d19d67-234b-464d-8586-9ccb032b76cb","name":"replaceCompanyAnalyticsExplorationShares — Replace the exploration share set (owner or analytics admin; audited). Grants the exploration, never data.","request":{"method":"PUT","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/analytics/explorations/:id/shares","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","analytics","explorations",":id","shares"],"query":[{"key":"project_id","value":"","disabled":true,"description":"Project scope; omit for company scope. Requires analytics view on that project."}],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Your company id (the token must belong to it, else 403)."},{"key":"id","value":""}]},"description":"Replace the exploration share set (owner or analytics admin; audited). Grants the exploration, never data.\n\nToken scope: `analytics:write`.","body":{"mode":"raw","raw":"{\n  \"shares\": [\n    {\n      \"principal_id\": 6,\n      \"principal_type\": \"user\"\n    }\n  ]\n}","options":{"raw":{"language":"json"}}}}},{"id":"f37cbcce-f5f8-4b0a-8365-c23373a839d4","name":"transferCompanyAnalyticsExploration — Transfer a exploration to a new owner (analytics admin; reaches private items of inactive owners only)","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/analytics/explorations/:id/transfer","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","analytics","explorations",":id","transfer"],"query":[{"key":"project_id","value":"","disabled":true,"description":"Project scope; omit for company scope. Requires analytics view on that project."}],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Your company id (the token must belong to it, else 403)."},{"key":"id","value":""}]},"description":"Transfer a exploration to a new owner (analytics admin; reaches private items of inactive owners only)\n\nToken scope: `analytics:write`.","body":{"mode":"raw","raw":"{\n  \"owner_id\": 6\n}","options":{"raw":{"language":"json"}}}}},{"id":"42aa1f48-838b-4e33-8e3c-ff49801b7028","name":"createCompanyAnalyticsExport — Start an export job","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/analytics/exports","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","analytics","exports"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Your company id (the token must belong to it, else 403)."}]},"description":"Start an export job\n\nCSV / XLSX / PDF of a query, detail, dashboard or pack, rendered with the caller's permissions. Audited.\n\nB2: `export.cover` (PDF) prepends a cover page (title, company, project or scope, every filter applied, data as-of). PDFs show the company name as the eyebrow, its JPEG logo when the company has one (data: URL, passed through as /DCTDecode; PNG skipped), and the filters applied in every page footer. Token scope: `analytics:read`.","body":{"mode":"raw","raw":"{\n  \"export\": {\n    \"dashboard_id\": 42,\n    \"format\": \"csv\",\n    \"kind\": \"dashboard\",\n    \"tile_id\": \"by_status\",\n    \"time\": {\n      \"preset\": \"ytd\"\n    }\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"9ed8dfd8-605f-4c6a-8a3b-0f4b7e5d4652","name":"getCompanyAnalyticsExport — Export job status","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/analytics/exports/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","analytics","exports",":id"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Your company id (the token must belong to it, else 403)."},{"key":"id","value":""}]},"description":"Export job status\n\nYour export jobs and scheduled deliveries addressed to you. download_url is set once succeeded and points at exports/{id}/download. Token scope: `analytics:read`."}},{"id":"a50c97f7-2849-47e7-896f-a6ac4aea8952","name":"listCompanyAnalyticsExportDownload — Download your copy of an export or scheduled delivery","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/analytics/exports/:id/download","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","analytics","exports",":id","download"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Your company id (the token must belong to it, else 403)."},{"key":"id","value":""}]},"description":"Download your copy of an export or scheduled delivery\n\nThe file rendered for the caller. A scoped token may only download files rendered within its own scopes (403 otherwise). Access to the export's scope is re-checked. Token scope: `analytics:read`."}},{"id":"010aafb4-0c74-4a60-834a-352a93f277a9","name":"listCompanyAnalyticsGoals — List goals","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/analytics/goals","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","analytics","goals"],"query":[{"key":"project_id","value":"","disabled":true,"description":"Project scope; omit for company scope. Requires analytics view on that project."},{"key":"page","value":"1","disabled":true,"description":"1-based page"},{"key":"per_page","value":"100","disabled":true,"description":"Page size (default 100, max 1000)"}],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Your company id (the token must belong to it, else 403)."}]},"description":"List goals\n\nGoals the caller can open: company goals (company analytics) and goals on projects where the caller has analytics; private goals only for their owner, creator and share grantees. With project_id, that project's goals only. Values are not included (GET …/goals/{id}/value computes one). Token scope: `analytics:read`."}},{"id":"06f3f412-4aee-4af7-8386-bd2b14da99c2","name":"createCompanyAnalyticsGoal — Create a goal","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/analytics/goals","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","analytics","goals"],"query":[{"key":"project_id","value":"","disabled":true,"description":"Project scope; omit for company scope. Requires analytics view on that project."}],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Your company id (the token must belong to it, else 403)."}]},"description":"Create a goal\n\nNeeds analytics standard at the scope. The metric must be readable by the caller there. alert_when_behind creates a linked KPI alert (owner and caller as recipients) that is deleted with the goal. Audited. Token scope: `analytics:write`.","body":{"mode":"raw","raw":"{\n  \"goal\": {\n    \"alert_when_behind\": false,\n    \"due_date\": \"2026-10-01\",\n    \"filters\": [\n      {}\n    ],\n    \"metric_key\": \"pm.rfis_open\",\n    \"name\": \"PM weekly overview\",\n    \"op\": \"gte\",\n    \"owner_id\": 6,\n    \"target\": 12.5,\n    \"visibility\": \"private\",\n    \"window\": \"last_7d\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"947c3f92-d871-414e-8ff1-40deab3293e4","name":"getCompanyAnalyticsGoal — Get a goal","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/analytics/goals/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","analytics","goals",":id"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Your company id (the token must belong to it, else 403)."},{"key":"id","value":""}]},"description":"Get a goal\n\n404 unless the caller can open the goal (scope gate, then private visibility). Token scope: `analytics:read`."}},{"id":"12092c6b-67cf-49fe-8df1-7816bdd9d21f","name":"updateCompanyAnalyticsGoal — Update a goal","request":{"method":"PATCH","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/analytics/goals/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","analytics","goals",":id"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Your company id (the token must belong to it, else 403)."},{"key":"id","value":""}]},"description":"Update a goal\n\nOwner, creator or edit grantee with analytics standard, or an analytics admin. Visibility, owner and alert_when_behind are for the owner / creator / admin only. A goal with setting_key mirrors that settings target: its target is changed in Analytics settings (422 here). Audited. Token scope: `analytics:write`.","body":{"mode":"raw","raw":"{\n  \"goal\": {\n    \"alert_when_behind\": false,\n    \"due_date\": \"2026-10-01\",\n    \"filters\": [\n      {}\n    ],\n    \"name\": \"PM weekly overview\",\n    \"op\": \"gte\",\n    \"owner_id\": 6,\n    \"target\": 12.5,\n    \"visibility\": \"private\",\n    \"window\": \"last_7d\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"e5b0aba7-3dd1-4c1a-8626-eebb1e61d94f","name":"deleteCompanyAnalyticsGoal — Delete a goal","request":{"method":"DELETE","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/analytics/goals/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","analytics","goals",":id"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Your company id (the token must belong to it, else 403)."},{"key":"id","value":""}]},"description":"Delete a goal\n\nOwner / creator (standard) or analytics admin. Deletes the linked alert rule and the goal's shares. Audited. Token scope: `analytics:write`."}},{"id":"86cbb62f-b9fe-442b-85ec-06bbe159568a","name":"listCompanyAnalyticsGoalCheckins — List a goal's check-ins","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/analytics/goals/:id/checkins","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","analytics","goals",":id","checkins"],"query":[{"key":"page","value":"1","disabled":true,"description":"1-based page"},{"key":"per_page","value":"100","disabled":true,"description":"Page size (default 100, max 1000)"}],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Your company id (the token must belong to it, else 403)."},{"key":"id","value":""}]},"description":"List a goal's check-ins\n\nNewest first. Notes can quote numbers, so this is 404 to anyone who cannot open the goal. Token scope: `analytics:read`."}},{"id":"b135a713-252f-4f1a-8841-12f87f60e71f","name":"createCompanyAnalyticsGoalCheckin — Check in on a goal","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/analytics/goals/:id/checkins","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","analytics","goals",":id","checkins"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Your company id (the token must belong to it, else 403)."},{"key":"id","value":""}]},"description":"Check in on a goal\n\nOwner, creator, edit grantee (standard) or analytics admin. A status overrides the automatic status until the next check-in; a null status is a note only. as_of defaults to today and cannot be in the future. Audited (status only, never the note). Token scope: `analytics:write`.","body":{"mode":"raw","raw":"{\n  \"check_in\": {\n    \"as_of\": \"2026-10-01\",\n    \"note\": \"Open RFIs older than 14 days are trending up on two projects.\",\n    \"status\": \"on_track\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"addd7a89-30df-43e6-8c31-b48f95b243b5","name":"listCompanyAnalyticsGoalValue — A goal's value, computed now as the caller","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/analytics/goals/:id/value","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","analytics","goals",":id","value"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Your company id (the token must belong to it, else 403)."},{"key":"id","value":""}]},"description":"A goal's value, computed now as the caller\n\nNever stored: the metric runs through the engine with the caller's permissions (and token scopes). Any unreadable input gives value null with an unavailable reason, never 0 or a partial total. history is the weekly as_of snapshot series (last 12 weeks), only for unfiltered snapshot metrics. Token scope: `analytics:read`."}},{"id":"0298be3b-b5bd-43a5-890e-25349b8c2692","name":"listCompanyAnalyticsHealth — Analytics data health","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/analytics/health","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","analytics","health"],"query":[{"key":"project_id","value":"","disabled":true,"description":"Project scope; omit for company scope. Requires analytics view on that project."}],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Your company id (the token must belong to it, else 403)."}]},"description":"Analytics data health\n\nToken scope: `analytics:read`."}},{"id":"b95d1531-f4b4-4b6c-8ee4-def7b5902dc3","name":"listCompanyAnalyticsInsights — List insights visible to the caller","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/analytics/insights","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","analytics","insights"],"query":[{"key":"project_id","value":"","disabled":true,"description":"Project scope; omit for company scope. Requires analytics view on that project."},{"key":"filters[severity]","value":"","disabled":true,"description":"info | warn | crit | good"},{"key":"filters[domain]","value":"","disabled":true,"description":"Domain key"},{"key":"filters[status]","value":"","disabled":true,"description":"open (default) | dismissed | resolved"},{"key":"page","value":"1","disabled":true,"description":"1-based page"},{"key":"per_page","value":"100","disabled":true,"description":"Page size (default 100, max 1000)"}],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Your company id (the token must belong to it, else 403)."}]},"description":"List insights visible to the caller\n\nVisible when the caller can read `tool` on the insight's project, and is that tool's admin when the insight derives from row-private data. Token scope: `analytics:read`."}},{"id":"f3ccbe01-838d-4df2-8cf7-07483c81fa94","name":"createCompanyAnalyticsInsightsEvaluate — Evaluate insight rules now (analytics admin)","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/analytics/insights/evaluate","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","analytics","insights","evaluate"],"query":[{"key":"project_id","value":"","disabled":true,"description":"Project scope; omit for company scope. Requires analytics view on that project."}],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Your company id (the token must belong to it, else 403)."}]},"description":"Evaluate insight rules now (analytics admin)\n\nToken scope: `analytics:write`."}},{"id":"7b164eba-22ce-4635-8f92-799610f5b430","name":"updateCompanyAnalyticsInsight — Dismiss / reopen an insight, give it a reason, or assign it","request":{"method":"PATCH","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/analytics/insights/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","analytics","insights",":id"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Your company id (the token must belong to it, else 403)."},{"key":"id","value":""}]},"description":"Dismiss / reopen an insight, give it a reason, or assign it\n\nNeeds analytics standard on the insight's project (or company admin). The assignee must be able to see the insight (analytics view, read on every input tool, tool admin when row-private); otherwise 422. The assignee is notified (`assigned`, title and link only). A dismiss reason needs the insight dismissed; reopening clears it. Token scope: `analytics:write`.","body":{"mode":"raw","raw":"{\n  \"insight\": {\n    \"assignee_id\": 6,\n    \"dismiss_reason\": \"Open RFIs older than 14 days are trending up on two projects.\",\n    \"status\": \"open\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"00d7c689-a179-4206-864d-7138dd8e1fa2","name":"taskCompanyAnalyticsInsight — Create (or return) the task for a project insight","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/analytics/insights/:id/task","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","analytics","insights",":id","task"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Your company id (the token must belong to it, else 403)."},{"key":"id","value":""}]},"description":"Create (or return) the task for a project insight\n\nTasks create permission on the insight's project (tokens: analytics:write and tasks:write). One task per insight: a repeat call returns it (200). Company-level insights are 422. The task is private, titled with the insight, and links back to it."}},{"id":"6b18d9db-e1c6-4cde-8ad5-de2cab09b9cb","name":"listCompanyAnalyticsMetrics — List company custom metrics","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/analytics/metrics","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","analytics","metrics"],"query":[{"key":"status","value":"","disabled":true}],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Your company id (the token must belong to it, else 403)."}]},"description":"List company custom metrics\n\nAnalytics admins see drafts and archived metrics; everyone else sees published ones. Published metrics also appear in GET catalog for viewers who can read every input. Token scope: `analytics:read`."}},{"id":"a9dbc3ed-c569-4ccf-8800-ec3617c24ba1","name":"createCompanyAnalyticsMetric — Create a custom metric (draft)","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/analytics/metrics","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","analytics","metrics"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Your company id (the token must belong to it, else 403)."}]},"description":"Create a custom metric (draft)\n\nAnalytics admin (company level). Every write is audited (analytics_custom_metric) and invalidates the company catalog overlay. The definition is validated against the company catalog: unknown or incompatible dims, depth or size overflow and custom-in-custom refs are 422. Token scope: `analytics:write`.","body":{"mode":"raw","raw":"{\n  \"metric\": {\n    \"definition\": {\n      \"base\": \"open\",\n      \"kind\": \"segment\"\n    },\n    \"description\": \"Open RFIs older than 14 days are trending up on two projects.\",\n    \"direction\": \"higher_better\",\n    \"domain\": \"open\",\n    \"label\": \"Open RFIs\",\n    \"slug\": \"status\",\n    \"synonyms\": [\n      \"open\"\n    ],\n    \"unit\": \"count\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"97601910-5b38-4158-830c-f7460abee5b4","name":"createCompanyAnalyticsMetricsPreview — Preview an unsaved custom metric definition","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/analytics/metrics/preview","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","analytics","metrics","preview"],"query":[{"key":"project_id","value":"","disabled":true,"description":"Project scope; omit for company scope. Requires analytics view on that project."}],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Your company id (the token must belong to it, else 403)."}]},"description":"Preview an unsaved custom metric definition\n\nRuns the draft through the engine as the caller (analytics admin), with the same tenancy, row privacy and fail-closed rules as a published metric. Nothing is saved. Token scope: `analytics:read`.","body":{"mode":"raw","raw":"{\n  \"definition\": {\n    \"base\": \"open\",\n    \"kind\": \"segment\"\n  },\n  \"label\": \"Open RFIs\",\n  \"query\": {},\n  \"unit\": \"count\"\n}","options":{"raw":{"language":"json"}}}}},{"id":"7329faae-7091-482a-8399-302736cdb21a","name":"getCompanyAnalyticsMetric — Get a custom metric","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/analytics/metrics/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","analytics","metrics",":id"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Your company id (the token must belong to it, else 403)."},{"key":"id","value":""}]},"description":"Get a custom metric\n\nToken scope: `analytics:read`."}},{"id":"21c016bc-1d1c-4b92-8ff2-baad7ab41a0d","name":"updateCompanyAnalyticsMetric — Edit a custom metric (new version)","request":{"method":"PATCH","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/analytics/metrics/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","analytics","metrics",":id"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Your company id (the token must belong to it, else 403)."},{"key":"id","value":""}]},"description":"Edit a custom metric (new version)\n\nAnalytics admin (company level). Every write is audited (analytics_custom_metric) and invalidates the company catalog overlay. Saves a new version and clears certification. A stale `version` is 409. Token scope: `analytics:write`.","body":{"mode":"raw","raw":"{\n  \"metric\": {},\n  \"version\": 3\n}","options":{"raw":{"language":"json"}}}}},{"id":"62506736-cead-4ab8-89e3-e4d9ce9e8133","name":"deleteCompanyAnalyticsMetric — Archive a custom metric","request":{"method":"DELETE","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/analytics/metrics/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","analytics","metrics",":id"],"query":[{"key":"force","value":"","disabled":true,"description":"Archive even while saved content uses it."}],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Your company id (the token must belong to it, else 403)."},{"key":"id","value":""}]},"description":"Archive a custom metric\n\nAnalytics admin (company level). Every write is audited (analytics_custom_metric) and invalidates the company catalog overlay. C2: blocked with 409 and the usage list while saved content uses it, unless force=true. Saved tiles, alerts and exports that use it then get 422 \"the custom metric was archived\", never a 500. Publish again to restore it. Token scope: `analytics:write`."}},{"id":"da2950d3-629b-41dd-88af-dd6aa6bc981c","name":"publishCompanyAnalyticsMetric — Publish a custom metric","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/analytics/metrics/:id/publish","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","analytics","metrics",":id","publish"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Your company id (the token must belong to it, else 403)."},{"key":"id","value":""}]},"description":"Publish a custom metric\n\nAnalytics admin (company level). Every write is audited (analytics_custom_metric) and invalidates the company catalog overlay. Re-validates the definition first. Token scope: `analytics:write`."}},{"id":"d351c09e-ebed-4fed-872c-39630279d24e","name":"listCompanyAnalyticsMetricVersions — Custom metric version history (newest first)","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/analytics/metrics/:id/versions","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","analytics","metrics",":id","versions"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Your company id (the token must belong to it, else 403)."},{"key":"id","value":""}]},"description":"Custom metric version history (newest first)\n\nToken scope: `analytics:read`."}},{"id":"d588f8a0-7cb7-4de4-8117-d2b10916aa60","name":"restoreCompanyAnalyticsMetricVersion — Restore a custom metric version (as a new version)","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/analytics/metrics/:id/versions/:v/restore","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","analytics","metrics",":id","versions",":v","restore"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Your company id (the token must belong to it, else 403)."},{"key":"id","value":""},{"key":"v","value":"","description":"Revision / version number."}]},"description":"Restore a custom metric version (as a new version)\n\nToken scope: `analytics:write`.","body":{"mode":"raw","raw":"{\n  \"version\": 3\n}","options":{"raw":{"language":"json"}}}}},{"id":"b3bdd916-7ed2-4338-87b4-26c79ae63ed0","name":"listCompanyAnalyticsPacks — List report packs","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/analytics/packs","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","analytics","packs"],"query":[{"key":"filters[scope]","value":"","disabled":true,"description":"company | project"},{"key":"filters[domain]","value":"","disabled":true,"description":"Domain key"}],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Your company id (the token must belong to it, else 403)."}]},"description":"List report packs\n\nToken scope: `analytics:read`."}},{"id":"b5d42f20-2bf3-4f58-8dd7-9582fc57ee9f","name":"getCompanyAnalyticsPack — Show a report pack","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/analytics/packs/:key","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","analytics","packs",":key"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Your company id (the token must belong to it, else 403)."},{"key":"key","value":""}]},"description":"Show a report pack\n\nToken scope: `analytics:read`."}},{"id":"1bac2e2b-0970-4cfe-88c6-c12b60b12f69","name":"cloneCompanyAnalyticsPack — Clone a pack into a saved dashboard (a copy; pack_key set)","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/analytics/packs/:key/clone","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","analytics","packs",":key","clone"],"query":[{"key":"project_id","value":"","disabled":true,"description":"Project scope; omit for company scope. Requires analytics view on that project."}],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Your company id (the token must belong to it, else 403)."},{"key":"key","value":""}]},"description":"Clone a pack into a saved dashboard (a copy; pack_key set)\n\nToken scope: `analytics:write`.","body":{"mode":"raw","raw":"{\n  \"name\": \"PM weekly overview\"\n}","options":{"raw":{"language":"json"}}}}},{"id":"ba749181-3614-4f13-8e29-739973b29855","name":"listCompanyAnalyticsPackData — Get a report pack's computed tile data","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/analytics/packs/:key/data","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","analytics","packs",":key","data"],"query":[{"key":"project_id","value":"","disabled":true,"description":"Project scope; omit for company scope. Requires analytics view on that project."},{"key":"f","value":"","disabled":true,"description":"base64url(JSON FilterState): dashboard filter values and cross-filter chips, as in the app URL."},{"key":"filters[<filter key>]","value":"","disabled":true,"description":"Value(s) for one of the dashboard's global filters (`spec.filters[].key`), comma-separated for several; merged over `f`."},{"key":"time_preset","value":"","disabled":true,"description":"Time window for every tile (keeps each tile's time dimension). Use either this or from/to."},{"key":"from","value":"","disabled":true,"description":"Time window start (YYYY-MM-DD), every tile."},{"key":"to","value":"","disabled":true,"description":"Time window end (YYYY-MM-DD), every tile."},{"key":"tile","value":"","disabled":true,"description":"Only this tile (`spec.tiles[].id`); 404 when there is no such tile."},{"key":"format","value":"","disabled":true,"description":"`json` (default): per-tile results. `csv` | `xlsx` | `pdf`: the rendered file, exactly as an export (a single tile is a plain CSV table; audited)."}],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Your company id (the token must belong to it, else 403)."},{"key":"key","value":""}]},"description":"Get a report pack's computed tile data\n\nComputed data of a curated report pack: every tile runs as the token's user with the screen's own tile query (global filters, chips, date ranges), plain query tiles share one scan. Tiles the user cannot fully read report `unavailable` / `partial` on their result; a failed tile carries `error` and never fails the call. Read: `analytics:read`."}},{"id":"f1cefebf-616e-4305-834e-a193712b1453","name":"listCompanyAnalyticsQuery — Run an analytics query (company, GET form)","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/analytics/query","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","analytics","query"],"query":[{"key":"q","value":"","disabled":false,"description":"base64url(JSON QuerySpec): the shared ?q= codec"},{"key":"format","value":"","disabled":true,"description":"`json` (default) or `csv` (the result as a CSV table, audited like an export)."}],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Your company id (the token must belong to it, else 403)."}]},"description":"Run an analytics query (company, GET form)\n\nRead semantics: token scope `analytics:read` (not :write) plus analytics view. Every metric additionally needs read access to its source tool, the tool enabled, and the source's token scope; metrics failing that are listed in `unavailable` with null values, never 0. Supports ETag / If-None-Match (304)."}},{"id":"e9349b21-c4a3-4249-80e5-08b6195617db","name":"createCompanyAnalyticsQuery — Run an analytics query (company)","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/analytics/query","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","analytics","query"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Your company id (the token must belong to it, else 403)."}]},"description":"Run an analytics query (company)\n\nRead semantics: token scope `analytics:read` (not :write) plus analytics view. Every metric additionally needs read access to its source tool, the tool enabled, and the source's token scope; metrics failing that are listed in `unavailable` with null values, never 0. POST is unavailable (403) on read-only (expired trial / suspended) workspaces; use the GET form with `?q=`. No ETag on POST.","body":{"mode":"raw","raw":"{\n  \"query\": {\n    \"dimensions\": [\n      {\n        \"key\": \"status\"\n      }\n    ],\n    \"metrics\": [\n      \"pm.rfis_open\",\n      \"pm.rfis_total\"\n    ],\n    \"time\": {\n      \"preset\": \"last_90d\"\n    }\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"700dd03d-4271-4d75-8c2a-61f94e2eeb92","name":"createCompanyAnalyticsQueryBatch — Run several analytics queries in one call","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/analytics/query/batch","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","analytics","query","batch"],"query":[{"key":"project_id","value":"","disabled":true,"description":"Project scope; omit for company scope. Requires analytics view on that project."}],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Your company id (the token must belong to it, else 403)."}]},"description":"Run several analytics queries in one call\n\nRead semantics: token scope `analytics:read`. 1 to 24 QuerySpecs run as the token's user, sharing scans; each counts against the rate limit. The response has one item per query, in order: the QueryResult, or the status and errors POST query would have returned for it.","body":{"mode":"raw","raw":"{\n  \"queries\": [\n    {\n      \"metrics\": [\n        \"pm.rfis_open\"\n      ]\n    },\n    {\n      \"dimensions\": [\n        {\n          \"key\": \"status\"\n        }\n      ],\n      \"metrics\": [\n        \"pm.rfis_open\",\n        \"pm.rfis_total\"\n      ],\n      \"time\": {\n        \"preset\": \"last_90d\"\n      }\n    }\n  ]\n}","options":{"raw":{"language":"json"}}}}},{"id":"abe1da36-ca82-4352-8c0a-f49b5996bcd7","name":"createCompanyAnalyticsQueryDetail — Records behind a result cell (company)","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/analytics/query/detail","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","analytics","query","detail"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Your company id (the token must belong to it, else 403)."}]},"description":"Records behind a result cell (company)\n\nRead semantics: token scope `analytics:read` (not :write) plus analytics view. Every metric additionally needs read access to its source tool, the tool enabled, and the source's token scope; metrics failing that are listed in `unavailable` with null values, never 0. POST is unavailable (403) on read-only (expired trial / suspended) workspaces; use the GET form with `?q=`. Keyset paging, 200 rows per page; each row deep-links to the record.","body":{"mode":"raw","raw":"{\n  \"cell\": [\n    {\n      \"dim\": \"status\",\n      \"value\": \"open\"\n    }\n  ],\n  \"metric\": \"pm.rfis_open\",\n  \"query\": {\n    \"dimensions\": [\n      {\n        \"key\": \"status\"\n      }\n    ],\n    \"metrics\": [\n      \"pm.rfis_open\"\n    ]\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"530e85e8-d0bd-4ef9-83b9-b04ea87df970","name":"listCompanyAnalyticsReportLinks — List report links","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/analytics/report-links","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","analytics","report-links"],"query":[{"key":"status","value":"","disabled":true}],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Your company id (the token must belong to it, else 403)."}]},"description":"List report links\n\nAnalytics admins see every link in the company; everyone else sees the links they created. ?status=active narrows to live links. Token scope: `analytics:read`."}},{"id":"1dae1fb9-b172-43d6-8d87-2fe2d9c2efc7","name":"createCompanyAnalyticsReportLink — Publish a report link","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/analytics/report-links","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","analytics","report-links"],"query":[{"key":"project_id","value":"","disabled":true,"description":"Project scope; omit for company scope. Requires analytics view on that project."}],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Your company id (the token must belong to it, else 403)."}]},"description":"Publish a report link\n\nRenders the dashboard or pack AS THE CALLER with the locked filters (PDF + scene JSON in storage) and returns the public URL once. Needs the company setting report_links_enabled (403 when off); owner or editor of the dashboard (packs: analytics admins). A dashboard outside the caller's company or scope is 404. Audited. Token scope: `analytics:write`.","body":{"mode":"raw","raw":"{\n  \"link\": {\n    \"expires_in_days\": 1,\n    \"filters\": {},\n    \"pack_key\": \"open\",\n    \"refresh\": \"none\",\n    \"target_id\": 6,\n    \"target_type\": \"dashboard\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"8c4513a0-5920-413f-88e4-b013938b9cbd","name":"createCompanyAnalyticsReportLinksRevokeAll — Revoke every report link","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/analytics/report-links/revoke-all","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","analytics","report-links","revoke-all"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Your company id (the token must belong to it, else 403)."}]},"description":"Revoke every report link\n\nAnalytics admins: turn off every live link in the company. Audited per link. Token scope: `analytics:write`."}},{"id":"c7e40642-01de-4eda-8472-c5785274fe3c","name":"deleteCompanyAnalyticsReportLink — Revoke a report link","request":{"method":"DELETE","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/analytics/report-links/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","analytics","report-links",":id"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Your company id (the token must belong to it, else 403)."},{"key":"id","value":""}]},"description":"Revoke a report link\n\nCreator or analytics admin. Deletes the snapshot files; the public link then answers 410. Idempotent. Audited. Token scope: `analytics:write`."}},{"id":"107dbe7b-0067-4930-8030-516fb6705e15","name":"listCompanyAnalyticsSchedules — List scheduled deliveries","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/analytics/schedules","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","analytics","schedules"],"query":[{"key":"project_id","value":"","disabled":true,"description":"Project scope; omit for company scope. Requires analytics view on that project."},{"key":"page","value":"1","disabled":true,"description":"1-based page"},{"key":"per_page","value":"100","disabled":true,"description":"Page size (default 100, max 1000)"}],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Your company id (the token must belong to it, else 403)."}]},"description":"List scheduled deliveries\n\nToken scope: `analytics:read`."}},{"id":"7b1fef7f-f5e7-4bb0-8565-f408a2747383","name":"createCompanyAnalyticsSchedule — Create a scheduled delivery","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/analytics/schedules","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","analytics","schedules"],"query":[{"key":"project_id","value":"","disabled":true,"description":"Project scope; omit for company scope. Requires analytics view on that project."}],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Your company id (the token must belong to it, else 403)."}]},"description":"Create a scheduled delivery\n\nRendered per recipient, as that recipient; the creator's token scopes are frozen as a ceiling. Recipients must be active company users with analytics view. Audited.\n\nB2: `schedule.burst` = \"project\" delivers one file per project each recipient can read (as that recipient, the project filter set; at most 50 per run, the rest named as \"+N more\" in the email). Company scope only: a project-scoped schedule with burst \"project\" returns 422. PDF bursts carry a cover page. Token scope: `analytics:write`.","body":{"mode":"raw","raw":"{\n  \"schedule\": {\n    \"burst\": \"none\",\n    \"cadence\": \"daily\",\n    \"enabled\": true,\n    \"filters\": {},\n    \"format\": \"csv\",\n    \"hour\": 6,\n    \"monthday\": 1,\n    \"name\": \"PM weekly overview\",\n    \"pack_key\": \"open\",\n    \"recipient_ids\": [\n      6\n    ],\n    \"target_id\": 6,\n    \"target_type\": \"dashboard\",\n    \"timezone\": \"America/Chicago\",\n    \"weekday\": 0\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"43422f65-8bbe-45ec-8108-da3cbb3bda14","name":"getCompanyAnalyticsSchedule — Show a scheduled delivery","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/analytics/schedules/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","analytics","schedules",":id"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Your company id (the token must belong to it, else 403)."},{"key":"id","value":""}]},"description":"Show a scheduled delivery\n\nToken scope: `analytics:read`."}},{"id":"7984b50e-213e-4c2e-8273-830aed3dfe80","name":"updateCompanyAnalyticsSchedule — Update a scheduled delivery","request":{"method":"PATCH","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/analytics/schedules/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","analytics","schedules",":id"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Your company id (the token must belong to it, else 403)."},{"key":"id","value":""}]},"description":"Update a scheduled delivery\n\nB2: `schedule.burst` may be changed (\"none\" | \"project\"); 422 at project scope. Token scope: `analytics:write`.","body":{"mode":"raw","raw":"{\n  \"schedule\": {\n    \"burst\": \"none\",\n    \"cadence\": \"daily\",\n    \"enabled\": true,\n    \"filters\": {},\n    \"format\": \"csv\",\n    \"hour\": 6,\n    \"monthday\": 1,\n    \"name\": \"PM weekly overview\",\n    \"recipient_ids\": [\n      6\n    ],\n    \"timezone\": \"America/Chicago\",\n    \"weekday\": 0\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"2a7ef980-e935-4532-8e0b-490350516430","name":"deleteCompanyAnalyticsSchedule — Delete a scheduled delivery","request":{"method":"DELETE","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/analytics/schedules/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","analytics","schedules",":id"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Your company id (the token must belong to it, else 403)."},{"key":"id","value":""}]},"description":"Delete a scheduled delivery\n\nToken scope: `analytics:write`."}},{"id":"e468532b-f378-48e4-8a41-3e73e2e8c18a","name":"listCompanyAnalyticsScheduleFile — Download the file behind an analytics.schedule.delivered webhook","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/analytics/schedules/:id/file","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","analytics","schedules",":id","file"],"query":[{"key":"token","value":"","disabled":false,"description":"The signed token from an `analytics.schedule.delivered` webhook (`data.file.download_url`)."}],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Your company id (the token must belong to it, else 403)."},{"key":"id","value":""}]},"description":"Download the file behind an analytics.schedule.delivered webhook\n\nNo API token needed: the signed, expiring token is the credential (hand it only to systems that may see the schedule owner's view). The file was rendered once AS THE SCHEDULE OWNER. 403 bad signature; 410 expired, schedule deleted or webhook turned off, owner no longer active or without analytics, report_links_enabled off, or the file purged by retention. Token scope: `analytics:read` (when a bearer token is sent it is ignored)."}},{"id":"b8475ec9-d8d0-4274-8ace-fe64b67b1c49","name":"runCompanyAnalyticsSchedule — Deliver a schedule now","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/analytics/schedules/:id/run","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","analytics","schedules",":id","run"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Your company id (the token must belong to it, else 403)."},{"key":"id","value":""}]},"description":"Deliver a schedule now\n\nToken scope: `analytics:write`."}},{"id":"b782a13f-a78b-4de3-8911-b6d4fe372b73","name":"transferCompanyAnalyticsSchedule — Transfer a schedule to a new owner (admin only)","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/analytics/schedules/:id/transfer","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","analytics","schedules",":id","transfer"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Your company id (the token must belong to it, else 403)."},{"key":"id","value":""}]},"description":"Transfer a schedule to a new owner (admin only)\n\nToken scope: `analytics:write`.","body":{"mode":"raw","raw":"{\n  \"owner_id\": 6\n}","options":{"raw":{"language":"json"}}}}},{"id":"6838032d-e9f6-4596-8b2c-31beffc998bc","name":"listCompanyAnalyticsSettings — Effective analytics settings","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/analytics/settings","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","analytics","settings"],"query":[{"key":"project_id","value":"","disabled":true,"description":"Project scope; omit for company scope. Requires analytics view on that project."}],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Your company id (the token must belong to it, else 403)."}]},"description":"Effective analytics settings\n\nToken scope: `analytics:read`."}},{"id":"5546102f-4ed5-4aeb-8ca3-691740cfe30e","name":"updateCompanyAnalyticsSettings — Update analytics settings (analytics admin)","request":{"method":"PATCH","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/analytics/settings","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","analytics","settings"],"query":[{"key":"project_id","value":"","disabled":true,"description":"Project scope; omit for company scope. Requires analytics view on that project."}],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Your company id (the token must belong to it, else 403)."}]},"description":"Update analytics settings (analytics admin)\n\nCompany defaults without project_id; project overrides with it. A null value removes the override. Token scope: `analytics:write`.","body":{"mode":"raw","raw":"{\n  \"settings\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"db06d6de-6ea5-41a7-8c30-79a85a435d1d","name":"listCompanyAnalyticsStory — Project Story (weekly brief or Today)","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/analytics/story","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","analytics","story"],"query":[{"key":"project_id","value":"","disabled":true,"description":"Project scope; omit for company scope. Requires analytics view on that project."},{"key":"horizon","value":"","disabled":true},{"key":"as_of","value":"","disabled":true,"description":"Story date (YYYY-MM-DD); default today in the company time zone."}],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Your company id (the token must belong to it, else 403)."}]},"description":"Project Story (weekly brief or Today)\n\nDeterministic, cited sentences composed as the caller: week = what changed and why it matters; today = the superintendent's board (\"Me\" items bind to the caller). Requires analytics view on the project. Token scope: `analytics:read`."}},{"id":"f4a72c12-8d48-4a56-8fe2-50466b2b7bbe","name":"listProjectAnalyticsCatalog — Catalog of metrics and dimensions readable by the caller (project)","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/analytics/catalog","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","analytics","catalog"],"variable":[{"key":"project_id","value":"{{projectId}}","description":"Project id."}]},"description":"Catalog of metrics and dimensions readable by the caller (project)\n\nRead semantics: token scope `analytics:read` (not :write) plus analytics view. Every metric additionally needs read access to its source tool, the tool enabled, and the source's token scope; metrics failing that are listed in `unavailable` with null values, never 0."}},{"id":"71b236d4-1b3b-4b20-833e-b050a8132ded","name":"listProjectAnalyticsDashboards — List dashboards (project)","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/analytics/dashboards","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","analytics","dashboards"],"query":[{"key":"filters[visibility]","value":"","disabled":true,"description":"private | project | company"},{"key":"filters[certified]","value":"","disabled":true,"description":"Certified only"},{"key":"filters[favorite]","value":"","disabled":true,"description":"Caller's favorites only"},{"key":"page","value":"1","disabled":true,"description":"1-based page"},{"key":"per_page","value":"100","disabled":true,"description":"Page size (default 100, max 1000)"}],"variable":[{"key":"project_id","value":"{{projectId}}","description":"Project id."}]},"description":"List dashboards (project)\n\nVisible = own private dashboards + project/company-visible ones the caller can view. Token scope: `analytics:read`."}},{"id":"25f2ccbe-7e29-4983-8a73-1341300d6098","name":"createProjectAnalyticsDashboard — Create a dashboard (project)","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/analytics/dashboards","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","analytics","dashboards"],"variable":[{"key":"project_id","value":"{{projectId}}","description":"Project id."}]},"description":"Create a dashboard (project)\n\nRequires analytics standard. `spec` is a DashboardSpec, validated on write and read. Token scope: `analytics:write`.","body":{"mode":"raw","raw":"{\n  \"dashboard\": {\n    \"name\": \"PM weekly overview\",\n    \"spec\": {\n      \"filters\": [\n        {\n          \"default\": {\n            \"preset\": \"last_12m\"\n          },\n          \"dim\": \"created\",\n          \"key\": \"period\",\n          \"kind\": \"date_range\",\n          \"label\": \"Created\"\n        },\n        {\n          \"dim\": \"status\",\n          \"key\": \"status\",\n          \"kind\": \"multi\",\n          \"label\": \"Status\"\n        }\n      ],\n      \"tiles\": [\n        {\n          \"id\": \"open\",\n          \"kind\": \"query\",\n          \"layout\": {\n            \"h\": 2,\n            \"w\": 3,\n            \"x\": 0,\n            \"y\": 0\n          },\n          \"query\": {\n            \"metrics\": [\n              \"pm.rfis_open\"\n            ]\n          },\n          \"title\": \"Open RFIs\",\n          \"viz\": {\n            \"options\": {},\n            \"type\": \"kpi\"\n          }\n        },\n        {\n          \"id\": \"by_status\",\n          \"kind\": \"query\",\n          \"layout\": {\n            \"h\": 4,\n            \"w\": 9,\n            \"x\": 3,\n            \"y\": 0\n          },\n          \"query\": {\n            \"dimensions\": [\n              {\n                \"key\": \"status\"\n              }\n            ],\n            \"metrics\": [\n              \"pm.rfis_total\"\n            ]\n          },\n          \"title\": \"RFIs by status\",\n          \"viz\": {\n            \"options\": {},\n            \"type\": \"bar\"\n          }\n        }\n      ],\n      \"version\": 1\n    },\n    \"visibility\": \"project\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"c88001c1-a296-4f20-8c78-2e3fafe70d3b","name":"getProjectAnalyticsDashboard — Show a dashboard (project)","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/analytics/dashboards/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","analytics","dashboards",":id"],"variable":[{"key":"project_id","value":"{{projectId}}","description":"Project id."},{"key":"id","value":""}]},"description":"Show a dashboard (project)\n\nToken scope: `analytics:read`."}},{"id":"83bc5e8a-27b7-49a6-81a9-e9953b0782eb","name":"updateProjectAnalyticsDashboard — Update a dashboard (project)","request":{"method":"PATCH","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/analytics/dashboards/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","analytics","dashboards",":id"],"variable":[{"key":"project_id","value":"{{projectId}}","description":"Project id."},{"key":"id","value":""}]},"description":"Update a dashboard (project)\n\nOwner (standard) or analytics admin. `certified` is admin-only. Token scope: `analytics:write`.","body":{"mode":"raw","raw":"{\n  \"dashboard\": {\n    \"name\": \"PM weekly overview (FY27)\",\n    \"version\": 3\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"06eafc81-e243-4329-8737-5f4eba9dc2cb","name":"deleteProjectAnalyticsDashboard — Delete a dashboard (project)","request":{"method":"DELETE","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/analytics/dashboards/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","analytics","dashboards",":id"],"variable":[{"key":"project_id","value":"{{projectId}}","description":"Project id."},{"key":"id","value":""}]},"description":"Delete a dashboard (project)\n\nSoft delete. Owner or analytics admin. Token scope: `analytics:write`."}},{"id":"53d6d64a-94a5-4934-839b-cca6f0ffe4a3","name":"listProjectAnalyticsQuery — Run an analytics query (project, GET form)","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/analytics/query","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","analytics","query"],"query":[{"key":"q","value":"","disabled":false,"description":"base64url(JSON QuerySpec): the shared ?q= codec"}],"variable":[{"key":"project_id","value":"{{projectId}}","description":"Project id."}]},"description":"Run an analytics query (project, GET form)\n\nRead semantics: token scope `analytics:read` (not :write) plus analytics view. Every metric additionally needs read access to its source tool, the tool enabled, and the source's token scope; metrics failing that are listed in `unavailable` with null values, never 0. Supports ETag / If-None-Match (304)."}},{"id":"1e893584-5f67-4ac0-822a-7ae16757a806","name":"createProjectAnalyticsQuery — Run an analytics query (project)","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/analytics/query","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","analytics","query"],"variable":[{"key":"project_id","value":"{{projectId}}","description":"Project id."}]},"description":"Run an analytics query (project)\n\nRead semantics: token scope `analytics:read` (not :write) plus analytics view. Every metric additionally needs read access to its source tool, the tool enabled, and the source's token scope; metrics failing that are listed in `unavailable` with null values, never 0. POST is unavailable (403) on read-only (expired trial / suspended) workspaces; use the GET form with `?q=`. No ETag on POST.","body":{"mode":"raw","raw":"{\n  \"query\": {\n    \"dimensions\": [\n      {\n        \"key\": \"status\"\n      }\n    ],\n    \"metrics\": [\n      \"pm.rfis_open\",\n      \"pm.rfis_total\"\n    ],\n    \"time\": {\n      \"preset\": \"last_90d\"\n    }\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"e5d56036-584c-4d7a-86b2-f7382399c073","name":"createProjectAnalyticsQueryDetail — Records behind a result cell (project)","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/analytics/query/detail","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","analytics","query","detail"],"variable":[{"key":"project_id","value":"{{projectId}}","description":"Project id."}]},"description":"Records behind a result cell (project)\n\nRead semantics: token scope `analytics:read` (not :write) plus analytics view. Every metric additionally needs read access to its source tool, the tool enabled, and the source's token scope; metrics failing that are listed in `unavailable` with null values, never 0. POST is unavailable (403) on read-only (expired trial / suspended) workspaces; use the GET form with `?q=`. Keyset paging, 200 rows per page; each row deep-links to the record.","body":{"mode":"raw","raw":"{\n  \"cell\": [\n    {\n      \"dim\": \"status\",\n      \"value\": \"open\"\n    }\n  ],\n  \"metric\": \"pm.rfis_open\",\n  \"query\": {\n    \"dimensions\": [\n      {\n        \"key\": \"status\"\n      }\n    ],\n    \"metrics\": [\n      \"pm.rfis_open\"\n    ]\n  }\n}","options":{"raw":{"language":"json"}}}}}]},{"name":"Approvals","description":"Module: approvals","item":[{"id":"6a525344-1c01-4edf-80af-f0bce7eaea0e","name":"listCompanyApprovalWorkflowsApprovals — My approvals: runs waiting on me, decided by me, or submitted by me","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/approval_workflows/approvals","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","approval_workflows","approvals"],"query":[{"key":"filter","value":"","disabled":true},{"key":"object_type","value":"","disabled":true},{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true}],"variable":[{"key":"company_id","value":"{{companyId}}"}]},"description":"My approvals: runs waiting on me, decided by me, or submitted by me"}},{"id":"a8a435fd-41b0-4a9a-8b49-dda1c92e410f","name":"createCompanyApprovalWorkflowsApproval — Submit a record for approval (agents may submit; only people decide)","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/approval_workflows/approvals","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","approval_workflows","approvals"],"variable":[{"key":"company_id","value":"{{companyId}}"}]},"description":"Submit a record for approval (agents may submit; only people decide)","body":{"mode":"raw","raw":"{\n  \"comment\": \"\",\n  \"object_id\": 0,\n  \"object_type\": \"change_order\",\n  \"policy_id\": 0\n}","options":{"raw":{"language":"json"}}}}},{"id":"f60fce89-dd00-4d43-8216-4fe74f61a9c5","name":"createCompanyApprovalWorkflowsApprovalsBulkDecision — Approve several runs (per-item results; not every type allows bulk)","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/approval_workflows/approvals/bulk_decision","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","approval_workflows","approvals","bulk_decision"],"variable":[{"key":"company_id","value":"{{companyId}}"}]},"description":"Approve several runs (per-item results; not every type allows bulk)","body":{"mode":"raw","raw":"{\n  \"comment\": \"\",\n  \"instance_ids\": [\n    0\n  ]\n}","options":{"raw":{"language":"json"}}}}},{"id":"508afd45-f2fe-439a-88c9-1b1ef34dbb66","name":"getCompanyApprovalWorkflowsApproval — Show a run with tasks and audit trail","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/approval_workflows/approvals/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","approval_workflows","approvals",":id"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Show a run with tasks and audit trail"}},{"id":"93eee369-63b0-41b0-84a7-ae4eb648e9ae","name":"cancelCompanyApprovalWorkflowsApproval — Withdraw a pending run (submitter or admin)","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/approval_workflows/approvals/:id/cancel","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","approval_workflows","approvals",":id","cancel"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Withdraw a pending run (submitter or admin)","body":{"mode":"raw","raw":"{\n  \"reason\": \"\"\n}","options":{"raw":{"language":"json"}}}}},{"id":"d2cfd330-b0e0-4fc1-8be3-0354e75ab1af","name":"createCompanyApprovalWorkflowsApprovalComment — Comment on a run","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/approval_workflows/approvals/:id/comments","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","approval_workflows","approvals",":id","comments"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Comment on a run","body":{"mode":"raw","raw":"{\n  \"comment\": \"\"\n}","options":{"raw":{"language":"json"}}}}},{"id":"958bc5fd-a8c5-4122-8ba9-75e0ad6e9208","name":"decisionCompanyApprovalWorkflowsApproval — Approve or reject (reject needs a comment)","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/approval_workflows/approvals/:id/decision","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","approval_workflows","approvals",":id","decision"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Approve or reject (reject needs a comment)","body":{"mode":"raw","raw":"{\n  \"comment\": \"\",\n  \"decision\": \"approve\"\n}","options":{"raw":{"language":"json"}}}}},{"id":"69f2fe30-0968-48ce-8d1b-eeb4df4dc5df","name":"listCompanyApprovalWorkflowsCostCodeOwners — Cost code owners of a project","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/approval_workflows/cost_code_owners","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","approval_workflows","cost_code_owners"],"query":[{"key":"project_id","value":"","disabled":false}],"variable":[{"key":"company_id","value":"{{companyId}}"}]},"description":"Cost code owners of a project"}},{"id":"ef9cda68-7fe8-44b6-8ba2-345670346bd2","name":"createCompanyApprovalWorkflowsCostCodeOwner — Assign a cost code owner (company admins)","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/approval_workflows/cost_code_owners","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","approval_workflows","cost_code_owners"],"variable":[{"key":"company_id","value":"{{companyId}}"}]},"description":"Assign a cost code owner (company admins)","body":{"mode":"raw","raw":"{\n  \"cost_code_id\": 0,\n  \"project_id\": 0,\n  \"user_id\": 0\n}","options":{"raw":{"language":"json"}}}}},{"id":"67b66660-3d0a-40d9-88c7-fc096affe9a0","name":"deleteCompanyApprovalWorkflowsCostCodeOwner — Remove a cost code owner","request":{"method":"DELETE","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/approval_workflows/cost_code_owners/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","approval_workflows","cost_code_owners",":id"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Remove a cost code owner"}},{"id":"251bbfaa-ca19-4ecb-8c7a-f17f925837cc","name":"listCompanyApprovalWorkflowsDelegations — Approval delegations (own; admins see all)","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/approval_workflows/delegations","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","approval_workflows","delegations"],"variable":[{"key":"company_id","value":"{{companyId}}"}]},"description":"Approval delegations (own; admins see all)"}},{"id":"d752a237-97bf-47a0-8dfc-f8bd27c9cfc1","name":"createCompanyApprovalWorkflowsDelegation — Delegate approvals while out of office","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/approval_workflows/delegations","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","approval_workflows","delegations"],"variable":[{"key":"company_id","value":"{{companyId}}"}]},"description":"Delegate approvals while out of office","body":{"mode":"raw","raw":"{\n  \"ends_at\": \"2026-01-31T12:00:00Z\",\n  \"from_user_id\": 0,\n  \"object_types\": [\n    \"change_order\"\n  ],\n  \"reason\": \"\",\n  \"starts_at\": \"2026-01-31T12:00:00Z\",\n  \"to_user_id\": 0\n}","options":{"raw":{"language":"json"}}}}},{"id":"328ffb39-d864-4229-8bd2-f8de1f51489a","name":"deleteCompanyApprovalWorkflowsDelegation — Revoke a delegation","request":{"method":"DELETE","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/approval_workflows/delegations/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","approval_workflows","delegations",":id"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Revoke a delegation"}},{"id":"342bfe4f-52a9-4fe1-8356-41e63ab881d7","name":"listCompanyApprovalWorkflowsObjectTypes — Record types covered and their mandatory domain controls","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/approval_workflows/object_types","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","approval_workflows","object_types"],"variable":[{"key":"company_id","value":"{{companyId}}"}]},"description":"Record types covered and their mandatory domain controls"}},{"id":"da82971f-3efc-41ad-88dc-d47a235bfe61","name":"listCompanyApprovalWorkflowsPolicies — List approval policies","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/approval_workflows/policies","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","approval_workflows","policies"],"query":[{"key":"object_type","value":"","disabled":true},{"key":"project_id","value":"","disabled":true,"description":"A project id, or `company` for company-wide policies only"}],"variable":[{"key":"company_id","value":"{{companyId}}"}]},"description":"List approval policies"}},{"id":"dd6d867f-b5a1-4287-88a5-d11dd75036a3","name":"createCompanyApprovalWorkflowsPolicy — Create an approval policy (company admins)","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/approval_workflows/policies","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","approval_workflows","policies"],"variable":[{"key":"company_id","value":"{{companyId}}"}]},"description":"Create an approval policy (company admins)","body":{"mode":"raw","raw":"{\n  \"approval_policy\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"a0f8d2aa-5644-412f-8454-44db18d3d906","name":"getCompanyApprovalWorkflowsPolicy — Show an approval policy","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/approval_workflows/policies/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","approval_workflows","policies",":id"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Show an approval policy"}},{"id":"bc83be7c-24ae-4e1f-8ec1-d3540ab4f94d","name":"updateCompanyApprovalWorkflowsPolicy — Update an approval policy (bumps version; runs in flight keep their plan)","request":{"method":"PATCH","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/approval_workflows/policies/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","approval_workflows","policies",":id"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Update an approval policy (bumps version; runs in flight keep their plan)","body":{"mode":"raw","raw":"{\n  \"approval_policy\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"cc7b0c0b-91ed-4b7c-8055-0a1fe4d3d98c","name":"deleteCompanyApprovalWorkflowsPolicy — Delete an approval policy","request":{"method":"DELETE","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/approval_workflows/policies/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","approval_workflows","policies",":id"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Delete an approval policy"}},{"id":"2f22e13d-920c-4b37-8b96-5901ed9334d2","name":"listCompanyApprovalWorkflowsPolicyTemplates — Starter policies","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/approval_workflows/policy_templates","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","approval_workflows","policy_templates"],"variable":[{"key":"company_id","value":"{{companyId}}"}]},"description":"Starter policies"}},{"id":"f6004f2b-0669-4a82-894d-6a060a9cf79a","name":"applyCompanyApprovalWorkflowsPolicyTemplate — Create a policy from a template (inactive unless activate)","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/approval_workflows/policy_templates/:key/apply","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","approval_workflows","policy_templates",":key","apply"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"key","value":""}]},"description":"Create a policy from a template (inactive unless activate)","body":{"mode":"raw","raw":"{\n  \"activate\": false,\n  \"project_id\": 0\n}","options":{"raw":{"language":"json"}}}}},{"id":"b702484b-7f2e-485a-8f0b-7699ecef3229","name":"listCompanyApprovalWorkflowsRecordStatus — A record's runs and whether its domain decision may proceed","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/approval_workflows/record_status","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","approval_workflows","record_status"],"query":[{"key":"object_type","value":"","disabled":false},{"key":"object_id","value":"","disabled":false}],"variable":[{"key":"company_id","value":"{{companyId}}"}]},"description":"A record's runs and whether its domain decision may proceed"}},{"id":"13f4d3e0-b09e-45ac-8943-ce338d733d8d","name":"createCompanyApprovalWorkflowsSimulate — Who would approve this record? (read-only)","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/approval_workflows/simulate","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","approval_workflows","simulate"],"variable":[{"key":"company_id","value":"{{companyId}}"}]},"description":"Who would approve this record? (read-only)","body":{"mode":"raw","raw":"{\n  \"facts\": {},\n  \"object_id\": 0,\n  \"object_type\": \"change_order\",\n  \"policy\": {}\n}","options":{"raw":{"language":"json"}}}}}]},{"name":"Automations","description":"Module: automations","item":[{"id":"a4a73ad8-9c2a-4fd6-8efa-a385ce895700","name":"listCompanyAutomations — List automations","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/automations","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","automations"],"query":[{"key":"filters[project_id]","value":"","disabled":true,"description":"Rules of one project"},{"key":"filters[include_company]","value":"","disabled":true,"description":"With filters[project_id]: also company-wide rules"},{"key":"filters[enabled]","value":"","disabled":true,"description":"true or false"},{"key":"search","value":"","disabled":true,"description":"Name contains"},{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true}],"variable":[{"key":"company_id","value":"{{companyId}}"}]},"description":"List automations"}},{"id":"7489926d-3eac-447e-84b7-b3fa8bf2f722","name":"createCompanyAutomation — Create an automation","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/automations","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","automations"],"variable":[{"key":"company_id","value":"{{companyId}}"}]},"description":"Create an automation","body":{"mode":"raw","raw":"{\n  \"automation\": {\n    \"actions\": [\n      {\n        \"channels\": [\n          \"in_app\"\n        ],\n        \"recipients\": {},\n        \"subject\": \"\",\n        \"type\": \"notify\"\n      }\n    ],\n    \"name\": \"\",\n    \"trigger\": {\n      \"kind\": \"event\"\n    }\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"4975b029-4389-45b1-8743-fd42fc9fee30","name":"listCompanyAutomationsCatalog — Automation builder catalog","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/automations/catalog","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","automations","catalog"],"query":[{"key":"project_id","value":"","disabled":true,"description":"Include this project's distribution groups"}],"variable":[{"key":"company_id","value":"{{companyId}}"}]},"description":"Automation builder catalog\n\nTriggers, the fields each trigger exposes (trigger_fields keyed event:<type>, scan:<source> or schedule), operators, actions with availability, templates and pickers."}},{"id":"31a04637-3cec-4484-89b2-d8ed7f67e775","name":"listCompanyAutomationsRuns — List automation runs","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/automations/runs","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","automations","runs"],"query":[{"key":"filters[status]","value":"","disabled":true,"description":"queued, running, succeeded, partial, failed, skipped or dry_run"},{"key":"filters[project_id]","value":"","disabled":true,"description":"Runs for one project"},{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true}],"variable":[{"key":"company_id","value":"{{companyId}}"}]},"description":"List automation runs"}},{"id":"272c0fce-f6e3-4419-8592-bf7fbc727dec","name":"getCompanyAutomationsRun — Show an automation run","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/automations/runs/:run_id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","automations","runs",":run_id"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"run_id","value":""}]},"description":"Show an automation run"}},{"id":"5a92048a-3c35-43b9-8cf3-22e78201758d","name":"getCompanyAutomation — Show an automation","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/automations/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","automations",":id"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Show an automation"}},{"id":"ef777213-47e1-4c27-873a-fd693b691602","name":"updateCompanyAutomation — Update an automation","request":{"method":"PATCH","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/automations/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","automations",":id"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Update an automation\n\nPartial update. Saving makes the caller the owner; a changed definition creates a new version.","body":{"mode":"raw","raw":"{\n  \"automation\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"b987a4dc-90d2-4dd1-88da-f1e724b75c00","name":"deleteCompanyAutomation — Delete an automation","request":{"method":"DELETE","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/automations/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","automations",":id"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Delete an automation"}},{"id":"a5ccd45a-be04-4a67-8542-86f6b9c521a7","name":"listCompanyAutomationRuns — List an automation's runs","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/automations/:id/runs","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","automations",":id","runs"],"query":[{"key":"filters[status]","value":"","disabled":true,"description":"Run status"},{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true}],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"List an automation's runs"}},{"id":"b560d704-82f1-4548-88c1-96fc733d5f4a","name":"testCompanyAutomation — Dry-run an automation with a sample","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/automations/:id/test","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","automations",":id","test"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Dry-run an automation with a sample\n\nEvaluates the conditions and previews each action without side effects. Without a sample, uses the latest matching event (event rules) or the first record the schedule would pick today.","body":{"mode":"raw","raw":"{\n  \"test\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"a6fd34c6-5372-42c8-824c-e7d47b868204","name":"listCompanyAutomationVersions — List an automation's versions","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/automations/:id/versions","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","automations",":id","versions"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"List an automation's versions"}}]},{"name":"Bidding","description":"Module: bidding","item":[{"id":"8a5576c7-2274-4726-8231-103052afd9fe","name":"getBiddingRecipient — Get recipient","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/bidding/recipient/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","bidding","recipient",":id"],"variable":[{"key":"id","value":""}]},"description":"Get recipient\n\nA scoped API token needs `bidding:read`.","body":{"mode":"raw","raw":"{\n  \"action\": \"submit\",\n  \"bid\": {},\n  \"request_key\": \"\"\n}","options":{"raw":{"language":"json"}}}}},{"id":"d2a42836-166f-469a-8e2f-5613207f6fb9","name":"updateBiddingRecipient — Submit or decline a bid through a scoped invitation","request":{"method":"PATCH","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/bidding/recipient/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","bidding","recipient",":id"],"variable":[{"key":"id","value":""}]},"description":"Submit or decline a bid through a scoped invitation","body":{"mode":"raw","raw":"{\n  \"action\": \"submit\",\n  \"bid\": {},\n  \"request_key\": \"\"\n}","options":{"raw":{"language":"json"}}}}},{"id":"f1555f51-5ac8-412d-808d-3726f246d74e","name":"listBiddingRecipientAddendumAcknowledgments — Show current reviewed addendum and this recipient's retained acknowledgment history","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/bidding/recipient/:id/addendum_acknowledgments","host":["{{baseUrl}}"],"path":["rest","v1.0","bidding","recipient",":id","addendum_acknowledgments"],"query":[{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true}],"variable":[{"key":"id","value":""}]},"description":"Show current reviewed addendum and this recipient's retained acknowledgment history"}},{"id":"cecc6b51-42f1-4341-8ace-004d6c8b1f3f","name":"createBiddingRecipientAddendumAcknowledgment — Acknowledge the exact current reviewed addendum before submitting a quote","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/bidding/recipient/:id/addendum_acknowledgments","host":["{{baseUrl}}"],"path":["rest","v1.0","bidding","recipient",":id","addendum_acknowledgments"],"variable":[{"key":"id","value":""}]},"description":"Acknowledge the exact current reviewed addendum before submitting a quote","body":{"mode":"raw","raw":"{\n  \"release_sha256\": \"\",\n  \"release_version_id\": 0,\n  \"request_key\": \"\"\n}","options":{"raw":{"language":"json"}}}}},{"id":"874876b3-b7a5-419f-8556-be304edfbb41","name":"listBiddingRecipientSubmissionReceipts — List only this authenticated invitation's immutable quote revisions","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/bidding/recipient/:id/submission_receipts","host":["{{baseUrl}}"],"path":["rest","v1.0","bidding","recipient",":id","submission_receipts"],"query":[{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true}],"variable":[{"key":"id","value":""}]},"description":"List only this authenticated invitation's immutable quote revisions"}},{"id":"3a35c99f-4e14-46c4-81b3-0aa17727cba2","name":"listProjectBidPackages — List project bid packages","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/bid_packages","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","bid_packages"],"query":[{"key":"page","value":"1","disabled":true,"description":"Page number."},{"key":"per_page","value":"100","disabled":true,"description":"Number of records per page."},{"key":"filters[status]","value":"","disabled":true,"description":"Repeat for multiple statuses. The closed filter also includes awarded packages."},{"key":"filters[query]","value":"","disabled":true,"description":"Case-insensitive text match against title or package number. Overrides other search parameters."},{"key":"search","value":"","disabled":true,"description":"Case-insensitive title or package number search."},{"key":"filter","value":"","disabled":true,"description":"Legacy alias for search. Used when search is omitted."}],"variable":[{"key":"project_id","value":"{{projectId}}","description":"Project ID in the authenticated company."}]},"description":"List project bid packages\n\nRequires bidding:read and staff permission to view the project's Bidding tool. Returns active packages and their bidding metrics in ascending ID order."}},{"id":"a935bc2a-ac00-446e-8639-d5539132b7f2","name":"createProjectBidPackage — Create Bid Package","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/bid_packages","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","bid_packages"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Create Bid Package","body":{"mode":"raw","raw":"{\n  \"bid_package\": {\n    \"bid_due_date\": \"2026-01-31T12:00:00Z\",\n    \"bid_email_message\": \"\",\n    \"bid_web_message\": \"\",\n    \"title\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"34e0f8fc-3b22-4cf9-8e20-e8ab1eba4e4d","name":"listProjectBidPackagesFilterOptionsStatus — List project bid package status filter options","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/bid_packages/filter_options/status","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","bid_packages","filter_options","status"],"variable":[{"key":"project_id","value":"{{projectId}}","description":"Project ID in the authenticated company."}]},"description":"List project bid package status filter options\n\nRequires bidding:read and staff permission to view the project's Bidding tool. Returns Open and Closed plus statuses present on active packages in the project."}},{"id":"36a5b1c1-357b-4332-8041-e873d73d3a82","name":"listProjectBidPackagesRecycleBin — List recycled project bid packages","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/bid_packages/recycle_bin","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","bid_packages","recycle_bin"],"query":[{"key":"page","value":"1","disabled":true,"description":"Page number."},{"key":"per_page","value":"100","disabled":true,"description":"Number of records per page."},{"key":"filters[status]","value":"","disabled":true,"description":"Repeat for multiple statuses. The closed filter also includes awarded packages."},{"key":"filters[query]","value":"","disabled":true,"description":"Case-insensitive text match against title or package number. Overrides other search parameters."}],"variable":[{"key":"project_id","value":"{{projectId}}","description":"Project ID in the authenticated company."}]},"description":"List recycled project bid packages\n\nRequires bidding:read and staff permission to view the project's Bidding tool. Returns soft-deleted packages in ascending ID order."}},{"id":"e1943a70-97cf-4c29-89b7-689c4ac1f988","name":"listProjectBidPackageAddendumAcknowledgments — List retained bidder acknowledgments of reviewed package addenda; staff only","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/bid_packages/:bid_package_id/addendum_acknowledgments","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","bid_packages",":bid_package_id","addendum_acknowledgments"],"query":[{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"bid_package_id","value":""}]},"description":"List retained bidder acknowledgments of reviewed package addenda; staff only"}},{"id":"343bda67-685b-4920-8b7c-d30fefba9d00","name":"awardProjectBidPackage — Award a submitted, reconciled bid","request":{"method":"PATCH","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/bid_packages/:bid_package_id/award","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","bid_packages",":bid_package_id","award"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"bid_package_id","value":""}]},"description":"Award a submitted, reconciled bid","body":{"mode":"raw","raw":"{\n  \"bid_id\": 0\n}","options":{"raw":{"language":"json"}}}}},{"id":"54d28c87-f66a-487e-8854-56dde71005c7","name":"listProjectBidPackageAwardRecommendations — List retained staff award recommendations and independently approved current decision","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/bid_packages/:bid_package_id/award_recommendations","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","bid_packages",":bid_package_id","award_recommendations"],"query":[{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"bid_package_id","value":""}]},"description":"List retained staff award recommendations and independently approved current decision"}},{"id":"e0ea2201-f810-4390-8399-164e547c4ae5","name":"createProjectBidPackageAwardRecommendation — Propose a reasoned selection against an exact fresh quote comparison","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/bid_packages/:bid_package_id/award_recommendations","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","bid_packages",":bid_package_id","award_recommendations"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"bid_package_id","value":""}]},"description":"Propose a reasoned selection against an exact fresh quote comparison","body":{"mode":"raw","raw":"{\n  \"bid_id\": 0,\n  \"reason\": \"\",\n  \"request_key\": \"\",\n  \"source_sha256\": \"\"\n}","options":{"raw":{"language":"json"}}}}},{"id":"2e18aa75-1aaa-4610-8b87-71b71daf6068","name":"createProjectBidPackageAwardRecommendationsPreview — Preview exact current frozen quotes for a staff award recommendation","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/bid_packages/:bid_package_id/award_recommendations/preview","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","bid_packages",":bid_package_id","award_recommendations","preview"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"bid_package_id","value":""}]},"description":"Preview exact current frozen quotes for a staff award recommendation","body":{"mode":"raw","raw":"{\n  \"bid_id\": 0\n}","options":{"raw":{"language":"json"}}}}},{"id":"903f30b1-c92f-4730-89ad-8342595fe493","name":"approveProjectBidPackageAwardRecommendation — Independently approve the exact current recommendation; Bidding administrator only","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/bid_packages/:bid_package_id/award_recommendations/:recommendation_id/approve","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","bid_packages",":bid_package_id","award_recommendations",":recommendation_id","approve"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"bid_package_id","value":""},{"key":"recommendation_id","value":""}]},"description":"Independently approve the exact current recommendation; Bidding administrator only","body":{"mode":"raw","raw":"{\n  \"reason\": \"\",\n  \"request_key\": \"\",\n  \"source_sha256\": \"\"\n}","options":{"raw":{"language":"json"}}}}},{"id":"75c9a8a0-65f1-4af5-899b-38914b4605b6","name":"listProjectBidPackageBidForms — List bid forms on a project bid package","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/bid_packages/:bid_package_id/bid_forms","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","bid_packages",":bid_package_id","bid_forms"],"query":[{"key":"page","value":"1","disabled":true,"description":"Page number."},{"key":"per_page","value":"100","disabled":true,"description":"Number of records per page."}],"variable":[{"key":"project_id","value":"{{projectId}}","description":"Project ID in the authenticated company."},{"key":"bid_package_id","value":"","description":"Bid package ID in the project."}]},"description":"List bid forms on a project bid package\n\nRequires bidding:read and staff permission to view the project's Bidding tool. Returns forms and their line items in position order."}},{"id":"80ad99df-2713-445f-8b6f-962114c62053","name":"createProjectBidPackageBidForm — Create a bid form on a project bid package","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/bid_packages/:bid_package_id/bid_forms","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","bid_packages",":bid_package_id","bid_forms"],"variable":[{"key":"project_id","value":"{{projectId}}","description":"Project ID in the authenticated company."},{"key":"bid_package_id","value":"","description":"Bid package ID in the project."}]},"description":"Create a bid form on a project bid package\n\nRequires bidding:write and staff permission to create in the project's Bidding tool. Forms in packages requiring a reviewed release can be changed in draft. Creating a form increments the vendor revision for those packages. Forms are locked after award conversion unless the conversion is reversed.","body":{"mode":"raw","raw":"{\n  \"bid_form\": {\n    \"title\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"e24a216c-40da-4575-8935-1e3d400d4b7d","name":"listProjectBidPackageBidFormBidLeveling — Bid leveling across a bid form","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/bid_packages/:bid_package_id/bid_forms/:bid_form_id/bid_leveling","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","bid_packages",":bid_package_id","bid_forms",":bid_form_id","bid_leveling"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"bid_package_id","value":""},{"key":"bid_form_id","value":""}]},"description":"Bid leveling across a bid form"}},{"id":"78083322-7c1a-4fcd-87eb-d0f83de9c078","name":"listProjectBidPackageBids — List Bids within a Bid Package","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/bid_packages/:bid_package_id/bids","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","bid_packages",":bid_package_id","bids"],"query":[{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"bid_package_id","value":""}]},"description":"List Bids within a Bid Package"}},{"id":"fc8b8803-a8ad-4cd3-894b-7936894f69b4","name":"createProjectBidPackageBid — Invite vendors to a bid package","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/bid_packages/:bid_package_id/bids","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","bid_packages",":bid_package_id","bids"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"bid_package_id","value":""}]},"description":"Invite vendors to a bid package"}},{"id":"87b9b549-28c1-4be7-82e3-8e37eaf5553b","name":"getProjectBidPackageBid — Show Bids within a Bid package","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/bid_packages/:bid_package_id/bids/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","bid_packages",":bid_package_id","bids",":id"],"variable":[{"key":"id","value":""},{"key":"project_id","value":"{{projectId}}"},{"key":"bid_package_id","value":""}]},"description":"Show Bids within a Bid package"}},{"id":"320a5bed-488c-4fcb-82f2-b7243feaf819","name":"updateProjectBidPackageBid — Update a Bid from a Bid Package","request":{"method":"PATCH","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/bid_packages/:bid_package_id/bids/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","bid_packages",":bid_package_id","bids",":id"],"variable":[{"key":"id","value":""},{"key":"project_id","value":"{{projectId}}"},{"key":"bid_package_id","value":""}]},"description":"Update a Bid from a Bid Package","body":{"mode":"raw","raw":"{\n  \"bid\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"f90c900f-1ba3-40fe-86f9-942a41da194a","name":"listProjectBidPackageBidBuyoutPlan — Read the immutable approved vendor buyout plan","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/bid_packages/:bid_package_id/bids/:id/buyout_plan","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","bid_packages",":bid_package_id","bids",":id","buyout_plan"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"bid_package_id","value":""},{"key":"id","value":""}]},"description":"Read the immutable approved vendor buyout plan"}},{"id":"cfda5704-b733-481e-88cb-b25b56cb5a15","name":"buyoutPlanProjectBidPackageBid — Approve an immutable vendor buyout plan after preview review","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/bid_packages/:bid_package_id/bids/:id/buyout_plan","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","bid_packages",":bid_package_id","bids",":id","buyout_plan"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"bid_package_id","value":""},{"key":"id","value":""}]},"description":"Approve an immutable vendor buyout plan after preview review","body":{"mode":"raw","raw":"{\n  \"allocations\": [\n    {\n      \"amount\": \"\",\n      \"cost_code_id\": 0\n    }\n  ],\n  \"request_key\": \"\",\n  \"review_token\": \"\",\n  \"snapshot_id\": 0\n}","options":{"raw":{"language":"json"}}}}},{"id":"026f18f4-d0a0-4cb6-8390-86469a2768d0","name":"createProjectBidPackageBidBuyoutPlanPreview — Preview private vendor buyout allocations against a captured Budget snapshot","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/bid_packages/:bid_package_id/bids/:id/buyout_plan/preview","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","bid_packages",":bid_package_id","bids",":id","buyout_plan","preview"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"bid_package_id","value":""},{"key":"id","value":""}]},"description":"Preview private vendor buyout allocations against a captured Budget snapshot","body":{"mode":"raw","raw":"{\n  \"allocations\": [\n    {\n      \"amount\": \"\",\n      \"cost_code_id\": 0\n    }\n  ],\n  \"snapshot_id\": 0\n}","options":{"raw":{"language":"json"}}}}},{"id":"cfa61a99-28f8-4165-8aa2-2d7ca7b43644","name":"listProjectBidPackageBidCommitmentReceipt — Read the private immutable award to commitment source receipt","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/bid_packages/:bid_package_id/bids/:id/commitment_receipt","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","bid_packages",":bid_package_id","bids",":id","commitment_receipt"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"bid_package_id","value":""},{"key":"id","value":""}]},"description":"Read the private immutable award to commitment source receipt"}},{"id":"38f3cf17-4f5a-4dfd-8432-b8bf631a7f05","name":"listProjectBidPackageBidSubmissionReceipts — List immutable quote revisions for one bidder; staff only","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/bid_packages/:bid_package_id/bids/:id/submission_receipts","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","bid_packages",":bid_package_id","bids",":id","submission_receipts"],"query":[{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"bid_package_id","value":""},{"key":"id","value":""}]},"description":"List immutable quote revisions for one bidder; staff only"}},{"id":"4f793c3d-72fb-4cbc-8d0e-873835223ad9","name":"createCommitmentProjectBidPackage — Create or recover a private draft commitment from the award","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/bid_packages/:bid_package_id/create_commitment","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","bid_packages",":bid_package_id","create_commitment"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"bid_package_id","value":""}]},"description":"Create or recover a private draft commitment from the award","body":{"mode":"raw","raw":"{\n  \"bid_id\": 0,\n  \"commitment_type\": \"WorkOrderContract\",\n  \"fallback_cost_code_id\": 0\n}","options":{"raw":{"language":"json"}}}}},{"id":"2212e26c-b291-4870-8b59-47891f3504a9","name":"listProjectBidPackageInvitations — List bid invitation records","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/bid_packages/:bid_package_id/invitations","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","bid_packages",":bid_package_id","invitations"],"query":[{"key":"page","value":"1","disabled":true,"description":"Page number."},{"key":"per_page","value":"100","disabled":true,"description":"Number of records per page."}],"variable":[{"key":"project_id","value":"{{projectId}}","description":"Project ID in the authenticated company."},{"key":"bid_package_id","value":"","description":"Bid package ID in the project."}]},"description":"List bid invitation records\n\nRequires bidding:read and staff permission to edit in the project's Bidding tool. Returns a page of invitation records for active bids in descending invitation ID order."}},{"id":"d536b6bd-1d60-437f-8634-300f7a495d00","name":"createProjectBidPackageInvitation — Record a bid invitation locally","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/bid_packages/:bid_package_id/invitations","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","bid_packages",":bid_package_id","invitations"],"variable":[{"key":"project_id","value":"{{projectId}}","description":"Project ID in the authenticated company."},{"key":"bid_package_id","value":"","description":"Bid package ID in the project."}]},"description":"Record a bid invitation locally\n\nRequires bidding:write and staff permission to edit in the project's Bidding tool. Choose a named, active project contact employed by the active bidder and an expiry within 30 days. The package must be open and any required release must be current. Creates an invitation, records the local outbox and may change the bid status to undecided. The outbox records a local handoff. Staff can copy the recipient link in the Bidding interface. Email delivery is unavailable. The same bid, request key, recipient, expiry and release return the existing invitation.","body":{"mode":"raw","raw":"{\n  \"invitation\": {\n    \"bid_id\": 0,\n    \"expires_at\": \"2026-01-31T12:00:00Z\",\n    \"recipient_user_id\": 0,\n    \"request_key\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"e16bbe89-d8cd-4971-8f7d-883aa1af878f","name":"deleteProjectBidPackageInvitation — Revoke a bid invitation","request":{"method":"DELETE","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/bid_packages/:bid_package_id/invitations/:invitation_id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","bid_packages",":bid_package_id","invitations",":invitation_id"],"variable":[{"key":"project_id","value":"{{projectId}}","description":"Project ID in the authenticated company."},{"key":"bid_package_id","value":"","description":"Bid package ID in the project."},{"key":"invitation_id","value":"","description":"Invitation ID on a bid in the package."}]},"description":"Revoke a bid invitation\n\nRequires bidding:write and staff permission to edit in the project's Bidding tool. Revokes the invitation so that its link can no longer be used. The invitation record remains available and revoking it again has the same outcome."}},{"id":"f0c24df4-a4dc-43e8-89d9-461f93e64898","name":"recycleProjectBidPackage — Move a bid package to the recycle bin","request":{"method":"PATCH","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/bid_packages/:bid_package_id/recycle","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","bid_packages",":bid_package_id","recycle"],"variable":[{"key":"project_id","value":"{{projectId}}","description":"Project ID in the authenticated company."},{"key":"bid_package_id","value":"","description":"Bid package ID in the project."}]},"description":"Move a bid package to the recycle bin\n\nRequires bidding:write and administrative staff permission to delete in the project's Bidding tool. Soft-deletes the active package."}},{"id":"7e46c67c-8392-4194-8f7c-aeac621edea8","name":"deleteRecycleProjectBidPackage — Move a bid package to the recycle bin","request":{"method":"DELETE","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/bid_packages/:bid_package_id/recycle","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","bid_packages",":bid_package_id","recycle"],"variable":[{"key":"project_id","value":"{{projectId}}","description":"Project ID in the authenticated company."},{"key":"bid_package_id","value":"","description":"Bid package ID in the project."}]},"description":"Move a bid package to the recycle bin\n\nRequires bidding:write and administrative staff permission to delete in the project's Bidding tool. Soft-deletes the active package."}},{"id":"6a50aed7-dfe5-4029-8ea4-0747440f7f4c","name":"listProjectBidPackageRelease — Read the current vendor package release and paginated immutable release history","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/bid_packages/:bid_package_id/release","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","bid_packages",":bid_package_id","release"],"query":[{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"bid_package_id","value":""}]},"description":"Read the current vendor package release and paginated immutable release history"}},{"id":"b2bf5046-e976-4d8f-8e35-b3447bf7cba7","name":"releaseProjectBidPackage — Approve a vendor-visible bid package release from an exact short-lived review","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/bid_packages/:bid_package_id/release","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","bid_packages",":bid_package_id","release"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"bid_package_id","value":""}]},"description":"Approve a vendor-visible bid package release from an exact short-lived review","body":{"mode":"raw","raw":"{\n  \"reason\": \"\",\n  \"request_key\": \"\",\n  \"review_token\": \"\"\n}","options":{"raw":{"language":"json"}}}}},{"id":"d3e194b4-ec3a-4970-84bb-844a8f95ae49","name":"listProjectBidPackageReleaseAttachments — List classified attachment evidence for one vendor package, including retained withdrawals","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/bid_packages/:bid_package_id/release/attachments","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","bid_packages",":bid_package_id","release","attachments"],"query":[{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"bid_package_id","value":""}]},"description":"List classified attachment evidence for one vendor package, including retained withdrawals"}},{"id":"07ed0498-ba9c-4d1b-81c1-7cb327e26b91","name":"createProjectBidPackageReleaseAttachment — Classify a verified private upload for a draft vendor package","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/bid_packages/:bid_package_id/release/attachments","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","bid_packages",":bid_package_id","release","attachments"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"bid_package_id","value":""}]},"description":"Classify a verified private upload for a draft vendor package","body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}}}},{"id":"ac3fd05a-1628-4704-817d-b044050cbca2","name":"deleteProjectBidPackageReleaseAttachment — Withdraw a classified attachment from future vendor releases while retaining evidence","request":{"method":"DELETE","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/bid_packages/:bid_package_id/release/attachments/:attachment_id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","bid_packages",":bid_package_id","release","attachments",":attachment_id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"bid_package_id","value":""},{"key":"attachment_id","value":""}]},"description":"Withdraw a classified attachment from future vendor releases while retaining evidence","body":{"mode":"raw","raw":"{\n  \"reason\": \"\"\n}","options":{"raw":{"language":"json"}}}}},{"id":"722aa56a-9bb2-48a7-84de-a5ec82f6e691","name":"listProjectBidPackageReleaseAttachmentDownload — Inspect exact classified attachment bytes before approving a vendor release","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/bid_packages/:bid_package_id/release/attachments/:attachment_id/download","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","bid_packages",":bid_package_id","release","attachments",":attachment_id","download"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"bid_package_id","value":""},{"key":"attachment_id","value":""}]},"description":"Inspect exact classified attachment bytes before approving a vendor release"}},{"id":"4d909cd5-9373-4e82-8526-03e6bf2ce2d5","name":"createProjectBidPackageReleasePreview — Preview the exact vendor-visible bid package before a reviewed release","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/bid_packages/:bid_package_id/release/preview","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","bid_packages",":bid_package_id","release","preview"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"bid_package_id","value":""}]},"description":"Preview the exact vendor-visible bid package before a reviewed release"}},{"id":"db6bbe52-0503-449e-8f2c-38869043f7a8","name":"getProjectBidPackage — Show Bid Package","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/bid_packages/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","bid_packages",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Show Bid Package"}},{"id":"270852b4-6b95-4d03-81bc-6b2ed2c11744","name":"updateProjectBidPackage — Update Bid Package","request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/bid_packages/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","bid_packages",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Update Bid Package","body":{"mode":"raw","raw":"{\n  \"bid_package\": {\n    \"bid_due_date\": \"2026-01-31T12:00:00Z\",\n    \"bid_email_message\": \"\",\n    \"bid_web_message\": \"\",\n    \"title\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"db18f83a-4d1a-4d0a-86f7-9c5c5a5f96fd","name":"listProjectBidPackagesV11 — List Bid Packages","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.1/projects/:project_id/bid_packages","host":["{{baseUrl}}"],"path":["rest","v1.1","projects",":project_id","bid_packages"],"query":[{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true},{"key":"view","value":"","disabled":true},{"key":"filter","value":"","disabled":true},{"key":"with_flags","value":"","disabled":true},{"key":"sort","value":"","disabled":true},{"key":"filters[bid_due_date]","value":"","disabled":true},{"key":"filters[status]","value":"","disabled":true},{"key":"filters[created_at]","value":"","disabled":true},{"key":"filters[has_bid_forms]","value":"","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"List Bid Packages"}}]},{"name":"Budget","description":"Module: budget","item":[{"id":"7cd6f4fc-fcf8-4d1d-886b-4e9aba221e71","name":"createBudgetLineItem — Create Budget Line Item","request":{"method":"POST","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/budget_line_items","host":["{{baseUrl}}"],"path":["rest","v1.0","budget_line_items"]},"description":"Create Budget Line Item","body":{"mode":"raw","raw":"{\n  \"budget_line_item\": {\n    \"cost_code_id\": 0,\n    \"line_item_type_id\": 0\n  },\n  \"project_id\": 0\n}","options":{"raw":{"language":"json"}}}}},{"id":"f85b1639-9028-4e13-84f2-53dd79d98790","name":"createBudgetLineItemsBulkCreate — Bulk create budget line items","request":{"method":"POST","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/budget_line_items/bulk_create","host":["{{baseUrl}}"],"path":["rest","v1.0","budget_line_items","bulk_create"]},"description":"Bulk create budget line items\n\nCreate up to 100 budget line items in one project. Each item is the `budget_line_item` body of POST /budget_line_items and runs through the same checks. Items run in order; a failing item does not roll back the others. Successful items have status 201. With Idempotency-Key, a retried batch replays the first response; retry only the failed items with a new key.","body":{"mode":"raw","raw":"{\n  \"budget_line_items\": [\n    {\n      \"cost_code_id\": 0,\n      \"line_item_type_id\": 0\n    }\n  ],\n  \"project_id\": 0\n}","options":{"raw":{"language":"json"}}}}},{"id":"44633830-fd22-4f37-8588-04e6b625b5df","name":"updateBudgetLineItemsBulkUpdate — Bulk update budget line items","request":{"method":"PATCH","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/budget_line_items/bulk_update","host":["{{baseUrl}}"],"path":["rest","v1.0","budget_line_items","bulk_update"]},"description":"Bulk update budget line items\n\nUpdate up to 100 budget line items. Each item carries the record `id` and the fields to change, and runs through the same checks as PATCH /budget_line_items/{id}. Items run in order; a failing item does not roll back the others. With Idempotency-Key, a retried batch replays the first response; retry only the failed items with a new key.","body":{"mode":"raw","raw":"{\n  \"budget_line_items\": [\n    {\n      \"id\": 0\n    }\n  ],\n  \"project_id\": 0\n}","options":{"raw":{"language":"json"}}}}},{"id":"9e2174b0-53fb-4124-8026-8674fe948eb5","name":"getBudgetLineItem — Show Budget Line Item","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/budget_line_items/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","budget_line_items",":id"],"query":[{"key":"project_id","value":"","disabled":false}],"variable":[{"key":"id","value":""}]},"description":"Show Budget Line Item"}},{"id":"527057d3-b8e6-4c73-882c-47649516e931","name":"updateBudgetLineItem — Update Budget Line Item","request":{"method":"PATCH","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/budget_line_items/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","budget_line_items",":id"],"variable":[{"key":"id","value":""}]},"description":"Update Budget Line Item","body":{"mode":"raw","raw":"{\n  \"budget_line_item\": {},\n  \"project_id\": 0\n}","options":{"raw":{"language":"json"}}}}},{"id":"020d28da-64bc-409f-8a5e-ef58c8d55a93","name":"forecastBudgetLineItem — Set or clear manual forecast","request":{"method":"PATCH","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/budget_line_items/:id/forecast","host":["{{baseUrl}}"],"path":["rest","v1.0","budget_line_items",":id","forecast"],"variable":[{"key":"id","value":""}]},"description":"Set or clear manual forecast\n\nRequires budget:write and current project edit permission. Company is derived from authentication; path, query or body project must be authorized. Project is supplied in the JSON body. Locked original budgets reject forecast edits with 422. Null clears the override.","body":{"mode":"raw","raw":"{\n  \"manual_forecast_to_complete\": null,\n  \"project_id\": 0\n}","options":{"raw":{"language":"json"}}}}},{"id":"bb0b106e-351c-4502-8871-7e556c5f0205","name":"listBudgetViewSnapshots — List Budget View Snapshots","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/budget_view_snapshots","host":["{{baseUrl}}"],"path":["rest","v1.0","budget_view_snapshots"],"query":[{"key":"project_id","value":"","disabled":false}]},"description":"List Budget View Snapshots"}},{"id":"b3a80df6-53f5-4639-82e0-d4a9f6899f5b","name":"createBudgetViewSnapshot — Create Budget View Snapshot","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/budget_view_snapshots","host":["{{baseUrl}}"],"path":["rest","v1.0","budget_view_snapshots"]},"description":"Create Budget View Snapshot","body":{"mode":"raw","raw":"{\n  \"budget_view_id\": 0,\n  \"name\": \"\",\n  \"project_id\": 0\n}","options":{"raw":{"language":"json"}}}}},{"id":"97001c87-c754-4601-8ead-f2ba9598f0d3","name":"getBudgetViewSnapshot — Show Budget View Snapshot","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/budget_view_snapshots/:budget_view_snapshot_id","host":["{{baseUrl}}"],"path":["rest","v1.0","budget_view_snapshots",":budget_view_snapshot_id"],"query":[{"key":"project_id","value":"","disabled":false}],"variable":[{"key":"budget_view_snapshot_id","value":""}]},"description":"Show Budget View Snapshot"}},{"id":"b68e72d9-aed1-4f81-8c55-85d64a7bc19c","name":"listBudgetViewSnapshotCaptured — Read captured budget snapshot evidence","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/budget_view_snapshots/:budget_view_snapshot_id/captured","host":["{{baseUrl}}"],"path":["rest","v1.0","budget_view_snapshots",":budget_view_snapshot_id","captured"],"query":[{"key":"project_id","value":"","disabled":false,"description":"Project whose current budget-view permission is checked; the snapshot must belong to this project."}],"variable":[{"key":"budget_view_snapshot_id","value":""}]},"description":"Read captured budget snapshot evidence\n\nReturns retained labels, stored values and summed totals without querying current cost-code labels or recomputing the budget. Legacy snapshots have null captured labels. This endpoint is not paginated; large snapshots may exceed connector response limits. Use detail_rows for paginated grids."}},{"id":"9f7fac7e-bcba-4fd4-8cc1-94e9315dec58","name":"listBudgetViewSnapshotDetailRows — List captured budget snapshot detail rows","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/budget_view_snapshots/:budget_view_snapshot_id/detail_rows","host":["{{baseUrl}}"],"path":["rest","v1.0","budget_view_snapshots",":budget_view_snapshot_id","detail_rows"],"query":[{"key":"project_id","value":"","disabled":false,"description":"Project whose current budget-view permission is checked; the snapshot must belong to this project."},{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true},{"key":"cost_code_id[]","value":"","disabled":true,"description":"Repeat this query key for multiple values; comma-separated values are also accepted."},{"key":"root_cost_code_id[]","value":"","disabled":true,"description":"Repeat this query key for multiple values; comma-separated values are also accepted."},{"key":"category_id[]","value":"","disabled":true,"description":"Repeat this query key for multiple values; comma-separated values are also accepted."},{"key":"budget_line_item_id[]","value":"","disabled":true,"description":"Repeat this query key for multiple values; comma-separated values are also accepted."},{"key":"budget_row_type","value":"","disabled":true}],"variable":[{"key":"budget_view_snapshot_id","value":""}]},"description":"List captured budget snapshot detail rows\n\nReads stored values and prefers captured labels, with current cost-code/division references as fallback. Filters by ID and budgeted state; name filters are not implemented for snapshot rows. Requires budget:read and current project budget-view permission."}},{"id":"6439be22-dd54-4d88-8343-77bb38029602","name":"listBudgetViewSnapshotExport — Export budget view snapshot","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/budget_view_snapshots/:budget_view_snapshot_id/export","host":["{{baseUrl}}"],"path":["rest","v1.0","budget_view_snapshots",":budget_view_snapshot_id","export"],"query":[{"key":"project_id","value":"","disabled":false}],"variable":[{"key":"budget_view_snapshot_id","value":""}]},"description":"Export budget view snapshot\n\nRequires the `view` permission on the project's budget tool. A scoped API token needs `budget:read`."}},{"id":"f9c10671-1814-4c8b-881f-36e7464a8cea","name":"listBudgetViewSnapshotSummaryRows — List captured budget snapshot summary rows","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/budget_view_snapshots/:budget_view_snapshot_id/summary_rows","host":["{{baseUrl}}"],"path":["rest","v1.0","budget_view_snapshots",":budget_view_snapshot_id","summary_rows"],"query":[{"key":"project_id","value":"","disabled":false,"description":"Project whose current budget-view permission is checked; the snapshot must belong to this project."},{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true},{"key":"group_by","value":"","disabled":true}],"variable":[{"key":"budget_view_snapshot_id","value":""}]},"description":"List captured budget snapshot summary rows\n\nAggregates frozen stored values by group; group labels may use current project/cost-code references. This endpoint accepts group_by and pagination, not detail-row filters. Requires budget:read and current project budget-view permission."}},{"id":"8b46fd97-3a9c-4712-8aa6-441a14468693","name":"listBudgetViewSnapshotVariance — Budget Snapshot Variance Report","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/budget_view_snapshots/:budget_view_snapshot_id/variance","host":["{{baseUrl}}"],"path":["rest","v1.0","budget_view_snapshots",":budget_view_snapshot_id","variance"],"query":[{"key":"project_id","value":"","disabled":false}],"variable":[{"key":"budget_view_snapshot_id","value":""}]},"description":"Budget Snapshot Variance Report"}},{"id":"c0ec50e3-9c4e-4df9-8341-fc62445a6afb","name":"listBudgetViews — List Budget Views","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/budget_views","host":["{{baseUrl}}"],"path":["rest","v1.0","budget_views"],"query":[{"key":"project_id","value":"","disabled":true},{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true},{"key":"sort","value":"","disabled":true}]},"description":"List Budget Views"}},{"id":"5533b277-771e-43c8-860b-9dc2a6fe7ea9","name":"listBudgetViewDetailRows — List live budget detail rows","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/budget_views/:budget_view_id/detail_rows","host":["{{baseUrl}}"],"path":["rest","v1.0","budget_views",":budget_view_id","detail_rows"],"query":[{"key":"project_id","value":"","disabled":false},{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true},{"key":"budget_row_type","value":"","disabled":true},{"key":"cost_code_id[]","value":"","disabled":true},{"key":"root_cost_code_id[]","value":"","disabled":true},{"key":"category_id[]","value":"","disabled":true},{"key":"budget_line_item_id[]","value":"","disabled":true},{"key":"cost_code_name[]","value":"","disabled":true},{"key":"root_cost_code_name[]","value":"","disabled":true}],"variable":[{"key":"budget_view_id","value":""}]},"description":"List live budget detail rows\n\nRequires budget:read and current project view permission. Company is derived from authentication; path, query or body project must be authorized. Total, Per-Page and Link headers paginate the flat array. Filters accept repeated bracketed keys or comma-separated values; names match case-insensitively. Includes synthetic unbudgeted rows when requested."}},{"id":"bef37aac-93f3-49ed-8548-9430aad93ccf","name":"listBudgetViewForecast — Read grouped budget forecast","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/budget_views/:budget_view_id/forecast","host":["{{baseUrl}}"],"path":["rest","v1.0","budget_views",":budget_view_id","forecast"],"query":[{"key":"project_id","value":"","disabled":false}],"variable":[{"key":"budget_view_id","value":""}]},"description":"Read grouped budget forecast\n\nRequires budget:read and current project view permission. Company is derived from authentication; path, query or body project must be authorized. Unpaginated grouped grid using configured view formulas. Large grids may exceed connector response limits. Negative synthetic IDs are strings. Read-only calculation does not persist forecasts."}},{"id":"809eae62-850b-4342-8d87-1f19a5dc82a3","name":"listBudgetViewSummaryRows — List Budget View Summary Rows","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/budget_views/:budget_view_id/summary_rows","host":["{{baseUrl}}"],"path":["rest","v1.0","budget_views",":budget_view_id","summary_rows"],"query":[{"key":"project_id","value":"","disabled":false},{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true},{"key":"biller[]","value":"","disabled":true},{"key":"cost_code_id[]","value":"","disabled":true},{"key":"cost_code_name[]","value":"","disabled":true},{"key":"root_cost_code_id[]","value":"","disabled":true},{"key":"root_cost_code_name[]","value":"","disabled":true},{"key":"category_id[]","value":"","disabled":true},{"key":"budget_line_item_id[]","value":"","disabled":true},{"key":"group_by","value":"","disabled":true},{"key":"budget_row_type","value":"","disabled":true}],"variable":[{"key":"budget_view_id","value":""}]},"description":"List Budget View Summary Rows"}},{"id":"238b06e2-ab84-4aab-814e-77d171dc696b","name":"listChangeEventPostingHistory — Read change-event budget posting journal","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/change_events/:id/posting_history","host":["{{baseUrl}}"],"path":["rest","v1.0","change_events",":id","posting_history"],"query":[{"key":"project_id","value":"","disabled":false},{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true}],"variable":[{"key":"id","value":""}]},"description":"Read change-event budget posting journal\n\nRequires change_events:read and current project view permission. Company is derived from authentication; path, query or body project must be authorized. Append-only posting evidence with current projection and legacy-baseline indicator; newest revision first. Cache-Control no-store and pagination headers. The handler default is 100; per_page above 100 fails 422 in the service. Uses change_events permission, not budget permission. Advisory locking protects a consistent read and does not create journal entries."}},{"id":"f05eaf9f-970e-4195-88c5-2b0cf14bd79f","name":"restoreChangeEvent — Restore change event","request":{"method":"PATCH","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/change_events/:id/restore","host":["{{baseUrl}}"],"path":["rest","v1.0","change_events",":id","restore"],"variable":[{"key":"id","value":""}]},"description":"Restore change event\n\nRestore a recycled Change Event. Returns 200 show."}},{"id":"0c0fc911-6647-46dd-85c8-4f6e039f1d02","name":"listProjectBudgetLock — Read original budget lock","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/budget/lock","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","budget","lock"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Read original budget lock\n\nRequires budget:read and current project view permission. Company is derived from authentication; path, query or body project must be authorized. An absent lock is returned as unlocked with null owner and timestamp."}},{"id":"21edfef1-0e2c-48fc-89c9-f6f9431f09e8","name":"createProjectBudgetLock — Lock original budget","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/budget/lock","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","budget","lock"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Lock original budget\n\nRequires budget:write and current project admin permission. Company is derived from authentication; path, query or body project must be authorized. Locks original-budget editing. Approved manual budget changes remain supported. No request body."}},{"id":"dc926d48-b27e-455f-8619-64c66603f9b5","name":"deleteProjectBudgetLock — Unlock original budget","request":{"method":"DELETE","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/budget/lock","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","budget","lock"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Unlock original budget\n\nRequires budget:write and current project admin permission. Company is derived from authentication; path, query or body project must be authorized. Returns the lock JSON with locked false; this is not a 204 response. No request body."}},{"id":"4994ca45-ee95-4b6e-8a73-b5f64086ce77","name":"listProjectBudgetChangeHistory — Read current budget change history","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/budget_change_history","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","budget_change_history"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Read current budget change history\n\nRequires budget:read and current project view permission. Company is derived from authentication; path, query or body project must be authorized. Unpaginated current non-deleted changes, including drafts. This is not the immutable posting journal; edits and deletion change this listing."}},{"id":"b275bdc3-53a5-4117-8ab2-c7a2f99d4a7e","name":"listProjectBudgetChanges — List budget changes","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/budget_changes","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","budget_changes"],"query":[{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true},{"key":"filters[status]","value":"","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"List budget changes\n\nRequires budget:read and current project view permission. Company is derived from authentication; path, query or body project must be authorized. Total, Per-Page and Link headers. Only the status filter is honored; no search filter."}},{"id":"846628a5-5ce2-4fe2-8303-674d1f4cc099","name":"createProjectBudgetChange — Create manual budget change","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/budget_changes","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","budget_changes"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Create manual budget change\n\nRequires budget:write and current project create permission. Company is derived from authentication; path, query or body project must be authorized. Permitted while the original budget is locked. Defaults to draft; approved creation immediately affects approved changes. CE- numbers are reserved and return 409. Adjustments must reference cost codes and optional matching budget lines in this project.","body":{"mode":"raw","raw":"{\n  \"budget_change\": {\n    \"title\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"838454c4-af26-4451-8ef7-8afa4bb6ac4c","name":"getProjectBudgetChange — Read budget change","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/budget_changes/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","budget_changes",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Read budget change\n\nRequires budget:read and current project view permission. Company is derived from authentication; path, query or body project must be authorized. "}},{"id":"c5ee2572-7e00-4af9-8d31-7ea3af27d7ad","name":"updateProjectBudgetChange — Edit manual budget change","request":{"method":"PATCH","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/budget_changes/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","budget_changes",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Edit manual budget change\n\nRequires budget:write and current project edit permission. Company is derived from authentication; path, query or body project must be authorized. Edit permission may approve or reopen a manual change, including while the original budget is locked. Supplying adjustments replaces the full adjustment list; omitted adjustments remain. CE-owned projections must be changed through the source change event and return 409 here.","body":{"mode":"raw","raw":"{\n  \"budget_change\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"200e645d-83f7-49e1-81fa-04168be840ac","name":"deleteProjectBudgetChange — Delete manual budget change","request":{"method":"DELETE","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/budget_changes/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","budget_changes",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Delete manual budget change\n\nRequires budget:write and current project delete permission. Company is derived from authentication; path, query or body project must be authorized. Soft-deletes a manual change; removes its contribution to live totals. CE-owned projections return 409 and must be changed through their source."}},{"id":"b1cfa1c0-a922-49e7-8e05-c084c997fc4f","name":"listProjectBudgetModifications — List Budget Modifications","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/budget_modifications","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","budget_modifications"],"query":[{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"List Budget Modifications"}},{"id":"f781bc48-3be9-42d0-859a-dde06583df11","name":"createProjectBudgetModification — Create Budget Modification","request":{"method":"POST","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/budget_modifications","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","budget_modifications"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Create Budget Modification","body":{"mode":"raw","raw":"{\n  \"budget_modification\": {\n    \"to_budget_line_item_id\": 0,\n    \"transfer_amount\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"5eecb5c4-7e4f-4fe4-8df7-1948f1fc454c","name":"getProjectBudgetModification — Show Budget Modification","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/budget_modifications/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","budget_modifications",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Show Budget Modification"}},{"id":"29a3e4af-313e-419e-8ab3-74ae99a7acfa","name":"updateProjectBudgetModification — Update Budget Modification","request":{"method":"PATCH","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/budget_modifications/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","budget_modifications",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Update Budget Modification","body":{"mode":"raw","raw":"{\n  \"budget_modification\": {\n    \"to_budget_line_item_id\": 0,\n    \"transfer_amount\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"a5b979ee-7a58-4493-86d6-5c0f8e02bc8f","name":"deleteProjectBudgetModification — Delete Budget Modification","request":{"method":"DELETE","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/budget_modifications/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","budget_modifications",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Delete Budget Modification"}},{"id":"c59c84e4-20b4-4b38-8db9-4d01f46b9811","name":"getCompanyBudgetViewV20 — Get a Budget View","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v2.0/companies/:company_id/budget_views/:budget_view_id","host":["{{baseUrl}}"],"path":["rest","v2.0","companies",":company_id","budget_views",":budget_view_id"],"query":[{"key":"source_snapshot_id","value":"","disabled":true},{"key":"project_id","value":"","disabled":true}],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"budget_view_id","value":""}]},"description":"Get a Budget View"}},{"id":"3bb221a1-5ec0-4541-832a-01255b65dd1e","name":"listCompanyProjectBudgetLineItemsV20 — List Budget Line Items","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v2.0/companies/:company_id/projects/:project_id/budget_line_items","host":["{{baseUrl}}"],"path":["rest","v2.0","companies",":company_id","projects",":project_id","budget_line_items"],"query":[{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true},{"key":"filters[wbs_code_id]","value":"","disabled":true}],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"project_id","value":"{{projectId}}"}]},"description":"List Budget Line Items"}},{"id":"2a4a0391-27f2-4ca3-8037-45fef54ae701","name":"deleteCompanyProjectBudgetLineItemV20 — Delete Budget Line Item","request":{"method":"DELETE","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v2.0/companies/:company_id/projects/:project_id/budget_line_items/:id","host":["{{baseUrl}}"],"path":["rest","v2.0","companies",":company_id","projects",":project_id","budget_line_items",":id"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Delete Budget Line Item"}}]},{"name":"Change Events","description":"Module: change_events","item":[{"id":"8e85979e-6343-4e10-87d3-5476a9745653","name":"listChangeEventStatuses — List Change Event statuses","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/change_event/statuses","host":["{{baseUrl}}"],"path":["rest","v1.0","change_event","statuses"],"query":[{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true},{"key":"project_id","value":"","disabled":false}]},"description":"List Change Event statuses"}},{"id":"e75f7b37-8d27-45b9-800e-fef12cfb3b5e","name":"listChangeEvents — List Change Events","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/change_events","host":["{{baseUrl}}"],"path":["rest","v1.0","change_events"],"query":[{"key":"project_id","value":"","disabled":false},{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true},{"key":"filters[change_event_status_id][]","value":"","disabled":true},{"key":"filters[change_order_change_reason_id][]","value":"","disabled":true},{"key":"filters[change_type_id][]","value":"","disabled":true},{"key":"filters[created_at]","value":"","disabled":true},{"key":"filters[id]","value":"","disabled":true},{"key":"filters[include_deleted]","value":"","disabled":true},{"key":"filters[origin_type][]","value":"","disabled":true},{"key":"filters[updated_at]","value":"","disabled":true},{"key":"include_rfqs","value":"","disabled":true}]},"description":"List Change Events"}},{"id":"96b73b29-731a-4adc-880b-accc599b7fda","name":"createChangeEvent — Create Change Event","request":{"method":"POST","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/change_events","host":["{{baseUrl}}"],"path":["rest","v1.0","change_events"],"query":[{"key":"project_id","value":"","disabled":false}]},"description":"Create Change Event","body":{"mode":"raw","raw":"{\n  \"attachments\": [\n    \"\"\n  ],\n  \"change_event\": {\n    \"change_event_status_id\": 0,\n    \"event_scope\": \"tbd\"\n  },\n  \"change_event_origin_id\": 0,\n  \"change_event_origin_type\": \"\",\n  \"origin_global_id\": \"\"\n}","options":{"raw":{"language":"json"}}}}},{"id":"2ba27cfb-0977-4896-868b-454ceb53e654","name":"getChangeEvent — Show Change Event","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/change_events/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","change_events",":id"],"query":[{"key":"project_id","value":"","disabled":false}],"variable":[{"key":"id","value":""}]},"description":"Show Change Event"}},{"id":"f13b0511-29ab-4263-8c7b-c200a16485dd","name":"updateChangeEvent — Update Change Event","request":{"method":"PATCH","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/change_events/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","change_events",":id"],"query":[{"key":"project_id","value":"","disabled":false}],"variable":[{"key":"id","value":""}]},"description":"Update Change Event","body":{"mode":"raw","raw":"{\n  \"attachments\": [\n    \"\"\n  ],\n  \"change_event\": {},\n  \"change_event_origin_id\": 0,\n  \"change_event_origin_type\": \"\",\n  \"origin_global_id\": \"\",\n  \"project_id\": 0\n}","options":{"raw":{"language":"json"}}}}},{"id":"a96aa56d-5dcc-4d12-8345-0ced4b8c80c8","name":"deleteChangeEvent — Delete change event","request":{"method":"DELETE","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/change_events/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","change_events",":id"],"variable":[{"key":"id","value":""}]},"description":"Delete change event"}}]},{"name":"Change Orders","description":"Module: change_orders","item":[{"id":"23ff2b85-78ad-4b03-841c-20d7c8794c40","name":"listChangeOrderPackages — List Change Order Packages","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/change_order_packages","host":["{{baseUrl}}"],"path":["rest","v1.0","change_order_packages"],"query":[{"key":"project_id","value":"","disabled":false},{"key":"contract_id","value":"","disabled":true},{"key":"filters[id]","value":"","disabled":true},{"key":"filters[created_at]","value":"","disabled":true},{"key":"filters[updated_at]","value":"","disabled":true},{"key":"filters[reviewed_at]","value":"","disabled":true},{"key":"filters[due_date]","value":"","disabled":true},{"key":"filters[include_deleted]","value":"","disabled":true},{"key":"filters[invoiced_date]","value":"","disabled":true},{"key":"filters[paid_date]","value":"","disabled":true},{"key":"filters[signed_change_order_received_date]","value":"","disabled":true},{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true}]},"description":"List Change Order Packages"}},{"id":"b48949ea-89ae-4c08-8c9c-fed0a2689ec4","name":"createChangeOrderPackage — Create Change Order Package","request":{"method":"POST","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/change_order_packages","host":["{{baseUrl}}"],"path":["rest","v1.0","change_order_packages"]},"description":"Create Change Order Package","body":{"mode":"raw","raw":"{\n  \"change_order\": {},\n  \"contract_id\": 0,\n  \"project_id\": 0\n}","options":{"raw":{"language":"json"}}}}},{"id":"77e65e09-753d-4608-80f4-1f62da8ef9f7","name":"getChangeOrderPackage — Show Change Order Package","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/change_order_packages/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","change_order_packages",":id"],"query":[{"key":"project_id","value":"","disabled":false},{"key":"contract_id","value":"","disabled":true}],"variable":[{"key":"id","value":""}]},"description":"Show Change Order Package"}},{"id":"56814df2-5626-4b6c-8939-ae9a8e3e7ba7","name":"updateChangeOrderPackage — Update Change Order Package","request":{"method":"PATCH","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/change_order_packages/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","change_order_packages",":id"],"variable":[{"key":"id","value":""}]},"description":"Update Change Order Package","body":{"mode":"raw","raw":"{\n  \"change_order\": {},\n  \"contract_id\": 0,\n  \"project_id\": 0\n}","options":{"raw":{"language":"json"}}}}},{"id":"db293f80-2479-4c42-8991-4ad58d8bfbe0","name":"listChangeOrderRequests — List Change Order Requests","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/change_order_requests","host":["{{baseUrl}}"],"path":["rest","v1.0","change_order_requests"],"query":[{"key":"project_id","value":"","disabled":false},{"key":"contract_id","value":"","disabled":false},{"key":"view","value":"","disabled":true},{"key":"filters[id]","value":"","disabled":true},{"key":"filters[created_at]","value":"","disabled":true},{"key":"filters[updated_at]","value":"","disabled":true},{"key":"filters[due_date]","value":"","disabled":true},{"key":"filters[invoiced_date]","value":"","disabled":true},{"key":"filters[paid_date]","value":"","disabled":true},{"key":"filters[change_order_package_id]","value":"","disabled":true},{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true},{"key":"filters[status]","value":"","disabled":true},{"key":"filters[not_status]","value":"","disabled":true}]},"description":"List Change Order Requests"}},{"id":"ce1205bb-65df-4ae5-8e2c-5d8eb16f323d","name":"getChangeOrderRequest — Show Change Order Request","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/change_order_requests/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","change_order_requests",":id"],"query":[{"key":"project_id","value":"","disabled":false},{"key":"contract_id","value":"","disabled":false},{"key":"view","value":"","disabled":true},{"key":"filters[include_deleted]","value":"","disabled":true}],"variable":[{"key":"id","value":""}]},"description":"Show Change Order Request"}},{"id":"27653459-4268-45a4-88b2-7767b0ac7b9a","name":"listPotentialChangeOrders — List Potential Change Orders","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/potential_change_orders","host":["{{baseUrl}}"],"path":["rest","v1.0","potential_change_orders"],"query":[{"key":"project_id","value":"","disabled":false},{"key":"filters[id]","value":"","disabled":true},{"key":"filters[origin_id]","value":"","disabled":true},{"key":"filters[created_at]","value":"","disabled":true},{"key":"filters[updated_at]","value":"","disabled":true},{"key":"filters[due_date]","value":"","disabled":true},{"key":"filters[contract_id]","value":"","disabled":true},{"key":"filters[include_deleted]","value":"","disabled":true},{"key":"filters[invoiced_date]","value":"","disabled":true},{"key":"filters[paid_date]","value":"","disabled":true},{"key":"filters[reviewed_at]","value":"","disabled":true},{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true}]},"description":"List Potential Change Orders"}},{"id":"95fccd83-b185-4559-8f88-82c9a088b839","name":"createPotentialChangeOrder — Create Potential Change Order","request":{"method":"POST","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/potential_change_orders","host":["{{baseUrl}}"],"path":["rest","v1.0","potential_change_orders"]},"description":"Create Potential Change Order","body":{"mode":"raw","raw":"{\n  \"change_order\": {},\n  \"contract_id\": 0,\n  \"project_id\": 0\n}","options":{"raw":{"language":"json"}}}}},{"id":"f427950a-edac-4e33-8fc1-3928b685a44f","name":"getPotentialChangeOrder — Show Potential Change Orders","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/potential_change_orders/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","potential_change_orders",":id"],"query":[{"key":"project_id","value":"","disabled":false},{"key":"contract_id","value":"","disabled":false}],"variable":[{"key":"id","value":""}]},"description":"Show Potential Change Orders"}},{"id":"bdab79e6-f9bf-4e16-84eb-7eb82dc20bf3","name":"updatePotentialChangeOrder — Update Potential Change Order","request":{"method":"PATCH","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/potential_change_orders/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","potential_change_orders",":id"],"variable":[{"key":"id","value":""}]},"description":"Update Potential Change Order","body":{"mode":"raw","raw":"{\n  \"change_order\": {},\n  \"contract_id\": 0,\n  \"project_id\": 0\n}","options":{"raw":{"language":"json"}}}}},{"id":"52b5660f-2a72-4ee3-8351-145e54c70e54","name":"listPotentialChangeOrderLineItemMarkupLineItems — List markups on a potential change-order line item","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/potential_change_orders/:id/line_items/:line_item_id/markup_line_items","host":["{{baseUrl}}"],"path":["rest","v1.0","potential_change_orders",":id","line_items",":line_item_id","markup_line_items"],"query":[{"key":"project_id","value":"","disabled":true,"description":"Optional assertion of the project ID on the potential change order."}],"variable":[{"key":"id","value":"","description":"Potential change order ID."},{"key":"line_item_id","value":"","description":"Line item ID on the potential change order."}]},"description":"List markups on a potential change-order line item\n\nRequires change_orders:read, permission to view the project's Change Orders tool, and access to the live governing contract's schedule of values. A private potential change order requires administrative permission on the governing contract tool. Returns the line item's markup entries in position order."}},{"id":"44cd61e0-6023-41d5-891f-09dba2550e47","name":"createPotentialChangeOrderLineItemMarkupLineItem — Create a markup on a potential change-order line item","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/potential_change_orders/:id/line_items/:line_item_id/markup_line_items","host":["{{baseUrl}}"],"path":["rest","v1.0","potential_change_orders",":id","line_items",":line_item_id","markup_line_items"],"query":[{"key":"project_id","value":"","disabled":true,"description":"Optional assertion of the project ID on the potential change order."}],"variable":[{"key":"id","value":"","description":"Potential change order ID."},{"key":"line_item_id","value":"","description":"Line item ID on the potential change order."}]},"description":"Create a markup on a potential change-order line item\n\nRequires change_orders:write, permission to create records in the project's Change Orders tool, and access to the live governing contract's schedule of values. A private potential change order requires administrative permission on the governing contract tool. Supply one fixed amount or one percentage. A percentage applies to the line base and can include preceding markups. The returned amount is the computed contribution.","body":{"mode":"raw","raw":"{\n  \"markup_line_item\": {\n    \"amount\": null\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"5bbc3ea3-3144-4641-8132-58ccbe250dda","name":"getPotentialChangeOrderLineItemMarkupLineItem — Show a potential change-order line item markup","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/potential_change_orders/:id/line_items/:line_item_id/markup_line_items/:markup_id","host":["{{baseUrl}}"],"path":["rest","v1.0","potential_change_orders",":id","line_items",":line_item_id","markup_line_items",":markup_id"],"query":[{"key":"project_id","value":"","disabled":true,"description":"Optional assertion of the project ID on the potential change order."}],"variable":[{"key":"id","value":"","description":"Potential change order ID."},{"key":"line_item_id","value":"","description":"Line item ID on the potential change order."},{"key":"markup_id","value":"","description":"Markup ID on the specified line item."}]},"description":"Show a potential change-order line item markup\n\nRequires change_orders:read, permission to view the project's Change Orders tool, and access to the live governing contract's schedule of values. A private potential change order requires administrative permission on the governing contract tool. Returns the markup and its computed contribution based on the line and preceding markups."}},{"id":"54b97a21-29a0-47cf-8a62-268840386439","name":"updatePotentialChangeOrderLineItemMarkupLineItem — Update a potential change-order line item markup","request":{"method":"PATCH","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/potential_change_orders/:id/line_items/:line_item_id/markup_line_items/:markup_id","host":["{{baseUrl}}"],"path":["rest","v1.0","potential_change_orders",":id","line_items",":line_item_id","markup_line_items",":markup_id"],"query":[{"key":"project_id","value":"","disabled":true,"description":"Optional assertion of the project ID on the potential change order."}],"variable":[{"key":"id","value":"","description":"Potential change order ID."},{"key":"line_item_id","value":"","description":"Line item ID on the potential change order."},{"key":"markup_id","value":"","description":"Markup ID on the specified line item."}]},"description":"Update a potential change-order line item markup\n\nRequires change_orders:write, permission to edit records in the project's Change Orders tool, and access to the live governing contract's schedule of values. A private potential change order requires administrative permission on the governing contract tool. Omitted fields keep their current values. To switch markup modes, send null for the old field and a value for the new field in the same request.","body":{"mode":"raw","raw":"{\n  \"markup_line_item\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"d616ea58-f3b2-4fbd-85ee-0d904faeecce","name":"deletePotentialChangeOrderLineItemMarkupLineItem — Delete a potential change-order line item markup","request":{"method":"DELETE","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/potential_change_orders/:id/line_items/:line_item_id/markup_line_items/:markup_id","host":["{{baseUrl}}"],"path":["rest","v1.0","potential_change_orders",":id","line_items",":line_item_id","markup_line_items",":markup_id"],"query":[{"key":"project_id","value":"","disabled":true,"description":"Optional assertion of the project ID on the potential change order."}],"variable":[{"key":"id","value":"","description":"Potential change order ID."},{"key":"line_item_id","value":"","description":"Line item ID on the potential change order."},{"key":"markup_id","value":"","description":"Markup ID on the specified line item."}]},"description":"Delete a potential change-order line item markup\n\nRequires change_orders:write, permission to delete records in the project's Change Orders tool, and access to the live governing contract's schedule of values. A private potential change order requires administrative permission on the governing contract tool. Removes the specified markup entry from the line item."}},{"id":"d7060d27-3718-45ad-8443-0b0617abc451","name":"listPotentialChangeOrderLineItems — List Potential Change Order Line Items","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/potential_change_orders/:potential_change_order_id/line_items","host":["{{baseUrl}}"],"path":["rest","v1.0","potential_change_orders",":potential_change_order_id","line_items"],"query":[{"key":"project_id","value":"","disabled":false},{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true},{"key":"filters[id]","value":"","disabled":true},{"key":"filters[created_at]","value":"","disabled":true},{"key":"filters[updated_at]","value":"","disabled":true},{"key":"filters[cost_code_id]","value":"","disabled":true},{"key":"filters[line_item_type_id]","value":"","disabled":true}],"variable":[{"key":"potential_change_order_id","value":""}]},"description":"List Potential Change Order Line Items"}},{"id":"86a0a826-9dc9-4bd8-8729-c11378ed523f","name":"createPotentialChangeOrderLineItem — Create Potential Change Order Line Item","request":{"method":"POST","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/potential_change_orders/:potential_change_order_id/line_items","host":["{{baseUrl}}"],"path":["rest","v1.0","potential_change_orders",":potential_change_order_id","line_items"],"variable":[{"key":"potential_change_order_id","value":""}]},"description":"Create Potential Change Order Line Item","body":{"mode":"raw","raw":"{\n  \"line_item\": {},\n  \"project_id\": 0\n}","options":{"raw":{"language":"json"}}}}},{"id":"0ba35e77-4d12-4805-8f9b-2a8b6018c3d3","name":"getPotentialChangeOrderLineItem — Show Potential Change Order Line Item","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/potential_change_orders/:potential_change_order_id/line_items/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","potential_change_orders",":potential_change_order_id","line_items",":id"],"query":[{"key":"project_id","value":"","disabled":false}],"variable":[{"key":"potential_change_order_id","value":""},{"key":"id","value":""}]},"description":"Show Potential Change Order Line Item"}},{"id":"bdb67f23-ba88-48dd-8d6b-0067ab7f4ae5","name":"updatePotentialChangeOrderLineItem — Update Potential Change Order Line Item","request":{"method":"PATCH","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/potential_change_orders/:potential_change_order_id/line_items/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","potential_change_orders",":potential_change_order_id","line_items",":id"],"variable":[{"key":"potential_change_order_id","value":""},{"key":"id","value":""}]},"description":"Update Potential Change Order Line Item","body":{"mode":"raw","raw":"{\n  \"line_item\": {},\n  \"project_id\": 0\n}","options":{"raw":{"language":"json"}}}}},{"id":"5bff5458-b386-498c-838b-cf5291a9c7b5","name":"deletePotentialChangeOrderLineItem — Delete Potential Change Order Line Item","request":{"method":"DELETE","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/potential_change_orders/:potential_change_order_id/line_items/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","potential_change_orders",":potential_change_order_id","line_items",":id"],"query":[{"key":"project_id","value":"","disabled":false}],"variable":[{"key":"potential_change_order_id","value":""},{"key":"id","value":""}]},"description":"Delete Potential Change Order Line Item"}},{"id":"c78e39ee-ac34-49cd-867a-39b0dee4031c","name":"listProjectChangeOrderConfiguration — Show project change-order configuration","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/change_order_configuration","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","change_order_configuration"],"variable":[{"key":"project_id","value":"{{projectId}}","description":"Project ID in the authenticated company."}]},"description":"Show project change-order configuration\n\nRequires change_orders:read and permission to view the project's Change Orders tool. The tier count defaults to 2 when there is no saved configuration. The updated_at field is present when a configuration is saved."}},{"id":"621ccfcd-6043-4328-8d11-f233992386b4","name":"changeOrderConfigurationProject — Set the project's change-order tier count","request":{"method":"PATCH","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/change_order_configuration","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","change_order_configuration"],"variable":[{"key":"project_id","value":"{{projectId}}","description":"Project ID in the authenticated company."}]},"description":"Set the project's change-order tier count\n\nRequires change_orders:write and administrative permission for the project's Change Orders tool. Sets the count reported by the project's potential change orders.","body":{"mode":"raw","raw":"{\n  \"change_order_configuration\": {\n    \"change_order_tiers\": 1\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"577e66d9-43c7-410d-85c3-a715d92d3463","name":"listProjectTaxCodes — List project change-order tax codes","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/tax_codes","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","tax_codes"],"variable":[{"key":"project_id","value":"{{projectId}}","description":"Project ID in the authenticated company."}]},"description":"List project change-order tax codes\n\nRequires change_orders:read and permission to view the project's Change Orders tool. Returns the project's reference codes for taxing potential change-order line items, sorted by ID."}}]},{"name":"Commitments","description":"Module: commitments","item":[{"id":"68369ce2-6bdc-488b-87f6-56b7d797ea99","name":"listCommitmentChangeOrders — List commitment change orders","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/commitment_change_orders","host":["{{baseUrl}}"],"path":["rest","v1.0","commitment_change_orders"],"query":[{"key":"project_id","value":"","disabled":false,"description":"Project containing the record."},{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true},{"key":"filters[id]","value":"","disabled":true,"description":"Change-order IDs."},{"key":"filters[commitment_id]","value":"","disabled":true,"description":"Parent commitment IDs."},{"key":"filters[contract_id]","value":"","disabled":true,"description":"Parent commitment IDs. Overrides the commitment_id filter when both are present."},{"key":"filters[status]","value":"","disabled":true,"description":"Filter by change-order status."}]},"description":"List commitment change orders\n\nRequires commitments:read and live Commitments view permission. The parent contract must be visible. Results include only change orders on visible parent commitments. Schedule-of-values permissions control line details."}},{"id":"0bb28f32-1f46-4090-8d1d-ef1307bce92f","name":"createCommitmentChangeOrder — Create a commitment change order","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/commitment_change_orders","host":["{{baseUrl}}"],"path":["rest","v1.0","commitment_change_orders"],"query":[{"key":"project_id","value":"","disabled":true,"description":"Project containing the record. Supply either this query parameter or the JSON body project_id. A valid query value takes precedence."}]},"description":"Create a commitment change order\n\nRequires commitments:write, live Commitments permission for this action and access to the parent contract. Uses create permission and requires schedule-of-values access when lines are supplied. Line references must belong to the same project and commitment. Approved change orders affect the parent commitment's revised amount.","body":{"mode":"raw","raw":"{\n  \"change_order\": {\n    \"contract_id\": 0\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"9c0ebe85-19ab-4b1a-8588-37c27f53d177","name":"getCommitmentChangeOrder — Get a commitment change order","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/commitment_change_orders/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","commitment_change_orders",":id"],"query":[{"key":"project_id","value":"","disabled":false,"description":"Project containing the record."}],"variable":[{"key":"id","value":""}]},"description":"Get a commitment change order\n\nRequires commitments:read and live Commitments view permission. The parent contract must be visible. Schedule-of-values permissions control line details."}},{"id":"2a781995-ffc4-4349-8787-5b731935ffdf","name":"updateCommitmentChangeOrder — Update a commitment change order","request":{"method":"PATCH","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/commitment_change_orders/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","commitment_change_orders",":id"],"query":[{"key":"project_id","value":"","disabled":true,"description":"Project containing the record. Supply either this query parameter or the JSON body project_id. A valid query value takes precedence."}],"variable":[{"key":"id","value":""}]},"description":"Update a commitment change order\n\nRequires commitments:write, live Commitments permission for this action and access to the parent contract. Uses edit permission. Update the header fields here and change lines through the line-item operations. Approved change orders affect the parent commitment's revised amount.","body":{"mode":"raw","raw":"{\n  \"change_order\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"4ab590b2-b71e-4b69-86cb-fe2a2031c0e7","name":"deleteCommitmentChangeOrder — Remove a commitment change order","request":{"method":"DELETE","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/commitment_change_orders/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","commitment_change_orders",":id"],"query":[{"key":"project_id","value":"","disabled":false,"description":"Project containing the record."}],"variable":[{"key":"id","value":""}]},"description":"Remove a commitment change order\n\nRequires commitments:write, live Commitments permission for this action and access to the parent contract. Uses delete permission. The order is soft-deleted. Removing an approved order changes the revised amount."}},{"id":"5f60dbfa-d83e-407f-8be9-d954b381c575","name":"listCommitmentChangeOrderLineItems — List commitment change order lines","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/commitment_change_orders/:id/line_items","host":["{{baseUrl}}"],"path":["rest","v1.0","commitment_change_orders",":id","line_items"],"query":[{"key":"project_id","value":"","disabled":false,"description":"Project containing the record."},{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true}],"variable":[{"key":"id","value":""}]},"description":"List commitment change order lines\n\nRequires commitments:read and live Commitments view permission. The parent contract must be visible. Returns an empty line list if the actor lacks access to the parent schedule of values."}},{"id":"edf5def2-cbb7-4042-8ce6-9d696eb9df57","name":"createCommitmentChangeOrderLineItem — Add a commitment change order line","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/commitment_change_orders/:id/line_items","host":["{{baseUrl}}"],"path":["rest","v1.0","commitment_change_orders",":id","line_items"],"query":[{"key":"project_id","value":"","disabled":true,"description":"Project containing the record. Supply either this query parameter or the JSON body project_id. A valid query value takes precedence."}],"variable":[{"key":"id","value":""}]},"description":"Add a commitment change order line\n\nRequires commitments:write, live Commitments permission for this action and access to the parent contract. Uses create permission and requires schedule-of-values visibility. Referenced cost codes and commitment lines must match the same project and parent. Approved change orders affect the parent commitment's revised amount.","body":{"mode":"raw","raw":"{\n  \"line_item\": {\n    \"amount\": 0\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"724a3497-2e66-49df-8f0f-1448c19afb02","name":"updateCommitmentChangeOrderLineItem — Update a commitment change order line","request":{"method":"PATCH","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/commitment_change_orders/:id/line_items/:line_item_id","host":["{{baseUrl}}"],"path":["rest","v1.0","commitment_change_orders",":id","line_items",":line_item_id"],"query":[{"key":"project_id","value":"","disabled":true,"description":"Project containing the record. Supply either this query parameter or the JSON body project_id. A valid query value takes precedence."}],"variable":[{"key":"id","value":""},{"key":"line_item_id","value":""}]},"description":"Update a commitment change order line\n\nRequires commitments:write, live Commitments permission for this action and access to the parent contract. Uses edit permission and requires schedule-of-values visibility. Approved change orders affect the parent commitment's revised amount.","body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}}}},{"id":"577420dd-6cf0-4a17-84e0-f63274c1cf62","name":"deleteCommitmentChangeOrderLineItem — Delete a commitment change order line","request":{"method":"DELETE","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/commitment_change_orders/:id/line_items/:line_item_id","host":["{{baseUrl}}"],"path":["rest","v1.0","commitment_change_orders",":id","line_items",":line_item_id"],"query":[{"key":"project_id","value":"","disabled":false,"description":"Project containing the record."}],"variable":[{"key":"id","value":""},{"key":"line_item_id","value":""}]},"description":"Delete a commitment change order line\n\nRequires commitments:write, live Commitments permission for this action and access to the parent contract. Uses delete permission and requires schedule-of-values visibility. Permanently removes the line and changes the parent's revised amount when the order is approved."}},{"id":"8ae5f52d-bd05-401c-8891-8d0535a5f732","name":"listPurchaseOrderContracts — List of Purchase Order Contracts","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/purchase_order_contracts","host":["{{baseUrl}}"],"path":["rest","v1.0","purchase_order_contracts"],"query":[{"key":"project_id","value":"","disabled":false},{"key":"view","value":"","disabled":true},{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true},{"key":"filters[id]","value":"","disabled":true},{"key":"filters[status]","value":"","disabled":true},{"key":"filters[created_at]","value":"","disabled":true},{"key":"filters[updated_at]","value":"","disabled":true},{"key":"filters[include_deleted]","value":"","disabled":true},{"key":"filters[origin_id]","value":"","disabled":true}]},"description":"List of Purchase Order Contracts"}},{"id":"6df40ced-ed26-4f49-8e72-80456deca9b7","name":"createPurchaseOrderContract — Create Purchase Order Contract","request":{"method":"POST","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/purchase_order_contracts","host":["{{baseUrl}}"],"path":["rest","v1.0","purchase_order_contracts"],"query":[{"key":"run_configurable_validations","value":"","disabled":true}]},"description":"Create Purchase Order Contract","body":{"mode":"raw","raw":"{\n  \"attachments\": [\n    \"\"\n  ],\n  \"project_id\": 0,\n  \"purchase_order_contract\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"f73308b0-d2f4-44d0-8fc1-511f73f3c771","name":"getPurchaseOrderContract — Show Purchase Order Contract","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/purchase_order_contracts/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","purchase_order_contracts",":id"],"query":[{"key":"project_id","value":"","disabled":false}],"variable":[{"key":"id","value":""}]},"description":"Show Purchase Order Contract"}},{"id":"0f6c787c-0e92-43b6-8d97-0e80fbe35484","name":"updatePurchaseOrderContract — Update Purchase Order Contract","request":{"method":"PATCH","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/purchase_order_contracts/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","purchase_order_contracts",":id"],"query":[{"key":"run_configurable_validations","value":"","disabled":true}],"variable":[{"key":"id","value":""}]},"description":"Update Purchase Order Contract","body":{"mode":"raw","raw":"{\n  \"attachments\": [\n    \"\"\n  ],\n  \"project_id\": 0,\n  \"purchase_order_contract\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"fbba801a-4541-4810-839e-b4ed40a7a634","name":"deletePurchaseOrderContract — Delete Purchase Order Contract","request":{"method":"DELETE","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/purchase_order_contracts/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","purchase_order_contracts",":id"],"query":[{"key":"project_id","value":"","disabled":false}],"variable":[{"key":"id","value":""}]},"description":"Delete Purchase Order Contract"}},{"id":"1faba5fb-5338-46f0-8eae-d1c2ebcc9c27","name":"updatePurchaseOrderContractSubcontractorScheduleOfValuesStatus — Change the purchase order schedule-of-values review status","request":{"method":"PATCH","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/purchase_order_contracts/:id/subcontractor_schedule_of_values_status","host":["{{baseUrl}}"],"path":["rest","v1.0","purchase_order_contracts",":id","subcontractor_schedule_of_values_status"],"query":[{"key":"project_id","value":"","disabled":true,"description":"Project containing the record. Supply either this query parameter or the JSON body project_id. A valid query value takes precedence."}],"variable":[{"key":"id","value":""}]},"description":"Change the purchase order schedule-of-values review status\n\nRequires commitments:write, live Commitments access and both update and schedule-of-values permission on the contract. From draft, move to under_review. Under review can move to approved, revise_and_resubmit or draft. A revision can move to under_review or draft. An approved schedule can reopen to under_review. Repeating the current status is supported.","body":{"mode":"raw","raw":"{\n  \"status\": \"draft\"\n}","options":{"raw":{"language":"json"}}}}},{"id":"942dcb23-4197-4aa5-8418-51fe056549e6","name":"listPurchaseOrderContractLineItems — List Purchase Order Contract Line Items","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/purchase_order_contracts/:purchase_order_contract_id/line_items","host":["{{baseUrl}}"],"path":["rest","v1.0","purchase_order_contracts",":purchase_order_contract_id","line_items"],"query":[{"key":"project_id","value":"","disabled":false},{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true},{"key":"filters[id]","value":"","disabled":true},{"key":"filters[created_at]","value":"","disabled":true},{"key":"filters[updated_at]","value":"","disabled":true},{"key":"filters[cost_code_id]","value":"","disabled":true},{"key":"filters[line_item_type_id]","value":"","disabled":true},{"key":"view","value":"","disabled":true}],"variable":[{"key":"purchase_order_contract_id","value":""}]},"description":"List Purchase Order Contract Line Items"}},{"id":"7165c492-acd4-4115-8aaf-34dc8839b0b6","name":"createPurchaseOrderContractLineItem — Create Purchase Order Contract Line Item","request":{"method":"POST","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/purchase_order_contracts/:purchase_order_contract_id/line_items","host":["{{baseUrl}}"],"path":["rest","v1.0","purchase_order_contracts",":purchase_order_contract_id","line_items"],"variable":[{"key":"purchase_order_contract_id","value":""}]},"description":"Create Purchase Order Contract Line Item","body":{"mode":"raw","raw":"{\n  \"line_item\": {},\n  \"project_id\": 0\n}","options":{"raw":{"language":"json"}}}}},{"id":"cc4f5c1b-9f5b-4f3a-8826-77d2f2233deb","name":"getPurchaseOrderContractLineItem — Show Purchase Order Contract Line Item","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/purchase_order_contracts/:purchase_order_contract_id/line_items/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","purchase_order_contracts",":purchase_order_contract_id","line_items",":id"],"query":[{"key":"project_id","value":"","disabled":false},{"key":"view","value":"","disabled":true}],"variable":[{"key":"purchase_order_contract_id","value":""},{"key":"id","value":""}]},"description":"Show Purchase Order Contract Line Item"}},{"id":"7016b207-def5-40e8-86c4-47ef3bcac603","name":"updatePurchaseOrderContractLineItem — Update Purchase Order Contract Line Item","request":{"method":"PATCH","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/purchase_order_contracts/:purchase_order_contract_id/line_items/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","purchase_order_contracts",":purchase_order_contract_id","line_items",":id"],"variable":[{"key":"purchase_order_contract_id","value":""},{"key":"id","value":""}]},"description":"Update Purchase Order Contract Line Item","body":{"mode":"raw","raw":"{\n  \"line_item\": {},\n  \"project_id\": 0\n}","options":{"raw":{"language":"json"}}}}},{"id":"6c2ac8b0-e17a-4830-815e-9bf933c817f6","name":"deletePurchaseOrderContractLineItem — Delete Purchase Order Contract Line Item","request":{"method":"DELETE","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/purchase_order_contracts/:purchase_order_contract_id/line_items/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","purchase_order_contracts",":purchase_order_contract_id","line_items",":id"],"query":[{"key":"project_id","value":"","disabled":false}],"variable":[{"key":"purchase_order_contract_id","value":""},{"key":"id","value":""}]},"description":"Delete Purchase Order Contract Line Item"}},{"id":"708abd6a-ca59-4872-85f9-be8e82bb58d4","name":"listRequisitions — List Requisitions (Subcontractor Invoices) for Project","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/requisitions","host":["{{baseUrl}}"],"path":["rest","v1.0","requisitions"],"query":[{"key":"project_id","value":"","disabled":false},{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true},{"key":"filters[id]","value":"","disabled":true},{"key":"filters[commitment_id]","value":"","disabled":true},{"key":"filters[period_id]","value":"","disabled":true},{"key":"filters[status]","value":"","disabled":true},{"key":"filters[created_at]","value":"","disabled":true},{"key":"filters[updated_at]","value":"","disabled":true},{"key":"filters[origin_id]","value":"","disabled":true},{"key":"filters[search]","value":"","disabled":true}]},"description":"List Requisitions (Subcontractor Invoices) for Project"}},{"id":"f1dc4356-f286-4950-8a6d-e940091dd98c","name":"createRequisition — Create Requisition (Subcontractor Invoices) for Commitment","request":{"method":"POST","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/requisitions","host":["{{baseUrl}}"],"path":["rest","v1.0","requisitions"]},"description":"Create Requisition (Subcontractor Invoices) for Commitment","body":{"mode":"raw","raw":"{\n  \"attachments\": [\n    \"\"\n  ],\n  \"commitment_id\": 0,\n  \"project_id\": 0,\n  \"requisition\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"315700bb-36a4-4762-83ed-a020390e684d","name":"getRequisition — Show Requisition (Subcontractor Invoice)","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/requisitions/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","requisitions",":id"],"query":[{"key":"project_id","value":"","disabled":false}],"variable":[{"key":"id","value":""}]},"description":"Show Requisition (Subcontractor Invoice)"}},{"id":"e0f5e60e-1955-478b-8097-b5956698a382","name":"updateRequisition — Update Requisition (Subcontractor Invoice)","request":{"method":"PATCH","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/requisitions/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","requisitions",":id"],"variable":[{"key":"id","value":""}]},"description":"Update Requisition (Subcontractor Invoice)","body":{"mode":"raw","raw":"{\n  \"attachments\": [\n    \"\"\n  ],\n  \"commitment_id\": 0,\n  \"project_id\": 0,\n  \"requisition\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"35e0c191-26a9-4da7-8df8-e1a80848f699","name":"deleteRequisition — Delete Requisition (Subcontractor Invoice)","request":{"method":"DELETE","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/requisitions/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","requisitions",":id"],"query":[{"key":"project_id","value":"","disabled":false}],"variable":[{"key":"id","value":""}]},"description":"Delete Requisition (Subcontractor Invoice)"}},{"id":"126b2c94-d54d-493c-8145-59faca99d2ef","name":"approveRequisition — Approve a requisition","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/requisitions/:id/approve","host":["{{baseUrl}}"],"path":["rest","v1.0","requisitions",":id","approve"],"query":[{"key":"project_id","value":"","disabled":true,"description":"Project containing the record. Supply either this query parameter or the JSON body project_id. A valid query value takes precedence."}],"variable":[{"key":"id","value":""}]},"description":"Approve a requisition\n\nRequires commitments:write, live Commitments edit permission and visibility of the parent commitment. A live AP bill blocks changes. The current requisition status and billing history determine whether the transition is allowed. Moves the requisition to approved, records its approval time and recomputes billing totals. Approval checks the order of related allocations. This method is an alias for PATCH.","body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}}}},{"id":"7b4ff2de-9a6a-4fe7-8ef5-02a2f808d74e","name":"approveRequisitionPatch — Approve a requisition","request":{"method":"PATCH","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/requisitions/:id/approve","host":["{{baseUrl}}"],"path":["rest","v1.0","requisitions",":id","approve"],"query":[{"key":"project_id","value":"","disabled":true,"description":"Project containing the record. Supply either this query parameter or the JSON body project_id. A valid query value takes precedence."}],"variable":[{"key":"id","value":""}]},"description":"Approve a requisition\n\nRequires commitments:write, live Commitments edit permission and visibility of the parent commitment. A live AP bill blocks changes. The current requisition status and billing history determine whether the transition is allowed. Moves the requisition to approved, records its approval time and recomputes billing totals. Approval checks the order of related allocations.","body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}}}},{"id":"7359cd7a-b90a-4681-80d7-e90a512dd76b","name":"rejectRequisition — Return a requisition for revision","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/requisitions/:id/reject","host":["{{baseUrl}}"],"path":["rest","v1.0","requisitions",":id","reject"],"query":[{"key":"project_id","value":"","disabled":true,"description":"Project containing the record. Supply either this query parameter or the JSON body project_id. A valid query value takes precedence."}],"variable":[{"key":"id","value":""}]},"description":"Return a requisition for revision\n\nRequires commitments:write, live Commitments edit permission and visibility of the parent commitment. A live AP bill blocks changes. The current requisition status and billing history determine whether the transition is allowed. Moves the requisition to revise_and_resubmit and recomputes billing totals. This method is an alias for PATCH.","body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}}}},{"id":"1da8cc1e-71e4-4658-8bdf-1ff914fd2978","name":"rejectRequisitionPatch — Return a requisition for revision","request":{"method":"PATCH","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/requisitions/:id/reject","host":["{{baseUrl}}"],"path":["rest","v1.0","requisitions",":id","reject"],"query":[{"key":"project_id","value":"","disabled":true,"description":"Project containing the record. Supply either this query parameter or the JSON body project_id. A valid query value takes precedence."}],"variable":[{"key":"id","value":""}]},"description":"Return a requisition for revision\n\nRequires commitments:write, live Commitments edit permission and visibility of the parent commitment. A live AP bill blocks changes. The current requisition status and billing history determine whether the transition is allowed. Moves the requisition to revise_and_resubmit and recomputes billing totals.","body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}}}},{"id":"6bddbc74-cb01-4d88-8b10-864387839b9b","name":"submitRequisition — Submit a requisition for review","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/requisitions/:id/submit","host":["{{baseUrl}}"],"path":["rest","v1.0","requisitions",":id","submit"],"query":[{"key":"project_id","value":"","disabled":true,"description":"Project containing the record. Supply either this query parameter or the JSON body project_id. A valid query value takes precedence."}],"variable":[{"key":"id","value":""}]},"description":"Submit a requisition for review\n\nRequires commitments:write, live Commitments edit permission and visibility of the parent commitment. A live AP bill blocks changes. The current requisition status and billing history determine whether the transition is allowed. Moves the requisition to submitted and records its submission time on a transition. This method is an alias for PATCH.","body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}}}},{"id":"98895b00-3c65-42bb-859c-69ac3154f4dc","name":"submitRequisitionPatch — Submit a requisition for review","request":{"method":"PATCH","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/requisitions/:id/submit","host":["{{baseUrl}}"],"path":["rest","v1.0","requisitions",":id","submit"],"query":[{"key":"project_id","value":"","disabled":true,"description":"Project containing the record. Supply either this query parameter or the JSON body project_id. A valid query value takes precedence."}],"variable":[{"key":"id","value":""}]},"description":"Submit a requisition for review\n\nRequires commitments:write, live Commitments edit permission and visibility of the parent commitment. A live AP bill blocks changes. The current requisition status and billing history determine whether the transition is allowed. Moves the requisition to submitted and records its submission time on a transition.","body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}}}},{"id":"7b8e1d6b-634d-4c1a-876b-c45188ab612a","name":"listRequisitionContractDetailItems — List requisition contract detail items (G703)","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/requisitions/:requisition_id/contract_detail_items","host":["{{baseUrl}}"],"path":["rest","v1.0","requisitions",":requisition_id","contract_detail_items"],"variable":[{"key":"requisition_id","value":""}]},"description":"List requisition contract detail items (G703)"}},{"id":"a7967a36-10aa-4f78-8d83-80f3f71afe70","name":"createRequisitionContractDetailItem — Create a requisition contract detail item","request":{"method":"POST","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/requisitions/:requisition_id/contract_detail_items","host":["{{baseUrl}}"],"path":["rest","v1.0","requisitions",":requisition_id","contract_detail_items"],"variable":[{"key":"requisition_id","value":""}]},"description":"Create a requisition contract detail item"}},{"id":"743357c6-cf50-4b1f-800e-8bbfcdb60d1c","name":"updateRequisitionContractDetailItem — Update a requisition contract detail item (this-period entry)","request":{"method":"PATCH","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/requisitions/:requisition_id/contract_detail_items/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","requisitions",":requisition_id","contract_detail_items",":id"],"variable":[{"key":"requisition_id","value":""},{"key":"id","value":""}]},"description":"Update a requisition contract detail item (this-period entry)"}},{"id":"fca4d69c-e597-4293-87fb-64bbd5db72b4","name":"deleteRequisitionContractDetailItem — Delete a requisition contract detail line","request":{"method":"DELETE","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/requisitions/:requisition_id/contract_detail_items/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","requisitions",":requisition_id","contract_detail_items",":id"],"query":[{"key":"project_id","value":"","disabled":false,"description":"Project containing the record."}],"variable":[{"key":"requisition_id","value":""},{"key":"id","value":""}]},"description":"Delete a requisition contract detail line\n\nRequires commitments:write, live Commitments delete permission, visibility of the parent commitment and access to its schedule of values. Removes the line and recomputes requisition totals. A live AP bill or protected billing allocations can block the deletion."}},{"id":"84403a7b-ee43-4300-8bb2-4563f9783f06","name":"listWorkOrderContracts — List work order contracts","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/work_order_contracts","host":["{{baseUrl}}"],"path":["rest","v1.0","work_order_contracts"],"query":[{"key":"project_id","value":"","disabled":false},{"key":"view","value":"","disabled":true},{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true},{"key":"filters[id]","value":"","disabled":true},{"key":"filters[status]","value":"","disabled":true},{"key":"filters[created_at]","value":"","disabled":true},{"key":"filters[updated_at]","value":"","disabled":true},{"key":"filters[include_deleted]","value":"","disabled":true},{"key":"filters[origin_id]","value":"","disabled":true}]},"description":"List work order contracts"}},{"id":"6eaeec38-e818-48cd-8545-b41a3f467d56","name":"createWorkOrderContract — Create work order contract","request":{"method":"POST","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/work_order_contracts","host":["{{baseUrl}}"],"path":["rest","v1.0","work_order_contracts"],"query":[{"key":"run_configurable_validations","value":"","disabled":true}]},"description":"Create work order contract","body":{"mode":"raw","raw":"{\n  \"attachments\": [\n    \"\"\n  ],\n  \"project_id\": 0,\n  \"work_order_contract\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"dbcd4276-5283-433c-8d42-699595abfa9a","name":"getWorkOrderContract — Show work order contract","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/work_order_contracts/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","work_order_contracts",":id"],"query":[{"key":"project_id","value":"","disabled":false}],"variable":[{"key":"id","value":""}]},"description":"Show work order contract"}},{"id":"85161e59-f94a-4c69-8ce7-6edf53ef6690","name":"updateWorkOrderContract — Update work order contract","request":{"method":"PATCH","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/work_order_contracts/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","work_order_contracts",":id"],"query":[{"key":"run_configurable_validations","value":"","disabled":true}],"variable":[{"key":"id","value":""}]},"description":"Update work order contract","body":{"mode":"raw","raw":"{\n  \"attachments\": [\n    \"\"\n  ],\n  \"project_id\": 0,\n  \"work_order_contract\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"e301d264-a598-4de9-8e48-acb64b7fb903","name":"deleteWorkOrderContract — Delete work order contract","request":{"method":"DELETE","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/work_order_contracts/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","work_order_contracts",":id"],"query":[{"key":"project_id","value":"","disabled":false}],"variable":[{"key":"id","value":""}]},"description":"Delete work order contract"}},{"id":"ff510117-5feb-4b55-82fa-196439cf7c1f","name":"updateWorkOrderContractSubcontractorScheduleOfValuesStatus — Change the work order schedule-of-values review status","request":{"method":"PATCH","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/work_order_contracts/:id/subcontractor_schedule_of_values_status","host":["{{baseUrl}}"],"path":["rest","v1.0","work_order_contracts",":id","subcontractor_schedule_of_values_status"],"query":[{"key":"project_id","value":"","disabled":true,"description":"Project containing the record. Supply either this query parameter or the JSON body project_id. A valid query value takes precedence."}],"variable":[{"key":"id","value":""}]},"description":"Change the work order schedule-of-values review status\n\nRequires commitments:write, live Commitments access and both update and schedule-of-values permission on the contract. From draft, move to under_review. Under review can move to approved, revise_and_resubmit or draft. A revision can move to under_review or draft. An approved schedule can reopen to under_review. Repeating the current status is supported.","body":{"mode":"raw","raw":"{\n  \"status\": \"draft\"\n}","options":{"raw":{"language":"json"}}}}},{"id":"1a63b664-4209-4c0b-87b5-fbd9b38731b1","name":"listWorkOrderContractLineItems — List Work Order Contract Line Items","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/work_order_contracts/:work_order_contract_id/line_items","host":["{{baseUrl}}"],"path":["rest","v1.0","work_order_contracts",":work_order_contract_id","line_items"],"query":[{"key":"project_id","value":"","disabled":false},{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true},{"key":"filters[id]","value":"","disabled":true},{"key":"filters[created_at]","value":"","disabled":true},{"key":"filters[updated_at]","value":"","disabled":true},{"key":"filters[cost_code_id]","value":"","disabled":true},{"key":"filters[line_item_type_id]","value":"","disabled":true},{"key":"view","value":"","disabled":true}],"variable":[{"key":"work_order_contract_id","value":""}]},"description":"List Work Order Contract Line Items"}},{"id":"a03f6453-dc4f-4b54-8710-bfea1b8f8c26","name":"createWorkOrderContractLineItem — Create Work Order Contract line item","request":{"method":"POST","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/work_order_contracts/:work_order_contract_id/line_items","host":["{{baseUrl}}"],"path":["rest","v1.0","work_order_contracts",":work_order_contract_id","line_items"],"variable":[{"key":"work_order_contract_id","value":""}]},"description":"Create Work Order Contract line item","body":{"mode":"raw","raw":"{\n  \"line_item\": {},\n  \"project_id\": 0\n}","options":{"raw":{"language":"json"}}}}},{"id":"797f555e-abe3-4198-86fe-aad103cae59d","name":"getWorkOrderContractLineItem — Show Work Order Contract line item","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/work_order_contracts/:work_order_contract_id/line_items/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","work_order_contracts",":work_order_contract_id","line_items",":id"],"query":[{"key":"project_id","value":"","disabled":false},{"key":"view","value":"","disabled":true}],"variable":[{"key":"work_order_contract_id","value":""},{"key":"id","value":""}]},"description":"Show Work Order Contract line item"}},{"id":"6779c26d-f626-43b9-8d85-8299700d8633","name":"updateWorkOrderContractLineItem — Update Work Order Contract line item","request":{"method":"PATCH","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/work_order_contracts/:work_order_contract_id/line_items/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","work_order_contracts",":work_order_contract_id","line_items",":id"],"variable":[{"key":"work_order_contract_id","value":""},{"key":"id","value":""}]},"description":"Update Work Order Contract line item","body":{"mode":"raw","raw":"{\n  \"line_item\": {},\n  \"project_id\": 0\n}","options":{"raw":{"language":"json"}}}}},{"id":"58814d30-cd22-47f3-80fa-4f2f024c9e08","name":"deleteWorkOrderContractLineItem — Delete Work Order Contract line item","request":{"method":"DELETE","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/work_order_contracts/:work_order_contract_id/line_items/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","work_order_contracts",":work_order_contract_id","line_items",":id"],"query":[{"key":"project_id","value":"","disabled":false}],"variable":[{"key":"work_order_contract_id","value":""},{"key":"id","value":""}]},"description":"Delete Work Order Contract line item"}}]},{"name":"Company Admin","description":"Module: company_admin","item":[{"id":"9dea2ced-3aa6-480a-8781-30f8cba2558b","name":"listCompanyDepartments — List departments","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/departments","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","departments"],"query":[{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true,"description":"Values above 1000 are clamped by the REST handler."},{"key":"search","value":"","disabled":true,"description":"Trimmed, case-insensitive substring match on name; blank means no filter."}],"variable":[{"key":"company_id","value":"{{companyId}}"}]},"description":"List departments\n\nRequires admin:read. The company path must match the authenticated company; company identity comes from the token. Readable by an authenticated active company member with the token scope. Returns a flat array, ordered by position and name. Includes inactive rows. Catalog presence does not grant authorization."}},{"id":"ac5edb3e-76cd-43c5-89bc-d6e85cb068f3","name":"createCompanyDepartment — Create departments","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/departments","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","departments"],"variable":[{"key":"company_id","value":"{{companyId}}"}]},"description":"Create departments\n\nRequires admin:write. The company path must match the authenticated company; company identity comes from the token. Requires company create permission, currently restricted to company administrators and subject to workspace restrictions.  Catalog presence does not grant authorization.","body":{"mode":"raw","raw":"{\n  \"department\": {\n    \"name\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"966d7ca7-af40-4ab9-84f5-eca47c71b38e","name":"getCompanyDepartment — Get departments","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/departments/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","departments",":id"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Get departments\n\nRequires admin:read. The company path must match the authenticated company; company identity comes from the token. Readable by an authenticated active company member with the token scope.  Catalog presence does not grant authorization."}},{"id":"6ca62dfd-bd73-4411-80a5-a5216523b584","name":"updateCompanyDepartment — Update departments","request":{"method":"PATCH","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/departments/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","departments",":id"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Update departments\n\nRequires admin:write. The company path must match the authenticated company; company identity comes from the token. Requires company edit permission, currently restricted to company administrators and subject to workspace restrictions.  Catalog presence does not grant authorization.","body":{"mode":"raw","raw":"{\n  \"department\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"db6786e8-2c57-4460-8f00-5fc163eeef63","name":"deleteCompanyDepartment — Delete departments","request":{"method":"DELETE","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/departments/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","departments",":id"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Delete departments\n\nRequires admin:write. The company path must match the authenticated company; company identity comes from the token. Requires company delete permission, currently restricted to company administrators and subject to workspace restrictions. Permanently deletes the record. Catalog presence does not grant authorization."}},{"id":"55e3e1a1-156f-4e03-8e4d-7983833921bb","name":"listCompanyInsuranceEvidenceInbox — Read current evidence awaiting review and route policy follow-ups","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/insurance_evidence_inbox","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","insurance_evidence_inbox"],"query":[{"key":"filter","value":"","disabled":true},{"key":"kind","value":"","disabled":true},{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true}],"variable":[{"key":"company_id","value":"{{companyId}}"}]},"description":"Read current evidence awaiting review and route policy follow-ups\n\nLive company-admin authority and admin:read token scope are required. Replaced evidence is excluded from every filter and retained in policy history. Unreviewed, unassigned and mine exclude evidence with a recorded review. Unassigned has no open policy follow-up; mine has an open follow-up assigned to the caller. All returns current evidence regardless of review state. Oldest received first, ID tiebreaker. Only metadata is returned: view/review bytes through the existing policy evidence workflow. Acceptance is not coverage verification or payment release."}},{"id":"9699235b-d52b-426d-8af7-68b0b71160f5","name":"listCompanyInsuranceFollowups — Company-scoped renewal follow-up queue","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/insurance_followups","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","insurance_followups"],"query":[{"key":"filter","value":"","disabled":true},{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true}],"variable":[{"key":"company_id","value":"{{companyId}}"}]},"description":"Company-scoped renewal follow-up queue\n\nOverdue means before the current UTC day; due soon includes today through 30 days. Completed items are excluded from overdue/due-soon/mine. Each response page contains at most 25 items. Owners without live authority remain visible for reassignment. No notifications are sent."}},{"id":"471e324f-35a7-4364-8e28-949225bb1c06","name":"listCompanyInsurancePolicies — List company insurance policies","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/insurance_policies","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","insurance_policies"],"query":[{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true,"description":"Handler clamps values above 1000."},{"key":"filters[project_id]","value":"","disabled":true,"description":"Only the first positive integer value is used. Invalid values are ignored. Filters narrow the company register; they do not imply project membership."},{"key":"filters[vendor_id]","value":"","disabled":true,"description":"Only the first positive integer value is used. Invalid values are ignored. Filters narrow the company register; they do not imply project membership."}],"variable":[{"key":"company_id","value":"{{companyId}}"}]},"description":"List company insurance policies\n\nRequires admin:read. Company path must match the authenticated tenant. Reads are available to active authenticated company members with the required token scope; no project-level membership gate. Flat array ordered by expiration date then ID. Includes policies associated with historical inactive projects/vendors. No status or search filter. Catalog presence does not grant access."}},{"id":"33d165d7-7739-424f-8a3f-e64d34e45c6d","name":"createCompanyInsurancePolicy — Create company insurance policy","request":{"method":"POST","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/insurance_policies","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","insurance_policies"],"variable":[{"key":"company_id","value":"{{companyId}}"}]},"description":"Create company insurance policy\n\nRequires admin:write. Company path must match the authenticated tenant. Writes require current company administrator authority; project-template admin permission alone is insufficient. Transactional services recheck authority. Project/vendor references must belong to this company; historical inactive references are permitted. Effective date cannot follow expiration date (400). Date-only inputs must be real calendar dates. Status in the response is pending without expiration, expired before the current instant, expiring within 30 days, otherwise active. JSON metadata only; no certificate upload. Catalog presence does not grant access.","body":{"mode":"raw","raw":"{\n  \"insurance_policy\": {\n    \"insurance_type\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"6932740c-c388-40f4-804f-47b5798ad5b9","name":"getCompanyInsurancePolicy — Read company insurance policy","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/insurance_policies/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","insurance_policies",":id"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Read company insurance policy\n\nRequires admin:read. Company path must match the authenticated tenant. Reads are available to active authenticated company members with the required token scope; no project-level membership gate. Response status is computed from expiration at read time, regardless of stored status. Catalog presence does not grant access."}},{"id":"ec3b782f-e190-4f53-8d97-e2328a2ba556","name":"updateCompanyInsurancePolicy — Edit company insurance policy","request":{"method":"PATCH","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/insurance_policies/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","insurance_policies",":id"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Edit company insurance policy\n\nRequires admin:write. Company path must match the authenticated tenant. Writes require current company administrator authority; project-template admin permission alone is insufficient. Transactional services recheck authority. Omitted nullable fields retain their value; explicit null clears them. Remaining project/vendor references must belong to the company. Effective date cannot follow expiration date (400), including when only one date is changed. Response status is freshly derived even if an explicit stored status is supplied. Catalog presence does not grant access.","body":{"mode":"raw","raw":"{\n  \"insurance_policy\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"1b79d511-8391-464f-8270-3c06edcb11d2","name":"deleteCompanyInsurancePolicy — Delete company insurance policy","request":{"method":"DELETE","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/insurance_policies/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","insurance_policies",":id"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Delete company insurance policy\n\nRequires admin:write. Company path must match the authenticated tenant. Writes require current company administrator authority; project-template admin permission alone is insufficient. Transactional services recheck authority. Permanently deletes the policy metadata record. Catalog presence does not grant access."}},{"id":"9f1acc77-e594-4701-8108-4e4d72fd1664","name":"listCompanyInsurancePolicyEvidence — Read policy evidence and immutable history","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/insurance_policies/:id/evidence","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","insurance_policies",":id","evidence"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Read policy evidence and immutable history"}},{"id":"593f6fc1-3946-4d9f-8147-137e44397a83","name":"evidenceCompanyInsurancePolicy — Receive an immutable PDF or scan; receipt does not verify coverage","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/insurance_policies/:id/evidence","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","insurance_policies",":id","evidence"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Receive an immutable PDF or scan; receipt does not verify coverage","body":{"mode":"formdata","formdata":[]}}},{"id":"8c96442f-beea-4e7a-8fab-2695abae17ca","name":"listCompanyInsurancePolicyEvidenceContent — Read authorized evidence bytes, validating received SHA-256","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/insurance_policies/:id/evidence/:evidence_id/content","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","insurance_policies",":id","evidence",":evidence_id","content"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""},{"key":"evidence_id","value":""}]},"description":"Read authorized evidence bytes, validating received SHA-256"}},{"id":"10c193e9-5481-480c-8ee6-c3fb7e46a6e9","name":"listCompanyInsurancePolicyFollowUp — Read policy follow-up","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/insurance_policies/:id/follow_up","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","insurance_policies",":id","follow_up"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Read policy follow-up"}},{"id":"89e4313a-04c3-44cc-8573-093b8da20a47","name":"followUpCompanyInsurancePolicy — Create, update, complete or reopen the single policy follow-up","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/insurance_policies/:id/follow_up","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","insurance_policies",":id","follow_up"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Create, update, complete or reopen the single policy follow-up\n\nOwner must currently have company admin authority. Completion is an administrative outcome only. Optional renewal must be the actual child of this policy. Reopen clears current completion/link and retains prior outcome in policy events. Commands require current policy version and a company-unique UUID; identical retries have no new effect.","body":{"mode":"raw","raw":"{\n  \"action\": \"create\",\n  \"due_date\": \"2026-01-31\",\n  \"expected_version\": 0,\n  \"note\": \"\",\n  \"owner_user_id\": 0,\n  \"request_key\": \"\"\n}","options":{"raw":{"language":"json"}}}}},{"id":"054f198a-0196-4890-8b20-77c1c85058a8","name":"createCompanyInsurancePolicyRenewal — Create a linked renewal, preserving prior files and reviews","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/insurance_policies/:id/renewals","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","insurance_policies",":id","renewals"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Create a linked renewal, preserving prior files and reviews","body":{"mode":"raw","raw":"{\n  \"expected_version\": 0,\n  \"note\": \"\",\n  \"policy\": {\n    \"insurance_type\": \"\"\n  },\n  \"request_key\": \"\"\n}","options":{"raw":{"language":"json"}}}}},{"id":"1c4796dd-5b1f-446a-8f33-14c9c5eec0be","name":"createCompanyInsurancePolicyReview — Record evidence acceptance, rejection or revocation with a reason","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/insurance_policies/:id/reviews","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","insurance_policies",":id","reviews"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Record evidence acceptance, rejection or revocation with a reason\n\nReview requires admin:read for the referenced source as well as admin:write. Acceptance records a document review, not verified coverage. Only an accepted review may be revoked. Every command requires current version and a company-unique request key; identical retries have no additional effect.","body":{"mode":"raw","raw":"{\n  \"decision\": \"accepted\",\n  \"evidence_id\": 0,\n  \"expected_version\": 0,\n  \"note\": \"\",\n  \"request_key\": \"\"\n}","options":{"raw":{"language":"json"}}}}},{"id":"dba877dd-3f88-4b6b-8f15-720d26d74878","name":"listCompanyInvitations — List invitations","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/invitations","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","invitations"],"variable":[{"key":"company_id","value":"{{companyId}}"}]},"description":"List invitations\n\nA scoped API token needs `identity:read`.","body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}}}},{"id":"89d72695-a77a-4973-8598-a935378d9c93","name":"createCompanyInvitation — Create invitation","request":{"method":"POST","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/invitations","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","invitations"],"variable":[{"key":"company_id","value":"{{companyId}}"}]},"description":"Create invitation"}},{"id":"dbffda36-4418-44f3-8d2a-ad86e4f4f7c0","name":"deleteCompanyInvitation — Delete invitation","request":{"method":"DELETE","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/invitations/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","invitations",":id"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Delete invitation"}},{"id":"05b5286d-a599-45f9-8185-e69f39309848","name":"listCompanyMigrationJobs — List migration jobs","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/migration_jobs","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","migration_jobs"],"query":[{"key":"page","value":"1","disabled":true,"description":"Page number, starting at 1."},{"key":"per_page","value":"100","disabled":true,"description":"Records per page."}],"variable":[{"key":"company_id","value":"{{companyId}}"}]},"description":"List migration jobs\n\nRequires the company `admin` permission. A scoped API token needs `migration:read`.","body":{"mode":"raw","raw":"{\n  \"migration_job\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"89013c76-4847-4a72-8b35-8523ae03ee49","name":"createCompanyMigrationJob — Create migration job","request":{"method":"POST","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/migration_jobs","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","migration_jobs"],"variable":[{"key":"company_id","value":"{{companyId}}"}]},"description":"Create migration job"}},{"id":"60cd3686-5f4c-4470-86e3-b3b0416707d1","name":"getCompanyMigrationJob — Get migration job","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/migration_jobs/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","migration_jobs",":id"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Get migration job\n\nA scoped API token needs `migration:read`."}},{"id":"dc056d30-e2ed-44d2-8633-0432d4e2eb09","name":"runCompanyMigrationJob — Execute the job","request":{"method":"POST","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/migration_jobs/:id/run","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","migration_jobs",":id","run"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Execute the job"}},{"id":"fe06f326-d42a-4dfe-8638-e95638a5b09b","name":"listCompanyOffices — List offices","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/offices","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","offices"],"query":[{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true,"description":"Values above 1000 are clamped by the REST handler."},{"key":"search","value":"","disabled":true,"description":"Trimmed, case-insensitive substring match on name; blank means no filter."}],"variable":[{"key":"company_id","value":"{{companyId}}"}]},"description":"List offices\n\nRequires admin:read. The company path must match the authenticated company; company identity comes from the token. Readable by an authenticated active company member with the token scope. Returns a flat array, ordered by main office first, then position and name. Includes inactive rows. Catalog presence does not grant authorization."}},{"id":"5ce50679-1726-4369-83ec-2cf6a86a17c6","name":"createCompanyOffice — Create offices","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/offices","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","offices"],"variable":[{"key":"company_id","value":"{{companyId}}"}]},"description":"Create offices\n\nRequires admin:write. The company path must match the authenticated company; company identity comes from the token. Requires company create permission, currently restricted to company administrators and subject to workspace restrictions. Setting main_office=true clears that flag on other company offices. Catalog presence does not grant authorization.","body":{"mode":"raw","raw":"{\n  \"office\": {\n    \"name\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"5bb27cbb-4b9d-46ec-8089-7093659af0c6","name":"getCompanyOffice — Get offices","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/offices/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","offices",":id"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Get offices\n\nRequires admin:read. The company path must match the authenticated company; company identity comes from the token. Readable by an authenticated active company member with the token scope.  Catalog presence does not grant authorization."}},{"id":"63504a76-bf84-4bfb-8b79-04aa9d7f6416","name":"updateCompanyOffice — Update offices","request":{"method":"PATCH","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/offices/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","offices",":id"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Update offices\n\nRequires admin:write. The company path must match the authenticated company; company identity comes from the token. Requires company edit permission, currently restricted to company administrators and subject to workspace restrictions. Setting main_office=true clears that flag on other company offices. Catalog presence does not grant authorization.","body":{"mode":"raw","raw":"{\n  \"office\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"ff2a689a-cd25-488a-86b9-ce39a9c891e5","name":"deleteCompanyOffice — Delete offices","request":{"method":"DELETE","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/offices/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","offices",":id"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Delete offices\n\nRequires admin:write. The company path must match the authenticated company; company identity comes from the token. Requires company delete permission, currently restricted to company administrators and subject to workspace restrictions. Permanently deletes the record. Catalog presence does not grant authorization."}},{"id":"a952bd35-1fb3-4538-8a90-16219ad1f0d1","name":"listCompanyPermissionTemplates — List company permission templates","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/permission_templates","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","permission_templates"],"query":[{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true,"description":"Handler clamps values above 1000."}],"variable":[{"key":"company_id","value":"{{companyId}}"}]},"description":"List company permission templates\n\nRequires admin:read. Company path must match the authenticated tenant. Reads are available to active authenticated company members with the required token scope; no project-level membership gate. Flat array ordered by name; pagination slices the company template list. No search or type filter. Catalog presence does not grant access."}},{"id":"09ec2836-ee9b-4259-8b78-cce68849a253","name":"createCompanyPermissionTemplate — Create company permission template","request":{"method":"POST","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/permission_templates","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","permission_templates"],"variable":[{"key":"company_id","value":"{{companyId}}"}]},"description":"Create company permission template\n\nRequires admin:write. Company path must match the authenticated tenant. Writes require current company administrator authority; project-template admin permission alone is insufficient. Transactional services recheck authority. Creates a project permission map; when analytics is omitted, creation inserts analytics:read_only. Creation does not assign the template or alter company admin flags. Catalog presence does not grant access.","body":{"mode":"raw","raw":"{\n  \"permission_template\": {\n    \"name\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"c4579d6c-8dc0-4b28-839f-93198581b08f","name":"getCompanyPermissionTemplate — Read company permission template","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/permission_templates/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","permission_templates",":id"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Read company permission template\n\nRequires admin:read. Company path must match the authenticated tenant. Reads are available to active authenticated company members with the required token scope; no project-level membership gate. Returns the stored map, not the effective permissions of a user. Company admin overrides and workspace restrictions are evaluated separately. Catalog presence does not grant access."}},{"id":"71e86311-e744-45c0-8fd2-53e4f43e6957","name":"updateCompanyPermissionTemplate — Edit company permission template","request":{"method":"PATCH","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/permission_templates/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","permission_templates",":id"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Edit company permission template\n\nRequires admin:write. Company path must match the authenticated tenant. Writes require current company administrator authority; project-template admin permission alone is insufficient. Transactional services recheck authority. Supplying permissions replaces the whole map, including when empty; omitted keys lose template grants. Unlike creation, update does not add an analytics default. Changes affect all memberships assigned this template. project_specific is metadata, not a project restriction. This does not change company administrator flags. Catalog presence does not grant access.","body":{"mode":"raw","raw":"{\n  \"permission_template\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"b16801b3-9318-4683-8917-ee75fdb3eda6","name":"deleteCompanyPermissionTemplate — Delete company permission template","request":{"method":"DELETE","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/permission_templates/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","permission_templates",":id"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Delete company permission template\n\nRequires admin:write. Company path must match the authenticated tenant. Writes require current company administrator authority; project-template admin permission alone is insufficient. Transactional services recheck authority. Clears this template from all valid company project memberships and permanently deletes it. Invalid retained foreign membership references fail with 400. Members may lose project grants; company administrator flags are not changed. No last-company-admin removal occurs through this operation. Catalog presence does not grant access."}},{"id":"20db1ce3-d691-40e2-8e52-032081669dc6","name":"createCompanyPermissionTemplateAssignment — Assign or clear a project permission template","request":{"method":"POST","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/permission_templates/:id/assignments","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","permission_templates",":id","assignments"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Assign or clear a project permission template\n\nRequires admin:write. Company path must match the authenticated tenant. Writes require current company administrator authority; project-template admin permission alone is insufficient. Transactional services recheck authority. Requires an existing project membership and project, user and template in the authenticated company. The path template must exist even when clearing. Only explicit permission_template_id:null clears; omitted or numeric body values select the path template. Clearing removes template-derived project permissions, while company admin overrides remain. Assignment never creates membership or changes company administrator flags. Catalog presence does not grant access.","body":{"mode":"raw","raw":"{\n  \"project_id\": 0,\n  \"user_id\": 0\n}","options":{"raw":{"language":"json"}}}}},{"id":"94b96a57-dda2-4262-82a3-7ff9e3e3bb05","name":"listCompanyProjectRegions — List project regions","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/project_regions","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","project_regions"],"query":[{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true,"description":"Values above 1000 are clamped by the REST handler."},{"key":"search","value":"","disabled":true,"description":"Trimmed, case-insensitive substring match on name; blank means no filter."}],"variable":[{"key":"company_id","value":"{{companyId}}"}]},"description":"List project regions\n\nRequires admin:read. The company path must match the authenticated company; company identity comes from the token. Readable by an authenticated active company member with the token scope. Returns a flat array, ordered by position and name. Includes inactive rows. Catalog presence does not grant authorization."}},{"id":"16ffc52b-44e4-4fa2-8e3c-4a6ba3bda383","name":"createCompanyProjectRegion — Create project regions","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/project_regions","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","project_regions"],"variable":[{"key":"company_id","value":"{{companyId}}"}]},"description":"Create project regions\n\nRequires admin:write. The company path must match the authenticated company; company identity comes from the token. Requires company create permission, currently restricted to company administrators and subject to workspace restrictions.  Catalog presence does not grant authorization.","body":{"mode":"raw","raw":"{\n  \"project_region\": {\n    \"name\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"eaa5ae2a-940c-4238-8a1f-4a834db815cb","name":"getCompanyProjectRegion — Get project regions","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/project_regions/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","project_regions",":id"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Get project regions\n\nRequires admin:read. The company path must match the authenticated company; company identity comes from the token. Readable by an authenticated active company member with the token scope.  Catalog presence does not grant authorization."}},{"id":"48c01db5-9dd9-472b-833a-3106701e2b75","name":"updateCompanyProjectRegion — Update project regions","request":{"method":"PATCH","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/project_regions/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","project_regions",":id"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Update project regions\n\nRequires admin:write. The company path must match the authenticated company; company identity comes from the token. Requires company edit permission, currently restricted to company administrators and subject to workspace restrictions.  Catalog presence does not grant authorization.","body":{"mode":"raw","raw":"{\n  \"project_region\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"659a32a9-aa89-4cc2-8087-6e7976c38036","name":"deleteCompanyProjectRegion — Delete project regions","request":{"method":"DELETE","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/project_regions/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","project_regions",":id"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Delete project regions\n\nRequires admin:write. The company path must match the authenticated company; company identity comes from the token. Requires company delete permission, currently restricted to company administrators and subject to workspace restrictions. Soft-deletes the record; later list/show omit it. Catalog presence does not grant authorization."}},{"id":"389c0aae-e7bb-48dd-8e35-5b19beaceab1","name":"getCompanyProjectStage — Get project stages","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/project_stages/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","project_stages",":id"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Get project stages\n\nRequires admin:read. The company path must match the authenticated company; company identity comes from the token. Readable by an authenticated active company member with the token scope.  Catalog presence does not grant authorization."}},{"id":"2a88ba4b-6373-46eb-8722-c69afbe10041","name":"updateCompanyProjectStage — Update project stages","request":{"method":"PATCH","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/project_stages/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","project_stages",":id"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Update project stages\n\nRequires admin:write. The company path must match the authenticated company; company identity comes from the token. Requires company edit permission, currently restricted to company administrators and subject to workspace restrictions.  Catalog presence does not grant authorization.","body":{"mode":"raw","raw":"{\n  \"project_stage\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"8dd5c0da-3e43-47ef-8a5b-687ecf095ded","name":"deleteCompanyProjectStage — Delete project stages","request":{"method":"DELETE","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/project_stages/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","project_stages",":id"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Delete project stages\n\nRequires admin:write. The company path must match the authenticated company; company identity comes from the token. Requires company delete permission, currently restricted to company administrators and subject to workspace restrictions. Permanently deletes the record. Catalog presence does not grant authorization."}},{"id":"ca26d1b9-b65c-43b3-8638-40636db95979","name":"listCompanyProjectTypes — List project types","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/project_types","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","project_types"],"query":[{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true,"description":"Values above 1000 are clamped by the REST handler."},{"key":"search","value":"","disabled":true,"description":"Trimmed, case-insensitive substring match on name; blank means no filter."}],"variable":[{"key":"company_id","value":"{{companyId}}"}]},"description":"List project types\n\nRequires admin:read. The company path must match the authenticated company; company identity comes from the token. Readable by an authenticated active company member with the token scope. Returns a flat array, ordered by position and name. Includes inactive rows. Catalog presence does not grant authorization."}},{"id":"1ce2871c-fff9-4c31-827d-88179eb43ede","name":"createCompanyProjectType — Create project types","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/project_types","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","project_types"],"variable":[{"key":"company_id","value":"{{companyId}}"}]},"description":"Create project types\n\nRequires admin:write. The company path must match the authenticated company; company identity comes from the token. Requires company create permission, currently restricted to company administrators and subject to workspace restrictions.  Catalog presence does not grant authorization.","body":{"mode":"raw","raw":"{\n  \"project_type\": {\n    \"name\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"337fd82d-4394-43d9-8516-a012b6c6ef1a","name":"getCompanyProjectType — Get project types","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/project_types/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","project_types",":id"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Get project types\n\nRequires admin:read. The company path must match the authenticated company; company identity comes from the token. Readable by an authenticated active company member with the token scope.  Catalog presence does not grant authorization."}},{"id":"4404d572-f45e-48f2-871a-e386aa9987aa","name":"updateCompanyProjectType — Update project types","request":{"method":"PATCH","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/project_types/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","project_types",":id"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Update project types\n\nRequires admin:write. The company path must match the authenticated company; company identity comes from the token. Requires company edit permission, currently restricted to company administrators and subject to workspace restrictions.  Catalog presence does not grant authorization.","body":{"mode":"raw","raw":"{\n  \"project_type\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"ed6ca1ac-4cec-4b9d-8018-f2600b96af18","name":"deleteCompanyProjectType — Delete project types","request":{"method":"DELETE","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/project_types/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","project_types",":id"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Delete project types\n\nRequires admin:write. The company path must match the authenticated company; company identity comes from the token. Requires company delete permission, currently restricted to company administrators and subject to workspace restrictions. Soft-deletes the record; later list/show omit it. Catalog presence does not grant authorization."}},{"id":"fed44402-38c8-4595-8408-43bc815530af","name":"listCompanyScimConnections — List SCIM connections","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/scim_connections","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","scim_connections"],"variable":[{"key":"company_id","value":"{{companyId}}"}]},"description":"List SCIM connections\n\nA scoped API token needs `identity:read`.","body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}}}},{"id":"4bbf5b89-efd5-473e-8df5-3bad40326bc7","name":"createCompanyScimConnection — Create SCIM connection","request":{"method":"POST","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/scim_connections","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","scim_connections"],"variable":[{"key":"company_id","value":"{{companyId}}"}]},"description":"Create SCIM connection"}},{"id":"f57188ea-c32a-49dc-877d-bcbff9c893e1","name":"deleteCompanyScimConnection — Delete SCIM connection","request":{"method":"DELETE","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/scim_connections/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","scim_connections",":id"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Delete SCIM connection"}},{"id":"6664a406-53ab-48c2-8ecf-71c4ac34112a","name":"listCompanyTrades — List trades","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/trades","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","trades"],"query":[{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true,"description":"Values above 1000 are clamped by the REST handler."},{"key":"search","value":"","disabled":true,"description":"Trimmed, case-insensitive substring match on name; blank means no filter."}],"variable":[{"key":"company_id","value":"{{companyId}}"}]},"description":"List trades\n\nRequires admin:read. The company path must match the authenticated company; company identity comes from the token. Readable by an authenticated active company member with the token scope. Returns a flat array, ordered by position and name. Includes inactive rows. Catalog presence does not grant authorization."}},{"id":"03ce29ec-d811-46fa-82ea-313d0cdcff7b","name":"createCompanyTrade — Create trades","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/trades","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","trades"],"variable":[{"key":"company_id","value":"{{companyId}}"}]},"description":"Create trades\n\nRequires admin:write. The company path must match the authenticated company; company identity comes from the token. Requires company create permission, currently restricted to company administrators and subject to workspace restrictions.  Catalog presence does not grant authorization.","body":{"mode":"raw","raw":"{\n  \"trade\": {\n    \"name\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"af9975e9-6fe1-4d86-8d87-9080b27559a4","name":"getCompanyTrade — Get trades","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/trades/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","trades",":id"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Get trades\n\nRequires admin:read. The company path must match the authenticated company; company identity comes from the token. Readable by an authenticated active company member with the token scope.  Catalog presence does not grant authorization."}},{"id":"cb2f8d70-5d23-4c60-8f17-16dc4f906f2e","name":"updateCompanyTrade — Update trades","request":{"method":"PATCH","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/trades/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","trades",":id"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Update trades\n\nRequires admin:write. The company path must match the authenticated company; company identity comes from the token. Requires company edit permission, currently restricted to company administrators and subject to workspace restrictions.  Catalog presence does not grant authorization.","body":{"mode":"raw","raw":"{\n  \"trade\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"f01b3ebe-a241-401b-8357-5dbe2ed40ddf","name":"deleteCompanyTrade — Delete trades","request":{"method":"DELETE","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/trades/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","trades",":id"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Delete trades\n\nRequires admin:write. The company path must match the authenticated company; company identity comes from the token. Requires company delete permission, currently restricted to company administrators and subject to workspace restrictions. Permanently deletes the record. Catalog presence does not grant authorization."}}]},{"name":"Connectors","description":"Module: connectors","item":[{"id":"a0c6dd49-9d72-4137-8b14-840212322f23","name":"listCompanyConnectors — List saved connection metadata","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/connectors","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","connectors"],"query":[{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true},{"key":"include","value":"","disabled":true,"description":"Set to authentication to include safe persisted credential and refresh metadata. This does not verify provider authorization or token validity."}],"variable":[{"key":"company_id","value":"{{companyId}}"}]},"description":"List saved connection metadata\n\nRequires connectors:read for nonlegacy scoped tokens and an active same-company admin or superadmin. Suspended/expired workspace reads remain available. No cross-company support bypass."}},{"id":"62e7d79a-e53d-4631-8e58-a6edd067993c","name":"getCompanyConnector — Read connection metadata","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/connectors/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","connectors",":id"],"query":[{"key":"include","value":"","disabled":true,"description":"Set to authentication to include safe persisted credential and refresh metadata. This does not verify provider authorization or token validity."}],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Read connection metadata\n\nRequires connectors:read for nonlegacy scoped tokens and an active same-company admin or superadmin. Suspended/expired workspace reads remain available. No cross-company support bypass."}},{"id":"9d3acc1f-bb34-4044-8405-cba873063741","name":"listCompanyConnectorRuns — List extraction run health","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/connectors/:id/runs","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","connectors",":id","runs"],"query":[{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true},{"key":"include","value":"","disabled":true,"description":"Set to authentication to include safe persisted credential and refresh metadata. This does not verify provider authorization or token validity."}],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"List extraction run health\n\nRequires connectors:read for nonlegacy scoped tokens and an active same-company admin or superadmin. Suspended/expired workspace reads remain available. No cross-company support bypass."}},{"id":"20d79cd7-7f49-44e7-8219-b19a77d56c51","name":"getCompanyConnectorRun — Read extraction run health","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/connectors/:id/runs/:run_id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","connectors",":id","runs",":run_id"],"query":[{"key":"include","value":"","disabled":true,"description":"Set to authentication to include safe persisted credential and refresh metadata. This does not verify provider authorization or token validity."}],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""},{"key":"run_id","value":""}]},"description":"Read extraction run health\n\nRequires connectors:read for nonlegacy scoped tokens and an active same-company admin or superadmin. Suspended/expired workspace reads remain available. No cross-company support bypass."}}]},{"name":"Conversations","description":"Module: conversations","item":[{"id":"d155329a-faa8-41a3-8d98-8199c7fed5bf","name":"listProjectConversations — List conversations the caller participates in","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/conversations","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","conversations"],"query":[{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true},{"key":"search","value":"","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"List conversations the caller participates in"}},{"id":"b0db5123-da7f-4269-87dd-900abbe917fd","name":"createProjectConversation — Create a conversation","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/conversations","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","conversations"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Create a conversation"}},{"id":"065f0653-4394-4b00-8017-67b15b17183f","name":"getProjectConversation — Show a conversation with a bounded message window","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/conversations/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","conversations",":id"],"query":[{"key":"before","value":"","disabled":true},{"key":"per_page","value":"100","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Show a conversation with a bounded message window"}},{"id":"c48e9657-fe6e-4fd9-899d-37a5da0f17c7","name":"updateProjectConversation — Update conversation","request":{"method":"PATCH","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/conversations/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","conversations",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Update conversation\n\nRename (subject). Manager-only (creator/admin); requires tool `edit`."}},{"id":"ced7edb7-f43a-476c-8f8a-5e28d048c676","name":"deleteProjectConversation — Delete conversation","request":{"method":"DELETE","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/conversations/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","conversations",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Delete conversation\n\nSoft-delete the whole thread. Manager-only (creator/admin); requires tool `delete`. Read-scoped: non-participants (non-admin) get 404, never a leaked thread."}},{"id":"928f7610-4ca2-49c4-86a4-9afa58e2bc5e","name":"leaveProjectConversation — Leave conversation","request":{"method":"POST","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/conversations/:id/leave","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","conversations",":id","leave"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Leave conversation\n\nThe caller leaves a conversation they participate in. Any participant may leave (no manager rights needed); requires tool `create` (participant-level, same gate as posting). If the caller was the last participant the thread is soft-deleted. Returns 204."}},{"id":"e14a040d-0cb5-4f10-83a4-1e2d3c11a3a0","name":"createProjectConversationMessage — Post a message to a conversation","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/conversations/:id/messages","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","conversations",":id","messages"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Post a message to a conversation"}},{"id":"962324ef-52f5-4b7c-88d3-993c60a6982d","name":"createProjectConversationParticipant — Add a participant","request":{"method":"POST","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/conversations/:id/participants","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","conversations",":id","participants"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Add a participant"}},{"id":"ed1fa5bb-a957-4659-8455-fd6ba189ebd0","name":"deleteProjectConversationParticipant — Delete conversation participant","request":{"method":"DELETE","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/conversations/:id/participants/:user_id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","conversations",":id","participants",":user_id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""},{"key":"user_id","value":""}]},"description":"Delete conversation participant"}},{"id":"73fa5f15-a114-438a-8b51-0aa251f2e61c","name":"readProjectConversation — Mark a conversation read for the caller","request":{"method":"PATCH","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/conversations/:id/read","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","conversations",":id","read"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Mark a conversation read for the caller","body":{"mode":"raw","raw":"{\n  \"last_read_at\": \"2026-01-31T12:00:00Z\",\n  \"through\": \"\"\n}","options":{"raw":{"language":"json"}}}}}]},{"name":"Coordination Issues","description":"Module: coordination_issues","item":[{"id":"571c280c-6eb1-415b-827b-03a20deda14d","name":"listCoordinationIssues — GET /rest/v1.0/coordination_issues","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/coordination_issues","host":["{{baseUrl}}"],"path":["rest","v1.0","coordination_issues"]},"description":"GET /rest/v1.0/coordination_issues"}},{"id":"2c03325b-4966-4fd5-82db-2891b711c856","name":"createCoordinationIssue — POST /rest/v1.0/coordination_issues","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/coordination_issues","host":["{{baseUrl}}"],"path":["rest","v1.0","coordination_issues"]},"description":"POST /rest/v1.0/coordination_issues"}},{"id":"648c0345-2149-434e-88df-30e03fb7064f","name":"listCoordinationIssuesAssignees — GET /rest/v1.0/coordination_issues/assignees","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/coordination_issues/assignees","host":["{{baseUrl}}"],"path":["rest","v1.0","coordination_issues","assignees"]},"description":"GET /rest/v1.0/coordination_issues/assignees"}},{"id":"3452e817-6756-4ddd-86e0-10290e6a86a1","name":"listCoordinationIssuesFilterOptionsStatus — GET /rest/v1.0/coordination_issues/filter_options/status","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/coordination_issues/filter_options/status","host":["{{baseUrl}}"],"path":["rest","v1.0","coordination_issues","filter_options","status"]},"description":"GET /rest/v1.0/coordination_issues/filter_options/status"}},{"id":"96cfe0ba-6af9-4e01-89a7-136f41cfcf46","name":"listCoordinationIssuesRecycleBin — GET /rest/v1.0/coordination_issues/recycle_bin","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/coordination_issues/recycle_bin","host":["{{baseUrl}}"],"path":["rest","v1.0","coordination_issues","recycle_bin"]},"description":"GET /rest/v1.0/coordination_issues/recycle_bin"}},{"id":"a9ec9f4e-41fc-4ebc-8925-6f83bf0d4809","name":"getCoordinationIssuesRecycleBin — Get recycled coordination issue","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/coordination_issues/recycle_bin/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","coordination_issues","recycle_bin",":id"],"variable":[{"key":"id","value":""}]},"description":"Get recycled coordination issue"}},{"id":"5672ee33-a732-470b-8b98-6141b027eb33","name":"updateCoordinationIssuesRecycleBin — Restore coordination issue from the recycle bin","request":{"method":"PATCH","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/coordination_issues/recycle_bin/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","coordination_issues","recycle_bin",":id"],"variable":[{"key":"id","value":""}]},"description":"Restore coordination issue from the recycle bin\n\nRestore from recycle bin (200 show)."}},{"id":"ce2688d2-0054-4536-89f1-65fbf6fa03b9","name":"listCoordinationIssuesStatusCount — Count coordination issues by status","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/coordination_issues/status_count","host":["{{baseUrl}}"],"path":["rest","v1.0","coordination_issues","status_count"],"query":[{"key":"project_id","value":"","disabled":false}]},"description":"Count coordination issues by status\n\nRequires the `view` permission on the project's coordination issues tool. A scoped API token needs `coordination_issues:read`."}},{"id":"6eeb8864-7dd1-4bab-8519-056bbaee84b8","name":"listCoordinationIssueComments — GET /rest/v1.0/coordination_issues/{coordination_issue_id}/comments","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/coordination_issues/:coordination_issue_id/comments","host":["{{baseUrl}}"],"path":["rest","v1.0","coordination_issues",":coordination_issue_id","comments"],"variable":[{"key":"coordination_issue_id","value":""}]},"description":"GET /rest/v1.0/coordination_issues/{coordination_issue_id}/comments"}},{"id":"4d6c1afd-7765-4205-8aa3-4fed9e30e0b9","name":"createCoordinationIssueComment — POST /rest/v1.0/coordination_issues/{coordination_issue_id}/comments","request":{"method":"POST","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/coordination_issues/:coordination_issue_id/comments","host":["{{baseUrl}}"],"path":["rest","v1.0","coordination_issues",":coordination_issue_id","comments"],"variable":[{"key":"coordination_issue_id","value":""}]},"description":"POST /rest/v1.0/coordination_issues/{coordination_issue_id}/comments"}},{"id":"3c8465a5-148b-4deb-8a35-0e8ec9fe7498","name":"getCoordinationIssue — GET /rest/v1.0/coordination_issues/{id}","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/coordination_issues/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","coordination_issues",":id"],"variable":[{"key":"id","value":""}]},"description":"GET /rest/v1.0/coordination_issues/{id}"}},{"id":"9addb158-424b-4dec-83af-6c72e6c55795","name":"updateCoordinationIssue — PATCH /rest/v1.0/coordination_issues/{id}","request":{"method":"PATCH","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/coordination_issues/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","coordination_issues",":id"],"variable":[{"key":"id","value":""}]},"description":"PATCH /rest/v1.0/coordination_issues/{id}"}},{"id":"c05aaf45-7d15-4f60-8e97-ac0d28a97be1","name":"deleteCoordinationIssue — Delete coordination issue","request":{"method":"DELETE","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/coordination_issues/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","coordination_issues",":id"],"variable":[{"key":"id","value":""}]},"description":"Delete coordination issue"}},{"id":"4d3a939c-e9cf-48ef-8eb4-6d719b76b0c1","name":"createCoordinationIssueAttachment — Upload coordination issue attachment","request":{"method":"POST","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/coordination_issues/:id/attachments","host":["{{baseUrl}}"],"path":["rest","v1.0","coordination_issues",":id","attachments"],"variable":[{"key":"id","value":""}]},"description":"Upload coordination issue attachment"}}]},{"name":"Correspondence","description":"Module: correspondence","item":[{"id":"3924175c-a086-4419-83c3-58e9cfaaa396","name":"listCompanyGenericTools — List Correspondence Types","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/generic_tools","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","generic_tools"],"variable":[{"key":"company_id","value":"{{companyId}}"}]},"description":"List Correspondence Types"}},{"id":"4b70636c-0f56-4a50-85dd-b08f889394fc","name":"createCompanyGenericTool — Create Correspondence Type","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/generic_tools","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","generic_tools"],"variable":[{"key":"company_id","value":"{{companyId}}"}]},"description":"Create Correspondence Type"}},{"id":"e37ee47a-523e-4a51-87af-c6def1d8c433","name":"getCompanyGenericTool — Show Correspondence Type","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/generic_tools/:generic_tool_id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","generic_tools",":generic_tool_id"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"generic_tool_id","value":""}]},"description":"Show Correspondence Type"}},{"id":"37981f67-cedc-4b5a-8c0e-afb19cd41ce8","name":"updateCompanyGenericTool — Update Correspondence Type","request":{"method":"PATCH","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/generic_tools/:generic_tool_id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","generic_tools",":generic_tool_id"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"generic_tool_id","value":""}]},"description":"Update Correspondence Type"}},{"id":"e8fe18a5-dbe9-49ca-8fb0-ab8de3b43116","name":"listProjectCorrespondenceTypeItems — List Correspondence Type Items","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/correspondence_type_items","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","correspondence_type_items"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"List Correspondence Type Items"}},{"id":"75aa9c13-69ed-44bb-8cb3-6c5f4ae67260","name":"listProjectGenericToolGenericToolItems — List Correspondence Items","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/generic_tools/:generic_tool_id/generic_tool_items","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","generic_tools",":generic_tool_id","generic_tool_items"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"generic_tool_id","value":""}]},"description":"List Correspondence Items"}},{"id":"9a8aca13-730a-4175-868d-bf0e2cea3e44","name":"createProjectGenericToolGenericToolItem — Create Correspondence Item","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/generic_tools/:generic_tool_id/generic_tool_items","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","generic_tools",":generic_tool_id","generic_tool_items"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"generic_tool_id","value":""}]},"description":"Create Correspondence Item"}},{"id":"805e424c-3fde-497b-86c9-038de1f5a089","name":"listProjectGenericToolGenericToolItemsAvailableStatuses — Available Statuses","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/generic_tools/:generic_tool_id/generic_tool_items/available_statuses","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","generic_tools",":generic_tool_id","generic_tool_items","available_statuses"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"generic_tool_id","value":""}]},"description":"Available Statuses"}},{"id":"34bc9108-a226-4fa4-84eb-c8a8c2b0445b","name":"getProjectGenericToolGenericToolItem — Show Correspondence Item","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/generic_tools/:generic_tool_id/generic_tool_items/:generic_tool_item_id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","generic_tools",":generic_tool_id","generic_tool_items",":generic_tool_item_id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"generic_tool_id","value":""},{"key":"generic_tool_item_id","value":""}]},"description":"Show Correspondence Item"}},{"id":"b28f0e4f-74f3-44c8-897f-cc370a9195e4","name":"updateProjectGenericToolGenericToolItem — Update Correspondence Item","request":{"method":"PATCH","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/generic_tools/:generic_tool_id/generic_tool_items/:generic_tool_item_id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","generic_tools",":generic_tool_id","generic_tool_items",":generic_tool_item_id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"generic_tool_id","value":""},{"key":"generic_tool_item_id","value":""}]},"description":"Update Correspondence Item"}},{"id":"3f888b57-5f62-4064-80d2-de3b1b12b382","name":"deleteProjectGenericToolGenericToolItem — Delete generic tool item","request":{"method":"DELETE","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/generic_tools/:generic_tool_id/generic_tool_items/:generic_tool_item_id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","generic_tools",":generic_tool_id","generic_tool_items",":generic_tool_item_id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"generic_tool_id","value":""},{"key":"generic_tool_item_id","value":""}]},"description":"Delete generic tool item"}},{"id":"832a2b82-629f-41ec-8bc1-e062cd4a10ba","name":"createProjectGenericToolGenericToolItemAttachment — Upload generic tool item attachment","request":{"method":"POST","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/generic_tools/:generic_tool_id/generic_tool_items/:generic_tool_item_id/attachments","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","generic_tools",":generic_tool_id","generic_tool_items",":generic_tool_item_id","attachments"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"generic_tool_id","value":""},{"key":"generic_tool_item_id","value":""}]},"description":"Upload generic tool item attachment"}},{"id":"336b4ac3-08c6-4c8f-87f4-7338f7f22162","name":"listProjectGenericToolGenericToolItemGenericToolItemResponses — List Item Responses","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/generic_tools/:generic_tool_id/generic_tool_items/:generic_tool_item_id/generic_tool_item_responses","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","generic_tools",":generic_tool_id","generic_tool_items",":generic_tool_item_id","generic_tool_item_responses"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"generic_tool_id","value":""},{"key":"generic_tool_item_id","value":""}]},"description":"List Item Responses"}},{"id":"1fec45d6-ca6f-482d-82de-f9a1103a8dbe","name":"createProjectGenericToolGenericToolItemGenericToolItemResponse — Create Item Response","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/generic_tools/:generic_tool_id/generic_tool_items/:generic_tool_item_id/generic_tool_item_responses","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","generic_tools",":generic_tool_id","generic_tool_items",":generic_tool_item_id","generic_tool_item_responses"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"generic_tool_id","value":""},{"key":"generic_tool_item_id","value":""}]},"description":"Create Item Response"}},{"id":"62db78d9-360a-410f-8381-05ffc2d4f68c","name":"listProjectRecycleBinCorrespondenceItems — Recycle Bin","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/recycle_bin/correspondence/items","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","recycle_bin","correspondence","items"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Recycle Bin"}},{"id":"a0bc4443-cc15-449f-8b1f-d8367d4b0ab4","name":"restoreProjectRecycleBinCorrespondenceItem — Restore correspondence from the recycle bin","request":{"method":"PATCH","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/recycle_bin/correspondence/items/:id/restore","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","recycle_bin","correspondence","items",":id","restore"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Restore correspondence from the recycle bin"}},{"id":"4dec72ea-e92e-4c31-8849-fea85b87b352","name":"listProjectRecycleBinIncidents — List recycled incidents","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/recycle_bin/incidents","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","recycle_bin","incidents"],"query":[{"key":"page","value":"1","disabled":true,"description":"Page number, starting at 1."},{"key":"per_page","value":"100","disabled":true,"description":"Records per page."}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"List recycled incidents\n\nRequires the `view` permission on the project's incidents tool. A scoped API token needs `incidents:read`."}},{"id":"5e7adc42-5025-4bff-8dee-9a166f3df02e","name":"restoreProjectRecycleBinIncident — Restore incident from the recycle bin","request":{"method":"PATCH","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/recycle_bin/incidents/:id/restore","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","recycle_bin","incidents",":id","restore"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Restore incident from the recycle bin"}}]},{"name":"CRM","description":"Module: crm","item":[{"id":"bcf1da05-3cc2-40f3-8dd8-2481b49d24b4","name":"listCompanyCrmActivities — List activities","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/crm/activities","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","crm","activities"],"query":[{"key":"search","value":"","disabled":true},{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true},{"key":"filters[status]","value":"","disabled":true,"description":"Comma-separated values: open, completed, overdue."},{"key":"filters[contact_id]","value":"","disabled":true,"description":"Comma-separated IDs."},{"key":"filters[opportunity_id]","value":"","disabled":true,"description":"Comma-separated IDs."},{"key":"filters[owner_id]","value":"","disabled":true,"description":"Comma-separated IDs."}],"variable":[{"key":"company_id","value":"{{companyId}}"}]},"description":"List activities\n\nCompany administrators or explicit company CRM grantees only. Read-only grants allow view; standard grants allow view/create/edit. Company intake lists remain preproject records only. Project permissions are separate."}},{"id":"c6f4e890-acf1-4858-87f1-17d8c4526f4f","name":"createCompanyCrmActivity — Create activity","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/crm/activities","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","crm","activities"],"variable":[{"key":"company_id","value":"{{companyId}}"}]},"description":"Create activity\n\nCompany administrators or explicit company CRM grantees only. Read-only grants allow view; standard grants allow view/create/edit. Company intake lists remain preproject records only. Project permissions are separate.","body":{"mode":"raw","raw":"{\n  \"activity\": {\n    \"title\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"de2dc7d2-78a1-449d-8e3c-8ccaa9667126","name":"listCompanyCrmActivitiesCalendar — Download open company intake CRM follow-ups as an iCalendar file","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/crm/activities/calendar","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","crm","activities","calendar"],"query":[{"key":"search","value":"","disabled":true},{"key":"filters[status]","value":"","disabled":true,"description":"Comma-separated values: open, overdue. Completed follow-ups are never exported."},{"key":"filters[contact_id]","value":"","disabled":true,"description":"Comma-separated IDs."},{"key":"filters[opportunity_id]","value":"","disabled":true,"description":"Comma-separated IDs."},{"key":"filters[owner_id]","value":"","disabled":true,"description":"Comma-separated IDs."}],"variable":[{"key":"company_id","value":"{{companyId}}"}]},"description":"Download open company intake CRM follow-ups as an iCalendar file\n\nRequires Company CRM view and crm:read. Returns open, unarchived follow-ups with a due date as RFC 5545 VEVENTs (CRLF lines folded at 75 octets, UID crm-activity-<id>@os.construction). Date-only due dates are all-day events; other due instants are UTC. Events carry the title, related contact and opportunity names and a link back to the record, never notes. Takes the list's search and filters; at most 1000 events, earliest due first."}},{"id":"8f15e713-6cb1-48a9-8d0f-2938ce640b88","name":"getCompanyCrmActivity — Get CRM follow-up","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/crm/activities/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","crm","activities",":id"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Get CRM follow-up\n\nSame access as the activity list. Archived follow-ups remain readable by id with archived_at set."}},{"id":"56907bce-05be-49bd-892f-9dc44110b34f","name":"updateCompanyCrmActivity — Edit an open CRM follow-up using its current updated_at value","request":{"method":"PATCH","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/crm/activities/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","crm","activities",":id"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Edit an open CRM follow-up using its current updated_at value\n\nOnly open follow-ups can be edited. The resulting contact, opportunity and owner must remain in the current CRM scope. A stale updated_at or completed activity returns 409. An unchanged patch returns the existing record without a history event.","body":{"mode":"raw","raw":"{\n  \"activity\": {\n    \"updated_at\": \"2026-01-31T12:00:00Z\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"c1441581-4eca-4776-8407-24c466d3c460","name":"deleteCompanyCrmActivity — Archive CRM follow-up","request":{"method":"DELETE","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/crm/activities/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","crm","activities",":id"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Archive CRM follow-up\n\nSoft archive. Company administrators or standard company CRM grantees, as for PATCH. The follow-up stays readable by id (archived_at set) and in history, but leaves lists, summaries, forecasts, cohorts and exports, and can no longer be edited or newly linked. Repeating the request is a no-op. Records an archived history entry."}},{"id":"017ef367-d1e2-42d8-860b-2f0abca71b80","name":"completeCompanyCrmActivity — Complete follow-up idempotently","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/crm/activities/:id/complete","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","crm","activities",":id","complete"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Complete follow-up idempotently\n\nCompany administrators or explicit company CRM grantees only. Read-only grants allow view; standard grants allow view/create/edit. Company intake lists remain preproject records only. Project permissions are separate."}},{"id":"983ed6f9-6878-4b3b-8c29-2362e718b9a5","name":"listCompanyCrmActivityHistory — Read retained company intake history for scoped CRM record","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/crm/activities/:id/history","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","crm","activities",":id","history"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Read retained company intake history for scoped CRM record"}},{"id":"fbf425e5-ebdf-4016-887e-38fe51418e5e","name":"restoreCompanyCrmActivity — Restore archived CRM follow-up","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/crm/activities/:id/restore","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","crm","activities",":id","restore"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Restore archived CRM follow-up\n\nClears archived_at so the follow-up returns to lists, summaries and the action center. Company CRM edit grant and crm:write, as for DELETE. Repeating the request, or restoring an active record, is a no-op. Records a restored history entry."}},{"id":"d20f6d2d-73dd-415f-8506-6cf814fb19d7","name":"createCompanyCrmContactImport — Commit a reviewed create-only company contact import","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/crm/contact_imports","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","crm","contact_imports"],"variable":[{"key":"company_id","value":"{{companyId}}"}]},"description":"Commit a reviewed create-only company contact import\n\nRequires company CRM create and crm:write. All rows create atomically under a company lock. Any invalid or already-linked external ID rejects the batch. Possible name/email duplicates require explicit acknowledgement and create distinct contacts; no automatic merge or update occurs. Exact request-key replay returns the prior receipt without creating contacts again.","body":{"mode":"raw","raw":"{\n  \"import\": {\n    \"accept_duplicate_suggestions\": false,\n    \"csv\": \"\",\n    \"mapping\": {\n      \"external_id\": \"\",\n      \"first_name\": \"\",\n      \"last_name\": \"\"\n    },\n    \"request_key\": \"\",\n    \"review_sha256\": \"\",\n    \"source_key\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"34f4fbdb-e521-42b7-88ce-6388bd6b733b","name":"createCompanyCrmContactImportsPreview — Preview a bounded create-only company contact import","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/crm/contact_imports/preview","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","crm","contact_imports","preview"],"variable":[{"key":"company_id","value":"{{companyId}}"}]},"description":"Preview a bounded create-only company contact import\n\nRequires company CRM create and crm:write. Maps explicit CSV headers, checks every row and source external ID, and suggests possible intake contact duplicates without merging. The SHA-256 review digest binds the CSV, mapping, row validation and candidate interpretation. No CSV is persisted.","body":{"mode":"raw","raw":"{\n  \"import\": {\n    \"csv\": \"\",\n    \"mapping\": {\n      \"external_id\": \"\",\n      \"first_name\": \"\",\n      \"last_name\": \"\"\n    },\n    \"source_key\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"89f3c5cc-6833-40df-8eec-212cd0804345","name":"getCompanyCrmContactImport — Read a company contact import receipt","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/crm/contact_imports/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","crm","contact_imports",":id"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Read a company contact import receipt\n\nRequires company CRM view and crm:read. Returns row numbers and created contact IDs, without retaining or returning the CSV."}},{"id":"7e26d2a6-f42a-4e6d-8351-cc63b508e560","name":"listCompanyCrmContacts — List contacts","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/crm/contacts","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","crm","contacts"],"query":[{"key":"search","value":"","disabled":true},{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true},{"key":"filters[relationship]","value":"","disabled":true,"description":"Comma-separated values: lead, client, partner, subcontractor."},{"key":"filters[owner_id]","value":"","disabled":true,"description":"Comma-separated IDs."}],"variable":[{"key":"company_id","value":"{{companyId}}"}]},"description":"List contacts\n\nCompany administrators or explicit company CRM grantees only. Read-only grants allow view; standard grants allow view/create/edit. Company intake lists remain preproject records only. Project permissions are separate."}},{"id":"311207e7-e55b-424a-8090-edd13e3e045e","name":"createCompanyCrmContact — Create contact","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/crm/contacts","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","crm","contacts"],"variable":[{"key":"company_id","value":"{{companyId}}"}]},"description":"Create contact\n\nCompany administrators or explicit company CRM grantees only. Read-only grants allow view; standard grants allow view/create/edit. Company intake lists remain preproject records only. Project permissions are separate.","body":{"mode":"raw","raw":"{\n  \"contact\": {\n    \"first_name\": \"\",\n    \"last_name\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"58647635-c28d-4e07-8f59-11a78896f5dd","name":"listCompanyCrmContactsDuplicates — Find likely duplicate contacts","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/crm/contacts/duplicates","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","crm","contacts","duplicates"],"query":[{"key":"email","value":"","disabled":true},{"key":"first_name","value":"","disabled":true},{"key":"last_name","value":"","disabled":true},{"key":"organization","value":"","disabled":true}],"variable":[{"key":"company_id","value":"{{companyId}}"}]},"description":"Find likely duplicate contacts\n\nAdvisory check before creating a company intake contact. Returns up to 10 active contacts in the same scope with the same email (case-insensitive), or the same first and last name and organization (case-insensitive; a blank organization matches contacts without one). Contact create never blocks on duplicates. Requires CRM view permission and crm:read."}},{"id":"db3074a3-c138-4732-8b2a-7cc9f8a1dab8","name":"listCompanyCrmContactsExport — Export one audited page of company intake contacts as CSV","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/crm/contacts/export","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","crm","contacts","export"],"query":[{"key":"after_id","value":"","disabled":true,"description":"Return intake contacts with greater IDs. Requires snapshot_max_id when greater than zero."},{"key":"snapshot_max_id","value":"","disabled":true,"description":"First response X-CRM-Export-Snapshot-Max-ID; caps later pages to the initial ID high-water mark."}],"variable":[{"key":"company_id","value":"{{companyId}}"}]},"description":"Export one audited page of company intake contacts as CSV\n\nRequires company CRM view and crm:read. Exports only contacts still in company intake, never project-associated contacts or notes. Each page contains at most 500 rows and a repeated header. The first page captures an ID high-water mark; subsequent requests pass that snapshot_max_id and next after_id. Edits or reassociations between pages are not frozen. Formula-like cells are prefixed with an apostrophe. Each successful page writes a company CRM intake audit event, and CSV data is not persisted."}},{"id":"7b307c46-bf39-4321-82e1-1326ddf39bb5","name":"getCompanyCrmContact — Get contact","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/crm/contacts/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","crm","contacts",":id"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Get contact\n\nCompany administrators or explicit company CRM grantees only. Read-only grants allow view; standard grants allow view/create/edit. Company intake lists remain preproject records only. Project permissions are separate."}},{"id":"9a4ed7d4-4e0a-41a8-89b4-b5c47167dbe9","name":"updateCompanyCrmContact — Update contact","request":{"method":"PATCH","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/crm/contacts/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","crm","contacts",":id"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Update contact\n\nCompany administrators or explicit company CRM grantees only. Read-only grants allow view; standard grants allow view/create/edit. Company intake lists remain preproject records only. Project permissions are separate.","body":{"mode":"raw","raw":"{\n  \"contact\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"5810d4a8-194b-4a88-88a7-6a33867989dd","name":"deleteCompanyCrmContact — Archive CRM contact","request":{"method":"DELETE","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/crm/contacts/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","crm","contacts",":id"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Archive CRM contact\n\nSoft archive. Company administrators or standard company CRM grantees, as for PATCH. The contact stays readable by id (archived_at set) and in history, but leaves lists, summaries, forecasts, cohorts and exports, and can no longer be edited or newly linked. Repeating the request is a no-op. Records an archived history entry."}},{"id":"f4163ac7-61ce-4025-8759-c54f3118cf91","name":"associateCompanyCrmContact — Associate reviewed intake aggregate to existing project","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/crm/contacts/:id/associate","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","crm","contacts",":id","associate"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Associate reviewed intake aggregate to existing project\n\nAtomic transfer preserving IDs and intake history. Contact association includes all linked opportunities and activities. Individual opportunity association requires no linked contact. Every owner must be an active destination project member or administrator. Already assigned records return 404.","body":{"mode":"raw","raw":"{\n  \"association\": {\n    \"project_id\": 0\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"309cbde3-beee-495b-87a6-d002a1a7de6b","name":"listCompanyCrmContactAssociationPreview — Preview aggregate record counts before association","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/crm/contacts/:id/association_preview","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","crm","contacts",":id","association_preview"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Preview aggregate record counts before association"}},{"id":"f8ad930d-caf2-4a86-85d9-50eceb18f074","name":"listCompanyCrmContactHistory — Read retained company intake history for scoped CRM record","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/crm/contacts/:id/history","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","crm","contacts",":id","history"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Read retained company intake history for scoped CRM record"}},{"id":"50634d92-427c-4501-8258-4516339acaca","name":"mergeCompanyCrmContact — Merge a duplicate contact into another","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/crm/contacts/:id/merge","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","crm","contacts",":id","merge"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Merge a duplicate contact into another\n\nMoves the source contact's opportunities, activities, service cases, import references and converted inquiry links to target_id (an active contact in the same scope), fills the target's empty organization, email, phone, role, source, notes and owner from the source, then archives the source. One locked transaction; history records a merged entry on the source and an updated entry on the target. Same permission as archive (CRM edit) and crm:write. A source with customer responses, offers, authority evidence, portal grants, invitations or service requests is refused with 409; merge in the other direction instead. The master person link is not copied.","body":{"mode":"raw","raw":"{\n  \"merge\": {\n    \"target_id\": 0\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"e26fddb3-5b6a-4ce8-845c-00c1a6ce4b55","name":"listCompanyCrmContactPerson — Get explicit master person link","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/crm/contacts/:id/person","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","crm","contacts",":id","person"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Get explicit master person link"}},{"id":"d59887ba-7438-42a6-8b80-a91ffd1dd89c","name":"personCompanyCrmContact — Link contact to master person","request":{"method":"PUT","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/crm/contacts/:id/person","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","crm","contacts",":id","person"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Link contact to master person","body":{"mode":"raw","raw":"{\n  \"person_link\": {\n    \"person_id\": 0\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"4e53a98d-428c-4ad0-891c-9dc23757670c","name":"deletePersonCompanyCrmContact — Unlink contact from master person","request":{"method":"DELETE","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/crm/contacts/:id/person","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","crm","contacts",":id","person"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Unlink contact from master person"}},{"id":"2d2d11e3-9395-4b04-8df1-da4c8c8f7018","name":"restoreCompanyCrmContact — Restore archived CRM contact","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/crm/contacts/:id/restore","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","crm","contacts",":id","restore"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Restore archived CRM contact\n\nClears archived_at so the contact returns to lists, summaries and exports. Company CRM edit grant and crm:write, as for DELETE. Repeating the request, or restoring an active record, is a no-op. Records a restored history entry."}},{"id":"23bdc377-345d-42cc-8ed4-76266b923ebc","name":"listCompanyCrmForecast — Current advisory opportunity forecast and observable stage aging","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/crm/forecast","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","crm","forecast"],"variable":[{"key":"company_id","value":"{{companyId}}"}]},"description":"Current advisory opportunity forecast and observable stage aging\n\nAmounts are CRM estimates, not financial commitments. as_of is server UTC report time. Stage age is observed only from new creates or recorded transitions; migration baseline has unknown age."}},{"id":"1afd09c8-6dde-45a6-80fd-ddc7395c50ba","name":"listCompanyCrmGrowthCohorts — Current-state opportunity outcome cohorts by UTC creation month and staff-attributed source","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/crm/growth_cohorts","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","crm","growth_cohorts"],"query":[{"key":"months","value":"","disabled":true}],"variable":[{"key":"company_id","value":"{{companyId}}"}]},"description":"Current-state opportunity outcome cohorts by UTC creation month and staff-attributed source\n\nRows are grouped by opportunity creation month and current source/stage at as_of, not historical month-end snapshots. Open pursuits are excluded from the decided win-rate denominator. Source is staff-attributed, not a verified acquisition channel. CRM estimates are not revenue."}},{"id":"b5420d50-58f0-407b-809d-0623290081f6","name":"listCompanyCrmLeadForms — List company lead intake forms","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/crm/lead_forms","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","crm","lead_forms"],"variable":[{"key":"company_id","value":"{{companyId}}"}]},"description":"List company lead intake forms\n\nCompany CRM administrators only. Public tokens are never listed."}},{"id":"92def0b7-bafe-4272-83dc-1ba922753289","name":"createCompanyCrmLeadForm — Create company lead intake form","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/crm/lead_forms","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","crm","lead_forms"],"variable":[{"key":"company_id","value":"{{companyId}}"}]},"description":"Create company lead intake form\n\nCompany CRM administrator only. Returns the raw public token once; store the link securely.","body":{"mode":"raw","raw":"{\n  \"form\": {\n    \"title\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"2853447b-e56b-47eb-8abf-66dbe43ba3d7","name":"updateCompanyCrmLeadForm — Update or deactivate lead intake form","request":{"method":"PATCH","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/crm/lead_forms/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","crm","lead_forms",":id"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Update or deactivate lead intake form\n\nCompany CRM administrator only. Deactivation permanently revokes the current token; reactivate only by rotating to a fresh token.","body":{"mode":"raw","raw":"{\n  \"form\": {\n    \"expected_version\": 0\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"399bb70c-81c3-41ac-883b-6ff090d9c55c","name":"rotateCompanyCrmLeadForm — Rotate lead intake form public token","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/crm/lead_forms/:id/rotate","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","crm","lead_forms",":id","rotate"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Rotate lead intake form public token\n\nCompany CRM administrator only. Revokes the prior link permanently and returns the replacement only once."}},{"id":"4cf34f4d-a917-49c0-8d11-3f33294f9636","name":"listCompanyCrmLeadInquiries — List private company lead inquiries","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/crm/lead_inquiries","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","crm","lead_inquiries"],"query":[{"key":"status","value":"","disabled":true},{"key":"queue","value":"","disabled":true,"description":"Private triage view; overdue means an open inquiry past its response target without a valid staff-reported response. needs_reassignment shows open inquiries assigned to a member no longer eligible for company CRM review."},{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true}],"variable":[{"key":"company_id","value":"{{companyId}}"}]},"description":"List private company lead inquiries\n\nRequires company CRM view access and crm:read. Anonymous submissions never become contacts automatically. Queue filters are private and evaluated with current server time; results have Total, Per-Page and Link headers. Offset is bounded to 10,000; large tenants will need a future cursor path."}},{"id":"4853ad51-b3d6-40f2-82b3-c668a6be3c85","name":"listCompanyCrmLeadInquiriesAssignableMembers — List eligible company inquiry reviewers","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/crm/lead_inquiries/assignable_members","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","crm","lead_inquiries","assignable_members"],"query":[{"key":"search","value":"","disabled":true},{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true}],"variable":[{"key":"company_id","value":"{{companyId}}"}]},"description":"List eligible company inquiry reviewers\n\nPrivate company CRM view. Paged, literal-name search of active company administrators or members with a current Standard company CRM grant; does not grant those members new access."}},{"id":"ae67e1e2-64c2-4379-81ad-e611821b48ce","name":"getCompanyCrmLeadInquiry — Show private lead inquiry","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/crm/lead_inquiries/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","crm","lead_inquiries",":id"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Show private lead inquiry"}},{"id":"a3ba9249-7293-450e-8705-2b2ab8b0e295","name":"listCompanyCrmLeadInquiryConversionPreview — Preview lead inquiry conversion and possible duplicates","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/crm/lead_inquiries/:id/conversion_preview","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","crm","lead_inquiries",":id","conversion_preview"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Preview lead inquiry conversion and possible duplicates\n\nRequires current company CRM view access. Duplicate candidates are suggestions, never automatic merges."}},{"id":"df75a723-d11a-4ac6-8433-ccce795c29f9","name":"convertCompanyCrmLeadInquiry — Convert reviewed inquiry to company CRM contact and optional opportunity","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/crm/lead_inquiries/:id/convert","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","crm","lead_inquiries",":id","convert"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Convert reviewed inquiry to company CRM contact and optional opportunity\n\nRequires company CRM create access and crm:write. Rechecks the review digest, preserves provenance, and never silently merges duplicates.","body":{"mode":"raw","raw":"{\n  \"conversion\": {\n    \"acknowledge_duplicates\": false,\n    \"review_sha256\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"b77f1081-5ec0-4426-8972-a5d8a0b03c7a","name":"createCompanyCrmLeadInquiryDismiss — Dismiss a private lead inquiry with reason","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/crm/lead_inquiries/:id/dismiss","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","crm","lead_inquiries",":id","dismiss"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Dismiss a private lead inquiry with reason\n\nRequires company CRM edit access and crm:write; preserves the submitted inquiry and staff decision.","body":{"mode":"raw","raw":"{\n  \"dismissal\": {\n    \"expected_version\": 0,\n    \"reason\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"88e4e7f6-6ea1-4267-8d4f-06e79d6917aa","name":"createCompanyCrmLeadInquiryResponse — Record a staff-reported customer response","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/crm/lead_inquiries/:id/responses","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","crm","lead_inquiries",":id","responses"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Record a staff-reported customer response\n\nRequires company CRM edit and crm:write. This is a manual report with an immutable private event, not evidence that the app sent or delivered communication.","body":{"mode":"raw","raw":"{\n  \"response\": {\n    \"channel\": \"phone\",\n    \"expected_version\": 0,\n    \"summary\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"2f85bab9-32ca-4a67-8d1d-4db5ecae0346","name":"voidCompanyCrmLeadInquiryResponse — Void a mistaken staff-reported response","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/crm/lead_inquiries/:id/responses/:response_event_id/void","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","crm","lead_inquiries",":id","responses",":response_event_id","void"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""},{"key":"response_event_id","value":""}]},"description":"Void a mistaken staff-reported response\n\nRequires company CRM edit and crm:write. Retains the original report and an append-only correction reason; recomputes the inquiry's first staff-reported response time.","body":{"mode":"raw","raw":"{\n  \"void\": {\n    \"expected_version\": 0,\n    \"reason\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"f77d49f5-7934-4e20-8402-f2380f3e5d28","name":"triageCompanyCrmLeadInquiry — Assign and prioritize an unhandled inquiry","request":{"method":"PATCH","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/crm/lead_inquiries/:id/triage","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","crm","lead_inquiries",":id","triage"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Assign and prioritize an unhandled inquiry\n\nRequires company CRM edit and crm:write. An exact inquiry version is required; assignment and response target changes are retained as private events.","body":{"mode":"raw","raw":"{\n  \"triage\": {\n    \"expected_version\": 0\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"20468d1d-52c1-4bfc-84a1-2a5b11c6a6f6","name":"listCompanyCrmLeadInquiryTriageEvents — List private inquiry triage and response history","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/crm/lead_inquiries/:id/triage_events","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","crm","lead_inquiries",":id","triage_events"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"List private inquiry triage and response history\n\nRequires company CRM view and crm:read. Results are paginated newest first; response text remains private."}},{"id":"d176ab8b-218d-4c1b-8ea3-bba53f49e556","name":"listCompanyCrmMembers — List company members and explicit CRM grants","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/crm/members","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","crm","members"],"query":[{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true},{"key":"search","value":"","disabled":true}],"variable":[{"key":"company_id","value":"{{companyId}}"}]},"description":"List company members and explicit CRM grants\n\nCompany administrators only, with admin:read token scope. Includes inactive members; inactive grants never authorize access. Reactivation restores retained grants unless revoked. Effective level reflects workspace read-only status."}},{"id":"0db98699-64e9-482c-857b-790e654460b5","name":"replaceCompanyCrmMember — Set or revoke explicit company CRM grant","request":{"method":"PUT","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/crm/members/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","crm","members",":id"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Set or revoke explicit company CRM grant\n\nCompany administrators only, with admin:write token scope. read_only=view; standard=view/create/edit; none deletes the grant. No project permission changes. New grants require active same-company non-admin member; revocation also allowed for inactive members. Workspace read-only blocks mutation except super-admin exemption. Grant changes and durable journal are atomic.","body":{"mode":"raw","raw":"{\n  \"crm_grant\": {\n    \"level\": \"none\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"75f73852-0409-444e-84ae-d425de8e477c","name":"updateCompanyCrmMember — Set or revoke explicit company CRM grant","request":{"method":"PATCH","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/crm/members/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","crm","members",":id"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Set or revoke explicit company CRM grant\n\nCompany administrators only, with admin:write token scope. read_only=view; standard=view/create/edit; none deletes the grant. No project permission changes. New grants require active same-company non-admin member; revocation also allowed for inactive members. Workspace read-only blocks mutation except super-admin exemption. Grant changes and durable journal are atomic.","body":{"mode":"raw","raw":"{\n  \"crm_grant\": {\n    \"level\": \"none\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"6afb3bcf-d8d6-4e63-843c-0d2920a2e927","name":"listCompanyCrmMemberHistory — Read durable company CRM grant change history","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/crm/members/:id/history","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","crm","members",":id","history"],"query":[{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true}],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Read durable company CRM grant change history\n\nCompany administrators only, with admin:read token scope. Journal remains after grant revocation."}},{"id":"f0919fa9-ee6c-4127-8621-9305b7c4c0ab","name":"listCompanyCrmOpportunities — List opportunities","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/crm/opportunities","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","crm","opportunities"],"query":[{"key":"search","value":"","disabled":true},{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true},{"key":"filters[stage]","value":"","disabled":true,"description":"Comma-separated values: qualification, site_visit, estimating, proposal, negotiation, won, lost."},{"key":"filters[contact_id]","value":"","disabled":true,"description":"Comma-separated IDs."},{"key":"filters[owner_id]","value":"","disabled":true,"description":"Comma-separated IDs."}],"variable":[{"key":"company_id","value":"{{companyId}}"}]},"description":"List opportunities\n\nCompany administrators or explicit company CRM grantees only. Read-only grants allow view; standard grants allow view/create/edit. Company intake lists remain preproject records only. Project permissions are separate."}},{"id":"9eaaefd9-b46e-4499-8d12-dd0ee2081ef6","name":"createCompanyCrmOpportunity — Create opportunity","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/crm/opportunities","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","crm","opportunities"],"variable":[{"key":"company_id","value":"{{companyId}}"}]},"description":"Create opportunity\n\nCompany administrators or explicit company CRM grantees only. Read-only grants allow view; standard grants allow view/create/edit. Company intake lists remain preproject records only. Project permissions are separate.","body":{"mode":"raw","raw":"{\n  \"opportunity\": {\n    \"title\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"3a83f0cb-25e7-4040-8205-a96fccf01117","name":"getCompanyCrmOpportunity — Get opportunity","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/crm/opportunities/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","crm","opportunities",":id"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Get opportunity\n\nCompany administrators or explicit company CRM grantees only. Read-only grants allow view; standard grants allow view/create/edit. Company intake lists remain preproject records only. Project permissions are separate."}},{"id":"3cdfe0cf-f62e-4679-8d7f-7786fdb3e05b","name":"updateCompanyCrmOpportunity — Update opportunity","request":{"method":"PATCH","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/crm/opportunities/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","crm","opportunities",":id"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Update opportunity\n\nCompany administrators or explicit company CRM grantees only. Read-only grants allow view; standard grants allow view/create/edit. Company intake lists remain preproject records only. Project permissions are separate.","body":{"mode":"raw","raw":"{\n  \"opportunity\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"e66f0a24-b4af-4e50-83a0-23d41fca36d2","name":"deleteCompanyCrmOpportunity — Archive CRM opportunity","request":{"method":"DELETE","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/crm/opportunities/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","crm","opportunities",":id"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Archive CRM opportunity\n\nSoft archive. Company administrators or standard company CRM grantees, as for PATCH. The opportunity stays readable by id (archived_at set) and in history, but leaves lists, summaries, forecasts, cohorts and exports, and can no longer be edited or newly linked. Repeating the request is a no-op. Records an archived history entry."}},{"id":"065e1305-09ee-4746-8646-5f48945c1c65","name":"associateCompanyCrmOpportunity — Associate reviewed intake aggregate to existing project","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/crm/opportunities/:id/associate","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","crm","opportunities",":id","associate"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Associate reviewed intake aggregate to existing project\n\nAtomic transfer preserving IDs and intake history. Contact association includes all linked opportunities and activities. Individual opportunity association requires no linked contact. Every owner must be an active destination project member or administrator. Already assigned records return 404.","body":{"mode":"raw","raw":"{\n  \"association\": {\n    \"project_id\": 0\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"890cfecb-5859-4f6a-827c-a6ca91046576","name":"listCompanyCrmOpportunityAssociationPreview — Preview aggregate record counts before association","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/crm/opportunities/:id/association_preview","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","crm","opportunities",":id","association_preview"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Preview aggregate record counts before association"}},{"id":"8cbdde99-4652-479d-869f-9cee5df1257a","name":"createProjectCompanyCrmOpportunity — Create one project from explicitly reviewed Won opportunity","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/crm/opportunities/:id/create_project","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","crm","opportunities",":id","create_project"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Create one project from explicitly reviewed Won opportunity\n\nActive same-company administrators only, including retries. Requires both crm:write and admin:write token grants. First create201, identical normalized retry200. Persisted source opportunity mapping prevents duplicates, even concurrent retries. Different reviewed request409. Copies normal project defaults/template team and settings. All reviewed contact-linked pursuits move regardless of sibling stage. No opportunity estimate is promoted into a budget or contract.","body":{"mode":"raw","raw":"{\n  \"handoff\": {\n    \"accept_related_opportunities\": null,\n    \"project\": {\n      \"name\": \"\"\n    },\n    \"review_token\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"78cf822d-9f3a-44cd-868f-6b8502f864c6","name":"listCompanyCrmOpportunityForecastHistory — Paginated immutable opportunity forecast input history","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/crm/opportunities/:id/forecast_history","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","crm","opportunities",":id","forecast_history"],"query":[{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true}],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Paginated immutable opportunity forecast input history\n\nMigration baseline records deployment-time state, not historical transitions. Only scoped CRM readers can view events. page and per_page paginate newest first, maximum 100 rows."}},{"id":"a3f0162c-bc0f-4a88-8783-83ca338f5830","name":"listCompanyCrmOpportunityHistory — Read retained company intake history for scoped CRM record","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/crm/opportunities/:id/history","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","crm","opportunities",":id","history"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Read retained company intake history for scoped CRM record"}},{"id":"dfaaa55a-9648-46bc-8440-55214f6f0c8f","name":"listCompanyCrmOpportunityProjectHandoff — Recover the prior project receipt after source leaves intake","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/crm/opportunities/:id/project_handoff","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","crm","opportunities",":id","project_handoff"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Recover the prior project receipt after source leaves intake\n\nReturns receipt or null. Requires company CRM view plus current destination project CRM view and enabled tool; company access alone does not reveal moved-project receipts."}},{"id":"b00a954f-879b-43ad-8dd5-42beafcc0107","name":"listCompanyCrmOpportunityProjectHandoffPreview — Review Won opportunity and every related record moved into a new project","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/crm/opportunities/:id/project_handoff_preview","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","crm","opportunities",":id","project_handoff_preview"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Review Won opportunity and every related record moved into a new project\n\nActive same-company administrators only; a company CRM member grant does not permit new-project preview."}},{"id":"b89477fb-ff22-4c32-8b02-dda84b290892","name":"restoreCompanyCrmOpportunity — Restore archived CRM opportunity","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/crm/opportunities/:id/restore","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","crm","opportunities",":id","restore"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Restore archived CRM opportunity\n\nClears archived_at so the opportunity returns to lists, summaries, forecasts and cohorts. Company CRM edit grant and crm:write, as for DELETE. Repeating the request, or restoring an active record, is a no-op. Records a restored history entry."}},{"id":"2914f300-f17f-456d-872f-f76e7e272a0f","name":"listCompanyCrmOpportunitySourceHistory — Paginated staff-attributed opportunity source history","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/crm/opportunities/:id/source_history","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","crm","opportunities",":id","source_history"],"query":[{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true}],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Paginated staff-attributed opportunity source history\n\nBackfilled legacy opportunities begin with an unknown baseline; corrections preserve before/after values and staff reason. Requires current CRM scope access."}},{"id":"72ecd76c-df2b-44aa-8f19-5cb37d559f0c","name":"listCompanyCrmOrganizations — List CRM organizations","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/crm/organizations","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","crm","organizations"],"query":[{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true},{"key":"search","value":"","disabled":true}],"variable":[{"key":"company_id","value":"{{companyId}}"}]},"description":"List CRM organizations"}},{"id":"d553accd-3523-407d-809b-c4bc010364c8","name":"createCompanyCrmOrganization — Create CRM organization","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/crm/organizations","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","crm","organizations"],"variable":[{"key":"company_id","value":"{{companyId}}"}]},"description":"Create CRM organization","body":{"mode":"raw","raw":"{\n  \"organization\": {\n    \"name\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"9bc0edbb-9264-4bb7-8d26-df5eef1a112d","name":"getCompanyCrmOrganization — Get CRM organization","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/crm/organizations/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","crm","organizations",":id"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Get CRM organization"}},{"id":"651a25ce-ce63-4577-84a3-8e3775db71a8","name":"updateCompanyCrmOrganization — Update CRM organization","request":{"method":"PATCH","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/crm/organizations/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","crm","organizations",":id"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Update CRM organization","body":{"mode":"raw","raw":"{\n  \"organization\": {\n    \"name\": \"\",\n    \"notes\": \"\",\n    \"phone\": \"\",\n    \"website\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"7724fb6e-2a22-4885-8577-799453c5bd09","name":"listCompanyCrmOrganizationAliases — List identities resolved to this canonical identity","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/crm/organizations/:id/aliases","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","crm","organizations",":id","aliases"],"query":[{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true}],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"List identities resolved to this canonical identity"}},{"id":"6ad6d59f-3b5b-434d-831b-6a9feb5ff393","name":"listCompanyCrmOrganizationDuplicateCandidates — Suggest possible duplicate identities; review required","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/crm/organizations/:id/duplicate_candidates","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","crm","organizations",":id","duplicate_candidates"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Suggest possible duplicate identities; review required"}},{"id":"59ca7622-1b41-4963-8934-86a8102ad66e","name":"listCompanyCrmOrganizationHistory — List organization history","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/crm/organizations/:id/history","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","crm","organizations",":id","history"],"query":[{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true}],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"List organization history"}},{"id":"dc719dba-fcc8-4096-81e8-7f6d5f85c148","name":"listCompanyCrmOrganizationPeople — List organization people","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/crm/organizations/:id/people","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","crm","organizations",":id","people"],"query":[{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true}],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"List organization people"}},{"id":"23fd0870-6d88-4764-881d-350a4d4d7214","name":"listCompanyCrmOrganizationProjects — List visible organization project roles","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/crm/organizations/:id/projects","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","crm","organizations",":id","projects"],"query":[{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true}],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"List visible organization project roles"}},{"id":"e6b29a54-daa4-4dc4-8428-308fd98744aa","name":"createCompanyCrmOrganizationProject — Add organization project role","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/crm/organizations/:id/projects","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","crm","organizations",":id","projects"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Add organization project role","body":{"mode":"raw","raw":"{\n  \"project_role\": {\n    \"project_id\": 0,\n    \"role\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"f37e9530-6196-4724-894b-1f6207723398","name":"deleteCompanyCrmOrganizationProject — Remove organization project role","request":{"method":"DELETE","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/crm/organizations/:id/projects/:role_id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","crm","organizations",":id","projects",":role_id"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""},{"key":"role_id","value":""}]},"description":"Remove organization project role"}},{"id":"56791e8d-57ed-4173-8a3e-305b26e2b163","name":"resolutionCompanyCrmOrganization — Resolve duplicate to canonical identity","request":{"method":"PUT","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/crm/organizations/:id/resolution","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","crm","organizations",":id","resolution"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Resolve duplicate to canonical identity","body":{"mode":"raw","raw":"{\n  \"resolution\": {\n    \"canonical_id\": 0,\n    \"review_token\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"e61f18f2-6803-47a2-8677-e26688e2341d","name":"deleteResolutionCompanyCrmOrganization — Undo duplicate resolution","request":{"method":"DELETE","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/crm/organizations/:id/resolution","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","crm","organizations",":id","resolution"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Undo duplicate resolution","body":{"mode":"raw","raw":"{\n  \"resolution\": {\n    \"review_token\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"db998332-ae48-44f7-834e-f44844a93162","name":"listCompanyCrmOrganizationResolutionPreview — Preview reversible duplicate resolution","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/crm/organizations/:id/resolution_preview","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","crm","organizations",":id","resolution_preview"],"query":[{"key":"canonical_id","value":"","disabled":false}],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Preview reversible duplicate resolution"}},{"id":"2f43912d-124d-480a-8f72-f90c3e13db9c","name":"listCompanyCrmOrganizationTimeline — List explicit organization affiliations, visible project roles and identity events","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/crm/organizations/:id/timeline","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","crm","organizations",":id","timeline"],"query":[{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true}],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"List explicit organization affiliations, visible project roles and identity events"}},{"id":"667d225c-25fa-486f-8b42-fe344fec0d6a","name":"listCompanyCrmPeople — List CRM people","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/crm/people","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","crm","people"],"query":[{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true},{"key":"search","value":"","disabled":true}],"variable":[{"key":"company_id","value":"{{companyId}}"}]},"description":"List CRM people"}},{"id":"12bc067f-7173-4f1f-8337-ccf948184d75","name":"createCompanyCrmPeople — Create CRM person","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/crm/people","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","crm","people"],"variable":[{"key":"company_id","value":"{{companyId}}"}]},"description":"Create CRM person","body":{"mode":"raw","raw":"{\n  \"person\": {\n    \"first_name\": \"\",\n    \"last_name\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"b6a60aa3-1442-45e2-85eb-a4b6e9b786f1","name":"getCompanyCrmPeople — Get CRM person","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/crm/people/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","crm","people",":id"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Get CRM person"}},{"id":"05c45464-ff30-458f-8c99-34d559f8418e","name":"updateCompanyCrmPeople — Update CRM person","request":{"method":"PATCH","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/crm/people/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","crm","people",":id"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Update CRM person","body":{"mode":"raw","raw":"{\n  \"person\": {\n    \"email\": \"\",\n    \"first_name\": \"\",\n    \"last_name\": \"\",\n    \"notes\": \"\",\n    \"phone\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"ac13a2ca-258e-4b52-805f-16744b1c5210","name":"listCompanyCrmPeopleAffiliations — List person affiliations","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/crm/people/:id/affiliations","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","crm","people",":id","affiliations"],"query":[{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true}],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"List person affiliations"}},{"id":"850c6dd5-5312-45c8-89dd-4cfa3a839e5f","name":"createCompanyCrmPeopleAffiliation — Add person affiliation","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/crm/people/:id/affiliations","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","crm","people",":id","affiliations"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Add person affiliation","body":{"mode":"raw","raw":"{\n  \"affiliation\": {\n    \"organization_id\": 0,\n    \"role\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"270570e5-9760-4e4a-8e7f-fbca34924722","name":"updateCompanyCrmPeopleAffiliation — Update person affiliation","request":{"method":"PATCH","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/crm/people/:id/affiliations/:affiliation_id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","crm","people",":id","affiliations",":affiliation_id"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""},{"key":"affiliation_id","value":""}]},"description":"Update person affiliation","body":{"mode":"raw","raw":"{\n  \"affiliation\": {\n    \"role\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"e460870f-7d92-4fc9-8876-6100642dc66d","name":"deleteCompanyCrmPeopleAffiliation — Remove person affiliation","request":{"method":"DELETE","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/crm/people/:id/affiliations/:affiliation_id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","crm","people",":id","affiliations",":affiliation_id"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""},{"key":"affiliation_id","value":""}]},"description":"Remove person affiliation"}},{"id":"f8d0d37a-8ba1-4144-8ad2-cdfd5ed734be","name":"listCompanyCrmPeopleAliases — List identities resolved to this canonical identity","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/crm/people/:id/aliases","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","crm","people",":id","aliases"],"query":[{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true}],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"List identities resolved to this canonical identity"}},{"id":"c70c1894-d433-4dea-8f37-ed31dd2b0b53","name":"listCompanyCrmPeopleCommunicationPreferences — Read recorded communication preferences for a person and resolved aliases","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/crm/people/:id/communication_preferences","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","crm","people",":id","communication_preferences"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Read recorded communication preferences for a person and resolved aliases\n\nRequires company CRM view and crm:read token scope. Recorded permission is evidence only, not an authorization to send."}},{"id":"f07c9726-25f9-4409-807c-f9709eea3ef2","name":"listCompanyCrmPeopleCommunicationPreferencesEvents — List append-only communication preference evidence across a person and resolved aliases","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/crm/people/:id/communication_preferences/events","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","crm","people",":id","communication_preferences","events"],"query":[{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true}],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"List append-only communication preference evidence across a person and resolved aliases"}},{"id":"6b780321-0ec3-442a-800b-37ae9ee4b8ec","name":"createCompanyCrmPeopleCommunicationPreferencesEvent — Record an immutable communication preference event on a person or resolved alias","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/crm/people/:id/communication_preferences/events","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","crm","people",":id","communication_preferences","events"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Record an immutable communication preference event on a person or resolved alias\n\nRequires company CRM edit and crm:write token scope. Permitted evidence must match the current primary email or phone; no message is sent.","body":{"mode":"raw","raw":"{\n  \"preference_event\": {\n    \"channel\": \"email\",\n    \"evidence\": \"\",\n    \"purpose\": \"marketing\",\n    \"source\": \"customer_request\",\n    \"status\": \"permitted\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"b6df0e7e-c3a3-46e2-82b2-92818f569d8a","name":"listCompanyCrmPeopleContacts — List visible scoped contacts for person","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/crm/people/:id/contacts","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","crm","people",":id","contacts"],"query":[{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true}],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"List visible scoped contacts for person"}},{"id":"6d30e664-121a-497e-823e-0c4f292fbc22","name":"listCompanyCrmPeopleDuplicateCandidates — Suggest possible duplicate identities; review required","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/crm/people/:id/duplicate_candidates","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","crm","people",":id","duplicate_candidates"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Suggest possible duplicate identities; review required"}},{"id":"9c838ef6-9c5d-4c20-8be8-5575fb00d78a","name":"listCompanyCrmPeopleHistory — List person history","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/crm/people/:id/history","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","crm","people",":id","history"],"query":[{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true}],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"List person history"}},{"id":"434b2ba6-ba3f-416a-8442-428c3199944b","name":"resolutionCompanyCrmPeople — Resolve duplicate to canonical identity","request":{"method":"PUT","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/crm/people/:id/resolution","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","crm","people",":id","resolution"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Resolve duplicate to canonical identity","body":{"mode":"raw","raw":"{\n  \"resolution\": {\n    \"canonical_id\": 0,\n    \"review_token\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"ce5636bb-a7b7-46cc-8ad9-c2e6ff312c4f","name":"deleteResolutionCompanyCrmPeople — Undo duplicate resolution","request":{"method":"DELETE","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/crm/people/:id/resolution","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","crm","people",":id","resolution"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Undo duplicate resolution","body":{"mode":"raw","raw":"{\n  \"resolution\": {\n    \"review_token\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"dc8db054-fe7c-4c89-8272-b77ff43cfdd5","name":"listCompanyCrmPeopleResolutionPreview — Preview reversible duplicate resolution","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/crm/people/:id/resolution_preview","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","crm","people",":id","resolution_preview"],"query":[{"key":"canonical_id","value":"","disabled":false}],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Preview reversible duplicate resolution"}},{"id":"601dfb5a-21c1-46b0-8d4a-3b064ffc4ef4","name":"listCompanyCrmPeopleTimeline — List the permission-scoped relationship timeline for a person and resolved aliases","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/crm/people/:id/timeline","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","crm","people",":id","timeline"],"query":[{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true}],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"List the permission-scoped relationship timeline for a person and resolved aliases"}},{"id":"a099687e-39d1-4254-81a6-063616e82b6a","name":"listCompanyCrmProjects — List eligible active destination projects","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/crm/projects","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","crm","projects"],"variable":[{"key":"company_id","value":"{{companyId}}"}]},"description":"List eligible active destination projects"}},{"id":"03376ca3-b750-4f43-8c31-39fbecacd552","name":"listCompanyCrmSummary — CRM totals and exact USD pipeline forecast","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/crm/summary","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","crm","summary"],"variable":[{"key":"company_id","value":"{{companyId}}"}]},"description":"CRM totals and exact USD pipeline forecast\n\nCompany administrators or explicit company CRM grantees only. Read-only grants allow view; standard grants allow view/create/edit. Company intake lists remain preproject records only. Project permissions are separate."}},{"id":"76d2f63a-9273-4c20-89d6-b70e987d588a","name":"listProjectCrmActionCenter — Read the project CRM Action Center","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/crm/action_center","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","crm","action_center"],"query":[{"key":"kind","value":"","disabled":true},{"key":"page","value":"1","disabled":true,"description":"Pages may begin at offsets up to 1,000. Link targets stop at the last reachable page while Total reports the full matching count."},{"key":"per_page","value":"100","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Read the project CRM Action Center\n\nRequires project CRM view and crm:read. Source-linked work is derived at one server time. Offer and warranty expiry rows are review cues, not a customer response, completed task, notification, or contractual SLA. Operational deadlines through 30 days and warranty end dates from the past 30 through next 90 UTC calendar days are included."}},{"id":"c645a7d6-f696-4fbd-8d8a-7d194bfe3098","name":"listProjectCrmActivities — List activities","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/crm/activities","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","crm","activities"],"query":[{"key":"search","value":"","disabled":true},{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true},{"key":"filters[status]","value":"","disabled":true,"description":"Comma-separated values: open, completed, overdue."},{"key":"filters[contact_id]","value":"","disabled":true,"description":"Comma-separated IDs."},{"key":"filters[opportunity_id]","value":"","disabled":true,"description":"Comma-separated IDs."},{"key":"filters[owner_id]","value":"","disabled":true,"description":"Comma-separated IDs."}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"List activities"}},{"id":"5fbed634-14df-4d38-82a6-b6ab731d9e4f","name":"createProjectCrmActivity — Create activity","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/crm/activities","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","crm","activities"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Create activity","body":{"mode":"raw","raw":"{\n  \"activity\": {\n    \"title\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"b2c0adb2-3e71-4f7e-8465-d38fec8c391e","name":"listProjectCrmActivitiesCalendar — Download open project CRM follow-ups as an iCalendar file","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/crm/activities/calendar","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","crm","activities","calendar"],"query":[{"key":"search","value":"","disabled":true},{"key":"filters[status]","value":"","disabled":true,"description":"Comma-separated values: open, overdue. Completed follow-ups are never exported."},{"key":"filters[contact_id]","value":"","disabled":true,"description":"Comma-separated IDs."},{"key":"filters[opportunity_id]","value":"","disabled":true,"description":"Comma-separated IDs."},{"key":"filters[owner_id]","value":"","disabled":true,"description":"Comma-separated IDs."}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Download open project CRM follow-ups as an iCalendar file\n\nRequires Project CRM view and crm:read. Returns open, unarchived follow-ups with a due date as RFC 5545 VEVENTs (CRLF lines folded at 75 octets, UID crm-activity-<id>@os.construction). Date-only due dates are all-day events; other due instants are UTC. Events carry the title, related contact and opportunity names and a link back to the record, never notes. Takes the list's search and filters; at most 1000 events, earliest due first."}},{"id":"4f1d172d-4388-41a7-8ff5-18ccc1f88e70","name":"getProjectCrmActivity — Get CRM follow-up","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/crm/activities/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","crm","activities",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Get CRM follow-up\n\nSame access as the activity list. Archived follow-ups remain readable by id with archived_at set."}},{"id":"dd9f55f3-223c-4d46-895a-cb717a4e05b5","name":"updateProjectCrmActivity — Edit an open CRM follow-up using its current updated_at value","request":{"method":"PATCH","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/crm/activities/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","crm","activities",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Edit an open CRM follow-up using its current updated_at value\n\nOnly open follow-ups can be edited. The resulting contact, opportunity and owner must remain in the current CRM scope. A stale updated_at or completed activity returns 409. An unchanged patch returns the existing record without a history event.","body":{"mode":"raw","raw":"{\n  \"activity\": {\n    \"updated_at\": \"2026-01-31T12:00:00Z\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"e52d1389-6031-41d5-8b0e-1e3ed99de242","name":"deleteProjectCrmActivity — Archive CRM follow-up","request":{"method":"DELETE","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/crm/activities/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","crm","activities",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Archive CRM follow-up\n\nSoft archive. Project CRM edit permission, as for PATCH. The follow-up stays readable by id (archived_at set) and in history, but leaves lists, summaries, forecasts, cohorts and exports, and can no longer be edited or newly linked. Repeating the request is a no-op. Records an archived history entry."}},{"id":"9931a243-8707-4857-8716-cce316ec744d","name":"completeProjectCrmActivity — Complete follow-up idempotently","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/crm/activities/:id/complete","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","crm","activities",":id","complete"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Complete follow-up idempotently"}},{"id":"aac07b91-1c5a-4953-85de-f0b5b822e90e","name":"listProjectCrmActivityHistory — Read retained company intake history for scoped CRM record","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/crm/activities/:id/history","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","crm","activities",":id","history"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Read retained company intake history for scoped CRM record"}},{"id":"adb91946-fd32-41f2-8a45-edb848f1da97","name":"restoreProjectCrmActivity — Restore archived CRM follow-up","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/crm/activities/:id/restore","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","crm","activities",":id","restore"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Restore archived CRM follow-up\n\nClears archived_at so the follow-up returns to lists, summaries and the action center. Project CRM edit permission and crm:write, as for DELETE. Repeating the request, or restoring an active record, is a no-op. Records a restored history entry."}},{"id":"70a82132-bdfb-4c0e-8f4e-81be1afc9b0b","name":"listProjectCrmContacts — List contacts","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/crm/contacts","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","crm","contacts"],"query":[{"key":"search","value":"","disabled":true},{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true},{"key":"filters[relationship]","value":"","disabled":true,"description":"Comma-separated values: lead, client, partner, subcontractor."},{"key":"filters[owner_id]","value":"","disabled":true,"description":"Comma-separated IDs."}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"List contacts"}},{"id":"b1bf5e4a-1979-4a1a-83be-29c1e953afd0","name":"createProjectCrmContact — Create contact","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/crm/contacts","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","crm","contacts"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Create contact","body":{"mode":"raw","raw":"{\n  \"contact\": {\n    \"first_name\": \"\",\n    \"last_name\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"8e2ab978-09a8-4f6b-8a17-e0291707ede7","name":"listProjectCrmContactsDuplicates — Find likely duplicate contacts","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/crm/contacts/duplicates","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","crm","contacts","duplicates"],"query":[{"key":"email","value":"","disabled":true},{"key":"first_name","value":"","disabled":true},{"key":"last_name","value":"","disabled":true},{"key":"organization","value":"","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Find likely duplicate contacts\n\nAdvisory check before creating a project CRM contact. Returns up to 10 active contacts in the same scope with the same email (case-insensitive), or the same first and last name and organization (case-insensitive; a blank organization matches contacts without one). Contact create never blocks on duplicates. Requires CRM view permission and crm:read."}},{"id":"bbfd92e8-d097-4900-855f-d9650b7620b0","name":"getProjectCrmContact — Get contact","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/crm/contacts/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","crm","contacts",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Get contact"}},{"id":"0a0267d3-84c9-4eb2-8e2a-ba9256bb3204","name":"updateProjectCrmContact — Update contact","request":{"method":"PATCH","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/crm/contacts/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","crm","contacts",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Update contact","body":{"mode":"raw","raw":"{\n  \"contact\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"43518886-ae23-42b7-868e-0a5501c7c8e5","name":"deleteProjectCrmContact — Archive CRM contact","request":{"method":"DELETE","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/crm/contacts/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","crm","contacts",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Archive CRM contact\n\nSoft archive. Project CRM edit permission, as for PATCH. The contact stays readable by id (archived_at set) and in history, but leaves lists, summaries, forecasts, cohorts and exports, and can no longer be edited or newly linked. Repeating the request is a no-op. Records an archived history entry."}},{"id":"b8fe9c4d-571a-43ee-8cb1-5f12614e9ac5","name":"listProjectCrmContactHistory — Read retained company intake history for scoped CRM record","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/crm/contacts/:id/history","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","crm","contacts",":id","history"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Read retained company intake history for scoped CRM record"}},{"id":"64b4ca73-168f-4dbd-8381-2a9a3850f61c","name":"mergeProjectCrmContact — Merge a duplicate contact into another","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/crm/contacts/:id/merge","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","crm","contacts",":id","merge"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Merge a duplicate contact into another\n\nMoves the source contact's opportunities, activities, service cases, import references and converted inquiry links to target_id (an active contact in the same scope), fills the target's empty organization, email, phone, role, source, notes and owner from the source, then archives the source. One locked transaction; history records a merged entry on the source and an updated entry on the target. Same permission as archive (CRM edit) and crm:write. A source with customer responses, offers, authority evidence, portal grants, invitations or service requests is refused with 409; merge in the other direction instead. The master person link is not copied.","body":{"mode":"raw","raw":"{\n  \"merge\": {\n    \"target_id\": 0\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"38ab2966-e299-4069-8002-9f459af5ca93","name":"listProjectCrmContactPerson — Get explicit master person link","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/crm/contacts/:id/person","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","crm","contacts",":id","person"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Get explicit master person link"}},{"id":"cf2994d8-0be6-4596-8a89-e7acb240e372","name":"personProjectCrmContact — Link contact to master person","request":{"method":"PUT","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/crm/contacts/:id/person","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","crm","contacts",":id","person"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Link contact to master person","body":{"mode":"raw","raw":"{\n  \"person_link\": {\n    \"person_id\": 0\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"cc15452a-c5ec-404e-831f-077874c90d56","name":"deletePersonProjectCrmContact — Unlink contact from master person","request":{"method":"DELETE","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/crm/contacts/:id/person","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","crm","contacts",":id","person"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Unlink contact from master person"}},{"id":"8e26c9ca-4ad9-4511-8f21-af42cbeac18d","name":"restoreProjectCrmContact — Restore archived CRM contact","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/crm/contacts/:id/restore","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","crm","contacts",":id","restore"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Restore archived CRM contact\n\nClears archived_at so the contact returns to lists, summaries and exports. Project CRM edit permission and crm:write, as for DELETE. Repeating the request, or restoring an active record, is a no-op. Records a restored history entry."}},{"id":"fca872bc-e406-40a7-840e-503a2ac9e2c3","name":"listProjectCrmCustomerPortalDecisionRequests — List customer decision requests for staff","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/crm/customer_portal/decision_requests","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","crm","customer_portal","decision_requests"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"List customer decision requests for staff\n\nProject CRM view and crm:read. Private paginated draft and response history."}},{"id":"85dfb98d-0bf8-47cd-8881-1002884280b7","name":"createProjectCrmCustomerPortalDecisionRequest — Create private customer decision draft","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/crm/customer_portal/decision_requests","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","crm","customer_portal","decision_requests"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Create private customer decision draft\n\nProject CRM admin and crm:write. Operational preference only, not legal or financial authorization.","body":{"mode":"raw","raw":"{\n  \"decision_request\": {\n    \"body\": \"\",\n    \"options\": [\n      {\n        \"key\": \"\",\n        \"label\": \"\"\n      }\n    ],\n    \"purpose\": \"schedule_preference\",\n    \"title\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"2a8b0d1d-8b8b-42a3-8796-e16997fcc747","name":"getProjectCrmCustomerPortalDecisionRequest — Show customer decision request to staff","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/crm/customer_portal/decision_requests/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","crm","customer_portal","decision_requests",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Show customer decision request to staff\n\nProject CRM view and crm:read. Includes retained staff revisions and selected customer response."}},{"id":"91552471-234c-431a-80ba-71d95e8ad3ad","name":"correctProjectCrmCustomerPortalDecisionRequest — Correct decision request before customer response","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/crm/customer_portal/decision_requests/:id/correct","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","crm","customer_portal","decision_requests",":id","correct"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Correct decision request before customer response\n\nProject CRM admin and crm:write. Retains previous staff wording and selected audience; requires reason and current version.","body":{"mode":"raw","raw":"{\n  \"correction\": {\n    \"body\": \"\",\n    \"expected_version\": 0,\n    \"options\": [\n      {\n        \"key\": \"\",\n        \"label\": \"\"\n      }\n    ],\n    \"purpose\": \"schedule_preference\",\n    \"reason\": \"\",\n    \"title\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"d67e0d8e-d99a-4c52-871d-25412affe83b","name":"publishProjectCrmCustomerPortalDecisionRequest — Publish decision request to one exact customer grant","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/crm/customer_portal/decision_requests/:id/publish","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","crm","customer_portal","decision_requests",":id","publish"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Publish decision request to one exact customer grant\n\nProject CRM admin and crm:write. Requires a live reviewed grant, version and UUID request key. No message is dispatched automatically.","body":{"mode":"raw","raw":"{\n  \"publication\": {\n    \"expected_version\": 0,\n    \"grant_id\": 0,\n    \"request_key\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"6cb295cc-d2fe-4089-87fe-47e93aef96e5","name":"withdrawProjectCrmCustomerPortalDecisionRequest — Withdraw unanswered decision request","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/crm/customer_portal/decision_requests/:id/withdraw","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","crm","customer_portal","decision_requests",":id","withdraw"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Withdraw unanswered decision request\n\nProject CRM admin and crm:write. Removes customer visibility and retains staff history.","body":{"mode":"raw","raw":"{\n  \"withdrawal\": {\n    \"expected_version\": 0,\n    \"reason\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"e76c9a4f-54bb-47b5-85bd-e8480c769b1b","name":"listProjectCrmCustomerPortalDocumentShares — List staff customer document shares","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/crm/customer_portal/document_shares","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","crm","customer_portal","document_shares"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"List staff customer document shares\n\nRequires project CRM view. Drafts, recipients and source file metadata stay staff-only. Private, paginated response."}},{"id":"01d566e7-693c-433b-8c68-9e715f93c367","name":"createProjectCrmCustomerPortalDocumentShare — Create a private customer document-share draft","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/crm/customer_portal/document_shares","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","crm","customer_portal","document_shares"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Create a private customer document-share draft\n\nRequires project CRM admin and Documents view. A current eligible source file is selected; public title and filename are reviewed explicitly. The draft is not available to customers.","body":{"mode":"raw","raw":"{\n  \"share\": {\n    \"filename\": \"\",\n    \"source_file_id\": 0,\n    \"title\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"6ff463c7-e2d8-42c0-86d6-fc58b7df61c4","name":"getProjectCrmCustomerPortalDocumentShare — Show staff customer document-share history","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/crm/customer_portal/document_shares/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","crm","customer_portal","document_shares",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Show staff customer document-share history\n\nRequires project CRM view. Includes retained staff-only source and recipient details."}},{"id":"31243031-2fc8-4aa3-807f-93db19cdb454","name":"publishProjectCrmCustomerPortalDocumentShare — Publish reviewed document to exact customer grants","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/crm/customer_portal/document_shares/:id/publish","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","crm","customer_portal","document_shares",":id","publish"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Publish reviewed document to exact customer grants\n\nRequires project CRM admin. Rechecks current source bytes, scanner verdict, version and every selected live grant. Identical request-key replay returns the original receipt.","body":{"mode":"raw","raw":"{\n  \"publication\": {\n    \"expected_version\": 0,\n    \"grant_ids\": [\n      0\n    ],\n    \"request_key\": \"\",\n    \"review_confirmed\": false\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"d8a63286-b44b-4268-885b-e4db5edd041b","name":"withdrawProjectCrmCustomerPortalDocumentShare — Withdraw a customer document share","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/crm/customer_portal/document_shares/:id/withdraw","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","crm","customer_portal","document_shares",":id","withdraw"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Withdraw a customer document share\n\nRequires project CRM admin. Revokes every customer download and retains the staff history and reason.","body":{"mode":"raw","raw":"{\n  \"withdrawal\": {\n    \"expected_version\": 0,\n    \"reason\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"efe5b678-bee1-4a5f-834e-440fc7014135","name":"listProjectCrmCustomerPortalGrants — List current and revoked project contact grants","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/crm/customer_portal/grants","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","crm","customer_portal","grants"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"List current and revoked project contact grants"}},{"id":"4ce3a578-3cc5-41d8-8359-50610da72034","name":"revokeProjectCrmCustomerPortalGrant — Revoke a project contact grant and invalidate its access","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/crm/customer_portal/grants/:id/revoke","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","crm","customer_portal","grants",":id","revoke"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Revoke a project contact grant and invalidate its access","body":{"mode":"raw","raw":"{\n  \"revoke\": {\n    \"note\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"79828e3e-7c85-4e5e-848c-b253825b39d0","name":"listProjectCrmCustomerPortalInvitations — List reviewed customer access invitations","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/crm/customer_portal/invitations","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","crm","customer_portal","invitations"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"List reviewed customer access invitations"}},{"id":"942248e5-81db-43ea-86bf-821a6c10a2d5","name":"createProjectCrmCustomerPortalInvitation — Issue a one-time project contact invitation after staff review","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/crm/customer_portal/invitations","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","crm","customer_portal","invitations"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Issue a one-time project contact invitation after staff review","body":{"mode":"raw","raw":"{\n  \"invitation\": {\n    \"contact_id\": 0,\n    \"review_reference\": \"\",\n    \"review_source\": \"in_person\",\n    \"role\": \"requester\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"9766bb13-c0b6-4b81-848c-5756a13eb31a","name":"revokeProjectCrmCustomerPortalInvitation — Revoke a customer invitation","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/crm/customer_portal/invitations/:id/revoke","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","crm","customer_portal","invitations",":id","revoke"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Revoke a customer invitation","body":{"mode":"raw","raw":"{\n  \"revoke\": {\n    \"note\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"10f56050-7032-452b-8b65-f7068d27b7c7","name":"listProjectCrmCustomerPortalProjectUpdates — List staff-reviewed customer project updates","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/crm/customer_portal/project_updates","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","crm","customer_portal","project_updates"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"List staff-reviewed customer project updates\n\nRequires project CRM view and crm:read. Drafts and withdrawn updates remain staff-only. Results are paginated and private."}},{"id":"07a43377-10ea-45c2-81f8-77aab4e0d07e","name":"createProjectCrmCustomerPortalProjectUpdate — Create a private customer project update draft","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/crm/customer_portal/project_updates","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","crm","customer_portal","project_updates"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Create a private customer project update draft\n\nCreates a private staff draft. An optional source_schedule_task_id must identify a current, non-private milestone in this project. Staff wording and date are reviewed explicitly; no schedule fields are copied to the customer response.","body":{"mode":"raw","raw":"{\n  \"update\": {\n    \"body\": \"\",\n    \"status_label\": \"informational\",\n    \"title\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"9d3f9214-06c6-405d-833f-6198ebae4132","name":"getProjectCrmCustomerPortalProjectUpdate — Show staff-only project update and retained history","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/crm/customer_portal/project_updates/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","crm","customer_portal","project_updates",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Show staff-only project update and retained history\n\nRequires project CRM view and crm:read. Includes frozen recipient snapshot and revisions."}},{"id":"df2dce54-c7c4-4847-8e6a-1f736f991376","name":"correctProjectCrmCustomerPortalProjectUpdate — Append a reasoned correction to a draft or publication","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/crm/customer_portal/project_updates/:id/correct","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","crm","customer_portal","project_updates",":id","correct"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Append a reasoned correction to a draft or publication\n\nRequires project CRM admin and crm:write. Recipient snapshot cannot change; earlier content remains in staff-only history. A customer sees current corrected wording and corrected_at only.","body":{"mode":"raw","raw":"{\n  \"correction\": {\n    \"body\": \"\",\n    \"expected_version\": 0,\n    \"reason\": \"\",\n    \"status_label\": \"informational\",\n    \"title\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"2f5dc323-6718-4e0b-8ad7-57ca2bbfc56c","name":"publishProjectCrmCustomerPortalProjectUpdate — Publish an exact grant-scoped customer project update","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/crm/customer_portal/project_updates/:id/publish","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","crm","customer_portal","project_updates",":id","publish"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Publish an exact grant-scoped customer project update\n\nRequires project CRM admin and crm:write. Locks and verifies each selected live same-project grant, captures a fixed recipient snapshot, and returns an exact receipt on identical request-key replay.","body":{"mode":"raw","raw":"{\n  \"publication\": {\n    \"expected_version\": 0,\n    \"grant_ids\": [\n      0\n    ],\n    \"request_key\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"e9fe42d5-48ed-4429-8f09-34370309a66e","name":"withdrawProjectCrmCustomerPortalProjectUpdate — Withdraw a published customer project update","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/crm/customer_portal/project_updates/:id/withdraw","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","crm","customer_portal","project_updates",":id","withdraw"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Withdraw a published customer project update\n\nRequires project CRM admin and crm:write. Customer visibility ends immediately; staff revision and exact audience history remain.","body":{"mode":"raw","raw":"{\n  \"withdrawal\": {\n    \"expected_version\": 0,\n    \"reason\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"1b290a40-91e7-4160-8dfe-50c0dd034a15","name":"listProjectCrmCustomerPortalServiceRequests — List customer-submitted service requests for staff review","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/crm/customer_portal/service_requests","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","crm","customer_portal","service_requests"],"query":[{"key":"sort","value":"","disabled":true,"description":"Show requests with a customer reply, newest reply first."}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"List customer-submitted service requests for staff review\n\nProject CRM staff can list customer submissions. sort=latest_message selects only requests with customer follow-up messages, newest message first. The message timestamp is staff-only and does not imply unread state."}},{"id":"3139d820-4f11-4a83-854f-a01ebd68dd10","name":"getProjectCrmCustomerPortalServiceRequest — Read a customer submission with staff intake metadata","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/crm/customer_portal/service_requests/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","crm","customer_portal","service_requests",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Read a customer submission with staff intake metadata"}},{"id":"2d9f2f7a-3991-4e84-806c-f83f0f4c6878","name":"listProjectCrmCustomerPortalServiceRequestEvidence — List customer-supplied service request evidence for project staff","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/crm/customer_portal/service_requests/:id/evidence","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","crm","customer_portal","service_requests",":id","evidence"],"query":[{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"List customer-supplied service request evidence for project staff\n\nRequires current project CRM view access and crm:read token scope. Each item is a customer-supplied JPEG, PNG or PDF. Storage keys and binary data are never returned in list responses. Files are not malware-scanned by this endpoint."}},{"id":"d12e4b61-86ae-4a50-8aa2-a71984be52b1","name":"listProjectCrmCustomerPortalServiceRequestEvidenceDownload — Download one customer-supplied service request evidence file","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/crm/customer_portal/service_requests/:id/evidence/:evidence_id/download","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","crm","customer_portal","service_requests",":id","evidence",":evidence_id","download"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""},{"key":"evidence_id","value":""}]},"description":"Download one customer-supplied service request evidence file\n\nRequires current project CRM view access and crm:read token scope. The binary is forced to attachment with no-store, no-referrer, nosniff and sandbox headers. The storage key is never exposed."}},{"id":"c087f0e9-f638-46ba-8c2e-5060f2e17d3f","name":"intakeProjectCrmCustomerPortalServiceRequest — Take a customer submission into a staff service case","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/crm/customer_portal/service_requests/:id/intake","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","crm","customer_portal","service_requests",":id","intake"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Take a customer submission into a staff service case","body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}}}},{"id":"6cd85a1e-77dd-40fd-8769-9f3266a1580e","name":"listProjectCrmCustomerPortalServiceRequestMessages — List customer-authored follow-up messages on a project service request for staff","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/crm/customer_portal/service_requests/:id/messages","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","crm","customer_portal","service_requests",":id","messages"],"query":[{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"List customer-authored follow-up messages on a project service request for staff\n\nRequires current project CRM view access and crm:read token scope. Messages are customer-authored evidence. Staff-published updates and internal case events are separate records."}},{"id":"e49cabd0-a94b-4e3f-86f5-b9efb780d3d3","name":"publishProjectCrmCustomerPortalServiceRequest — Publish a selected customer-visible service status and message","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/crm/customer_portal/service_requests/:id/publish","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","crm","customer_portal","service_requests",":id","publish"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Publish a selected customer-visible service status and message","body":{"mode":"raw","raw":"{\n  \"update\": {\n    \"message\": \"\",\n    \"status\": \"received\",\n    \"version\": 0\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"ceb16f6e-47b6-4910-898d-272acb3a5644","name":"listProjectCrmForecast — Current advisory opportunity forecast and observable stage aging","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/crm/forecast","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","crm","forecast"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Current advisory opportunity forecast and observable stage aging\n\nAmounts are CRM estimates, not financial commitments. as_of is server UTC report time. Stage age is observed only from new creates or recorded transitions; migration baseline has unknown age."}},{"id":"5806e1ec-b801-4b0b-8b87-f91dc5cdd4a4","name":"listProjectCrmGrowthCohorts — Current-state opportunity outcome cohorts by UTC creation month and staff-attributed source","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/crm/growth_cohorts","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","crm","growth_cohorts"],"query":[{"key":"months","value":"","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Current-state opportunity outcome cohorts by UTC creation month and staff-attributed source\n\nRows are grouped by opportunity creation month and current source/stage at as_of, not historical month-end snapshots. Open pursuits are excluded from the decided win-rate denominator. Source is staff-attributed, not a verified acquisition channel. CRM estimates are not revenue."}},{"id":"706cd21a-2d08-4ca8-8d84-659ccbc4a216","name":"listProjectCrmInstalledAssets — List project installed assets","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/crm/installed_assets","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","crm","installed_assets"],"query":[{"key":"search","value":"","disabled":true},{"key":"status","value":"","disabled":true},{"key":"location_id","value":"","disabled":true},{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"List project installed assets\n\nStaff-only, permission-scoped installed asset register. Provenance and warranty references are recorded evidence, not automatic eligibility."}},{"id":"ab5cfb6d-2ad5-4eee-8ac5-5cadebfdb120","name":"createProjectCrmInstalledAsset — Record an installed asset with handoff provenance","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/crm/installed_assets","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","crm","installed_assets"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Record an installed asset with handoff provenance\n\nRequires CRM create and crm:write. An explicit handoff reference and evidence note are required; a warranty coverage reference is reviewed staff evidence.","body":{"mode":"raw","raw":"{\n  \"installed_asset\": {\n    \"asset_tag\": \"\",\n    \"evidence_note\": \"\",\n    \"handoff_reference\": \"\",\n    \"name\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"4b3ac168-42cb-4d20-8732-420456fc9822","name":"getProjectCrmInstalledAsset — Read an installed asset and its change history","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/crm/installed_assets/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","crm","installed_assets",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Read an installed asset and its change history"}},{"id":"0f048d04-93f2-4dad-8662-130d38c374ab","name":"updateProjectCrmInstalledAsset — Version-check an installed asset correction","request":{"method":"PATCH","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/crm/installed_assets/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","crm","installed_assets",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Version-check an installed asset correction\n\nRequires CRM edit and crm:write. Asset tag is immutable; changes retain before/after evidence.","body":{"mode":"raw","raw":"{\n  \"installed_asset\": {\n    \"note\": \"\",\n    \"version\": 0\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"23839dff-da87-4eb4-80ab-9763e7cae95a","name":"listProjectCrmInstalledAssetEvents — Page through installed asset change history","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/crm/installed_assets/:id/events","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","crm","installed_assets",":id","events"],"query":[{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Page through installed asset change history\n\nThe asset detail includes only the newest 100 events. This endpoint supports full retained history with bounded pages."}},{"id":"c77df079-f01b-4a95-8ea6-64ffb91728ff","name":"listProjectCrmInstalledAssetEvidence — Read protected pinned handoff history","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/crm/installed_assets/:id/evidence","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","crm","installed_assets",":id","evidence"],"query":[{"key":"before","value":"","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Read protected pinned handoff history\n\nCRM view and crm:read required. Missing Documents access redacts source IDs, titles, purpose and note. Returns at most 50 evidence rows, newest first. Cursor is an evidence record ID."}},{"id":"c0963c07-1893-4ce7-85eb-b3769959769b","name":"evidenceProjectCrmInstalledAsset — Append or supersede pinned evidence","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/crm/installed_assets/:id/evidence","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","crm","installed_assets",":id","evidence"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Append or supersede pinned evidence\n\nCRM edit/crm:write plus current Documents/upload read/documents:read required. Exact retry replays the original ID/revision. Does not change warranty, commissioning, closeout or payment status.","body":{"mode":"raw","raw":"{\n  \"handoff_evidence\": {\n    \"document_version_id\": 0,\n    \"note\": \"\",\n    \"purpose\": \"\",\n    \"request_key\": \"\",\n    \"version\": 0\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"42110ac8-eee4-4e6b-88b7-870854466dae","name":"listProjectCrmInstalledAssetEvidenceOptions — Search accessible uploaded source versions for an active asset","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/crm/installed_assets/:id/evidence/options","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","crm","installed_assets",":id","evidence","options"],"query":[{"key":"search","value":"","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Search accessible uploaded source versions for an active asset"}},{"id":"6391a715-2ae7-4004-8ee9-3e7142d4c631","name":"retireProjectCrmInstalledAsset — Retire an installed asset with a version-checked note","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/crm/installed_assets/:id/retire","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","crm","installed_assets",":id","retire"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Retire an installed asset with a version-checked note\n\nRetirement preserves asset and service history; it does not resolve cases or decide warranty coverage.","body":{"mode":"raw","raw":"{\n  \"retirement\": {\n    \"note\": \"\",\n    \"version\": 0\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"3f7d8aa8-9e97-4e7c-891b-b5e286efa6ca","name":"listProjectCrmInstalledAssetServiceCases — Read retained service-case history for an asset","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/crm/installed_assets/:id/service_cases","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","crm","installed_assets",":id","service_cases"],"query":[{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Read retained service-case history for an asset\n\nIncludes current and removed associations. Requires current project CRM view and crm:read."}},{"id":"e105ae7b-f99d-4ccc-8e37-66bd231b43b7","name":"listProjectCrmOpportunities — List opportunities","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/crm/opportunities","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","crm","opportunities"],"query":[{"key":"search","value":"","disabled":true},{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true},{"key":"filters[stage]","value":"","disabled":true,"description":"Comma-separated values: qualification, site_visit, estimating, proposal, negotiation, won, lost."},{"key":"filters[contact_id]","value":"","disabled":true,"description":"Comma-separated IDs."},{"key":"filters[owner_id]","value":"","disabled":true,"description":"Comma-separated IDs."}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"List opportunities"}},{"id":"57309d31-0cec-4b22-8cf9-00e3f740d63f","name":"createProjectCrmOpportunity — Create opportunity","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/crm/opportunities","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","crm","opportunities"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Create opportunity","body":{"mode":"raw","raw":"{\n  \"opportunity\": {\n    \"title\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"725c0388-76fe-4040-81e4-595f83946fbc","name":"getProjectCrmOpportunity — Get opportunity","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/crm/opportunities/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","crm","opportunities",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Get opportunity"}},{"id":"7c8c0383-f373-42c0-84d8-2c5d249b58e8","name":"updateProjectCrmOpportunity — Update opportunity","request":{"method":"PATCH","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/crm/opportunities/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","crm","opportunities",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Update opportunity","body":{"mode":"raw","raw":"{\n  \"opportunity\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"7569d049-cc99-481d-89df-71dec74b11a0","name":"deleteProjectCrmOpportunity — Archive CRM opportunity","request":{"method":"DELETE","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/crm/opportunities/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","crm","opportunities",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Archive CRM opportunity\n\nSoft archive. Project CRM edit permission, as for PATCH. The opportunity stays readable by id (archived_at set) and in history, but leaves lists, summaries, forecasts, cohorts and exports, and can no longer be edited or newly linked. Repeating the request is a no-op. Records an archived history entry."}},{"id":"83be82ba-2dec-4133-8ac6-ab8b0d846e89","name":"listProjectCrmOpportunityBiddingHandoffs — List reviewed proposal-to-bidding handoff receipts for an opportunity","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/crm/opportunities/:id/bidding_handoffs","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","crm","opportunities",":id","bidding_handoffs"],"query":[{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"List reviewed proposal-to-bidding handoff receipts for an opportunity\n\nRequires current project CRM and bidding view permissions, enabled tools, crm:read and bidding:read token scopes. Receipts are internal and can include source proposal text; vendor-facing bidding package responses never include this snapshot."}},{"id":"51701faa-a93f-42d4-8bab-033e81457b65","name":"listProjectCrmOpportunityForecastHistory — Paginated immutable opportunity forecast input history","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/crm/opportunities/:id/forecast_history","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","crm","opportunities",":id","forecast_history"],"query":[{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Paginated immutable opportunity forecast input history\n\nMigration baseline records deployment-time state, not historical transitions. Only scoped CRM readers can view events. page and per_page paginate newest first, maximum 100 rows."}},{"id":"3be80cd3-3842-43a9-8ea2-921d7aa7b238","name":"listProjectCrmOpportunityHistory — Read retained company intake history for scoped CRM record","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/crm/opportunities/:id/history","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","crm","opportunities",":id","history"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Read retained company intake history for scoped CRM record"}},{"id":"796dc8e2-728b-4347-800e-0abebab70745","name":"listProjectCrmOpportunityProposals — List proposal revisions for a project opportunity","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/crm/opportunities/:id/proposals","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","crm","opportunities",":id","proposals"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"List proposal revisions for a project opportunity"}},{"id":"fb7fd9a2-378d-4da4-8f77-7064c9e87f25","name":"createProjectCrmOpportunityProposal — Capture the current opportunity as a new draft proposal revision","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/crm/opportunities/:id/proposals","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","crm","opportunities",":id","proposals"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Capture the current opportunity as a new draft proposal revision"}},{"id":"bec2e800-4e88-4038-8e8b-24af8f037144","name":"getProjectCrmOpportunityProposal — Show a proposal revision","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/crm/opportunities/:id/proposals/:proposal_id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","crm","opportunities",":id","proposals",":proposal_id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""},{"key":"proposal_id","value":""}]},"description":"Show a proposal revision"}},{"id":"9e2513f3-604f-442f-8d7c-28aaf91f0202","name":"updateProjectCrmOpportunityProposal — Edit the current draft as its author","request":{"method":"PATCH","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/crm/opportunities/:id/proposals/:proposal_id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","crm","opportunities",":id","proposals",":proposal_id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""},{"key":"proposal_id","value":""}]},"description":"Edit the current draft as its author","body":{"mode":"raw","raw":"{\n  \"proposal\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"b9f458a0-6c24-4d61-8aff-9cff30e1a457","name":"listProjectCrmOpportunityProposalBiddingHandoff — Read an internal proposal-to-bidding handoff receipt","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/crm/opportunities/:id/proposals/:proposal_id/bidding_handoff","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","crm","opportunities",":id","proposals",":proposal_id","bidding_handoff"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""},{"key":"proposal_id","value":""}]},"description":"Read an internal proposal-to-bidding handoff receipt\n\nRequires current CRM and bidding view permissions and crm:read plus bidding:read token scopes. Returns null when the scoped proposal has not been handed off. Older revision receipts remain readable after supersession."}},{"id":"0b7cae58-d249-4035-8fc0-b47caa226620","name":"biddingHandoffProjectCrmOpportunityProposal — Create an internal draft bidding package from a reviewed CRM proposal","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/crm/opportunities/:id/proposals/:proposal_id/bidding_handoff","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","crm","opportunities",":id","proposals",":proposal_id","bidding_handoff"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""},{"key":"proposal_id","value":""}]},"description":"Create an internal draft bidding package from a reviewed CRM proposal\n\nA new draft requires CRM view and bidding create permission with crm:read and bidding:write scopes. An identical request_key retry can recover its receipt with current CRM and bidding view plus the same token scopes, even after supersession. Rechecks current approved source and one-use review token under locks for a new draft. Creates zero bidders, invitations, forms, vendor-facing description or messages; proposal content stays only in the internal receipt. No award, contract, budget or invitation is created.","body":{"mode":"raw","raw":"{\n  \"handoff\": {\n    \"package_title\": \"\",\n    \"request_key\": \"\",\n    \"review_token\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"e2be5102-8ef7-4190-89de-ffad3abd5893","name":"createProjectCrmOpportunityProposalBiddingHandoffReviewPreview — Review an approved proposal before creating an internal draft bidding package","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/crm/opportunities/:id/proposals/:proposal_id/bidding_handoff/review_preview","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","crm","opportunities",":id","proposals",":proposal_id","bidding_handoff","review_preview"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""},{"key":"proposal_id","value":""}]},"description":"Review an approved proposal before creating an internal draft bidding package\n\nRequires CRM view and bidding create permission, enabled tools, crm:read and bidding:write token scopes. Package title must be independently entered; proposal title, scope, estimate and contact data are not copied into vendor-facing fields. Review token expires in ten minutes and is returned once.","body":{"mode":"raw","raw":"{\n  \"handoff\": {\n    \"package_title\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"e0433a5e-6e75-4eea-80a9-20481c37a020","name":"listProjectCrmOpportunityProposalCustomerResponses — List staff-recorded customer response evidence for an exact proposal revision","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/crm/opportunities/:id/proposals/:proposal_id/customer_responses","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","crm","opportunities",":id","proposals",":proposal_id","customer_responses"],"query":[{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""},{"key":"proposal_id","value":""}]},"description":"List staff-recorded customer response evidence for an exact proposal revision\n\nRequires current project CRM view and crm:read token scope. These are staff records, not verified customer authentication, delivery or signature."}},{"id":"2b0f0183-5cf3-49e0-81e5-03c75d34ff70","name":"createProjectCrmOpportunityProposalCustomerResponse — Record a staff-reported customer response with reviewed proposal and recipient evidence","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/crm/opportunities/:id/proposals/:proposal_id/customer_responses","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","crm","opportunities",":id","proposals",":proposal_id","customer_responses"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""},{"key":"proposal_id","value":""}]},"description":"Record a staff-reported customer response with reviewed proposal and recipient evidence\n\nRequires project CRM edit and crm:write token scope. The exact current approved proposal and same-project contact must still match the review token. A matching request_key retry returns 200 with the original row; the first write returns 201. This does not send an offer, verify the customer, change stage or post financial values.","body":{"mode":"raw","raw":"{\n  \"customer_response\": {\n    \"contact_id\": 0,\n    \"decision\": \"accepted\",\n    \"evidence_note\": \"\",\n    \"request_key\": \"\",\n    \"review_token\": \"\",\n    \"source\": \"email\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"08874162-348f-4dd7-8200-f8a31c356a68","name":"listProjectCrmOpportunityProposalCustomerResponsesReviewPreview — Review the current approved proposal and selected recipient before recording a staff response","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/crm/opportunities/:id/proposals/:proposal_id/customer_responses/review_preview","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","crm","opportunities",":id","proposals",":proposal_id","customer_responses","review_preview"],"query":[{"key":"contact_id","value":"","disabled":false}],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""},{"key":"proposal_id","value":""}]},"description":"Review the current approved proposal and selected recipient before recording a staff response\n\nRequires project CRM edit and crm:read token scope. The preview token is bound to the proposal snapshot, selected contact and response history."}},{"id":"6c2e53d7-8901-460b-8c18-6735fe600f1d","name":"voidProjectCrmOpportunityProposalCustomerResponse — Void a staff-recorded response with a retained reason","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/crm/opportunities/:id/proposals/:proposal_id/customer_responses/:response_id/void","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","crm","opportunities",":id","proposals",":proposal_id","customer_responses",":response_id","void"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""},{"key":"proposal_id","value":""},{"key":"response_id","value":""}]},"description":"Void a staff-recorded response with a retained reason\n\nRequires project CRM administrator and crm:write token scope. The original recipient and response evidence remain in history; a new reviewed response can then be recorded if the proposal is still current and valid.","body":{"mode":"raw","raw":"{\n  \"void\": {\n    \"reason\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"e196cbcd-c2f9-470f-8dea-09cfbf798a48","name":"listProjectCrmOpportunityProposalOffers — List frozen customer offers for an exact proposal revision","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/crm/opportunities/:id/proposals/:proposal_id/offers","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","crm","opportunities",":id","proposals",":proposal_id","offers"],"query":[{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""},{"key":"proposal_id","value":""}]},"description":"List frozen customer offers for an exact proposal revision\n\nRequires project CRM view and crm:read token scope. Metadata omits invitation secrets and PDF bytes. Offers with delivery_state not_sent have not been sent by the application."}},{"id":"5bdfd114-dbb2-4199-8782-113d550712c0","name":"createProjectCrmOpportunityProposalOffer — Freeze the current approved proposal as a customer offer and create a one-use unsent invitation link","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/crm/opportunities/:id/proposals/:proposal_id/offers","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","crm","opportunities",":id","proposals",":proposal_id","offers"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""},{"key":"proposal_id","value":""}]},"description":"Freeze the current approved proposal as a customer offer and create a one-use unsent invitation link\n\nRequires project CRM administrator and crm:write token scope. The invitation_path contains a one-time bearer secret in the URL fragment and is returned once only. Treat it as sensitive; the application does not send the link or verify delivery. Portal response is attributable to the link holder, not verified signatory authority or an electronic signature. Does not change stage, contract or budget.","body":{"mode":"raw","raw":"{\n  \"offer\": {\n    \"contact_id\": 0\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"93161c5a-fa40-47b0-8b9f-dd0befba28ce","name":"listProjectCrmOpportunityProposalOfferAuthorityEvidence — List staff-reported, unverified offer recipient authority evidence","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/crm/opportunities/:id/proposals/:proposal_id/offers/:offer_id/authority_evidence","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","crm","opportunities",":id","proposals",":proposal_id","offers",":offer_id","authority_evidence"],"query":[{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""},{"key":"proposal_id","value":""},{"key":"offer_id","value":""}]},"description":"List staff-reported, unverified offer recipient authority evidence\n\nRequires project CRM administrator and crm:read token scope. Historical evidence remains visible after offer expiry or revocation. An asserted role does not prove signer identity or authorize portal acceptance."}},{"id":"41cf34d2-0171-47e2-891a-4fa963d5944c","name":"authorityEvidenceProjectCrmOpportunityProposalOffer — Record a staff observation of the exact offer recipient's claimed authority","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/crm/opportunities/:id/proposals/:proposal_id/offers/:offer_id/authority_evidence","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","crm","opportunities",":id","proposals",":proposal_id","offers",":offer_id","authority_evidence"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""},{"key":"proposal_id","value":""},{"key":"offer_id","value":""}]},"description":"Record a staff observation of the exact offer recipient's claimed authority\n\nRequires project CRM administrator and crm:write token scope. The observation must follow offer creation, and the current contact email, active offer, approved proposal and PDF digest must match. This evidence remains unverified and does not alter portal response, contract, stage or budget.","body":{"mode":"raw","raw":"{\n  \"authority_evidence\": {\n    \"artifact_sha256\": \"\",\n    \"claimed_role\": \"authorized_signer\",\n    \"contact_id\": 0,\n    \"evidence_note\": \"\",\n    \"observed_at\": \"2026-01-31T12:00:00Z\",\n    \"recipient_email\": \"\",\n    \"request_key\": \"\",\n    \"source\": \"contact_statement\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"fd28124c-eb34-4e03-847f-e656c8182d93","name":"voidProjectCrmOpportunityProposalOfferAuthorityEvidence — Void a staff-reported authority observation while retaining its history","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/crm/opportunities/:id/proposals/:proposal_id/offers/:offer_id/authority_evidence/:evidence_id/void","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","crm","opportunities",":id","proposals",":proposal_id","offers",":offer_id","authority_evidence",":evidence_id","void"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""},{"key":"proposal_id","value":""},{"key":"offer_id","value":""},{"key":"evidence_id","value":""}]},"description":"Void a staff-reported authority observation while retaining its history\n\nRequires project CRM administrator and crm:write token scope. Does not change the offer or portal response.","body":{"mode":"raw","raw":"{\n  \"void\": {\n    \"reason\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"ba4e133a-df3a-4bc6-878c-c68015687c2c","name":"listProjectCrmOpportunityProposalOfferDeliveries — List private offer email dispatch attempts and signed delivery events","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/crm/opportunities/:id/proposals/:proposal_id/offers/:offer_id/deliveries","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","crm","opportunities",":id","proposals",":proposal_id","offers",":offer_id","deliveries"],"query":[{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""},{"key":"proposal_id","value":""},{"key":"offer_id","value":""}]},"description":"List private offer email dispatch attempts and signed delivery events\n\nRequires project CRM administrator and crm:read token scope. Provider acceptance does not prove inbox delivery. Generic webhook and Resend transports may append authenticated delivered or bounced events. Portal invitation redemption is separate first-party link-access evidence. A queued attempt persisting beyond the provider timeout has an uncertain submission outcome and is not resent automatically."}},{"id":"61b38c6d-a34a-4ce2-80cc-cd32729cc21d","name":"createProjectCrmOpportunityProposalOfferDelivery — Submit a new one-use offer link to the configured email provider once","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/crm/opportunities/:id/proposals/:proposal_id/offers/:offer_id/deliveries","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","crm","opportunities",":id","proposals",":proposal_id","offers",":offer_id","deliveries"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""},{"key":"proposal_id","value":""},{"key":"offer_id","value":""}]},"description":"Submit a new one-use offer link to the configured email provider once\n\nRequires project CRM administrator and crm:write token scope. Rotates and invalidates the original unsent invitation link. Requires a configured webhook or Resend provider; local outbox mode fails closed. No bearer link is persisted in the application database or returned by this operation. One attempt per offer; an uncertain outcome is never retried automatically. Provider acceptance is not proof of recipient delivery or identity.","body":{"mode":"raw","raw":"{\n  \"delivery\": {\n    \"request_key\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"39888ffa-9188-472e-84b2-457fce8f1ffb","name":"listProjectCrmOpportunityProposalOfferIdentityReviews — List exact-grant staff identity evidence reviews for an offer","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/crm/opportunities/:id/proposals/:proposal_id/offers/:offer_id/identity_reviews","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","crm","opportunities",":id","proposals",":proposal_id","offers",":offer_id","identity_reviews"],"query":[{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""},{"key":"proposal_id","value":""},{"key":"offer_id","value":""}]},"description":"List exact-grant staff identity evidence reviews for an offer\n\nProject CRM administrators only. Approval means staff-reviewed evidence, not legal identity proof, signer authority or a signature. Historical records remain visible after access changes."}},{"id":"5947cec0-a499-4aa2-8107-1a279e1c8634","name":"createProjectCrmOpportunityProposalOfferIdentityReview — Submit staff identity evidence for exact customer grant and frozen offer","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/crm/opportunities/:id/proposals/:proposal_id/offers/:offer_id/identity_reviews","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","crm","opportunities",":id","proposals",":proposal_id","offers",":offer_id","identity_reviews"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""},{"key":"proposal_id","value":""},{"key":"offer_id","value":""}]},"description":"Submit staff identity evidence for exact customer grant and frozen offer\n\nRequires a current customer principal and exact active grant. A separate CRM administrator must decide the review. No contract, opportunity stage or budget changes.","body":{"mode":"raw","raw":"{\n  \"identity_review\": {\n    \"artifact_sha256\": \"\",\n    \"contact_id\": 0,\n    \"evidence_note\": \"\",\n    \"evidence_reference\": \"\",\n    \"expires_at\": \"2026-01-31T12:00:00Z\",\n    \"grant_id\": 0,\n    \"method\": \"in_person_review\",\n    \"observed_at\": \"2026-01-31T12:00:00Z\",\n    \"recipient_email\": \"\",\n    \"request_key\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"b14d027a-0dd0-482b-8803-d72f3364e880","name":"createProjectCrmOpportunityProposalOfferIdentityReviewDecision — Independently approve, reject or revoke a staff identity evidence review","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/crm/opportunities/:id/proposals/:proposal_id/offers/:offer_id/identity_reviews/:review_id/decisions","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","crm","opportunities",":id","proposals",":proposal_id","offers",":offer_id","identity_reviews",":review_id","decisions"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""},{"key":"proposal_id","value":""},{"key":"offer_id","value":""},{"key":"review_id","value":""}]},"description":"Independently approve, reject or revoke a staff identity evidence review\n\nApproval or rejection requires an administrator other than the submitter. Any current CRM administrator may revoke an approval with a reason. Approval is current only while the exact offer and customer grant remain current; it is never a legal signature.","body":{"mode":"raw","raw":"{\n  \"decision\": {\n    \"kind\": \"approved\",\n    \"reason\": \"\",\n    \"request_key\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"57397861-8250-44f1-8205-957a3d2980ef","name":"revokeProjectCrmOpportunityProposalOffer — Revoke a customer offer invitation and all open portal sessions","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/crm/opportunities/:id/proposals/:proposal_id/offers/:offer_id/revoke","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","crm","opportunities",":id","proposals",":proposal_id","offers",":offer_id","revoke"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""},{"key":"proposal_id","value":""},{"key":"offer_id","value":""}]},"description":"Revoke a customer offer invitation and all open portal sessions\n\nRequires project CRM administrator and crm:write token scope. The original offer and any link-holder response remain in history; the reason is retained.","body":{"mode":"raw","raw":"{\n  \"revoke\": {\n    \"reason\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"81863ced-412f-4ec1-89d7-a88c017b4178","name":"reviewProjectCrmOpportunityProposal — Approve or reject a submitted proposal for internal review","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/crm/opportunities/:id/proposals/:proposal_id/review","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","crm","opportunities",":id","proposals",":proposal_id","review"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""},{"key":"proposal_id","value":""}]},"description":"Approve or reject a submitted proposal for internal review","body":{"mode":"raw","raw":"{\n  \"review\": {\n    \"decision\": \"approved\",\n    \"review_token\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"96d1a35e-80cf-4a57-8f57-907907430661","name":"listProjectCrmOpportunityProposalReviewPreview — Review the current submitted proposal and obtain a fresh review token","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/crm/opportunities/:id/proposals/:proposal_id/review_preview","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","crm","opportunities",":id","proposals",":proposal_id","review_preview"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""},{"key":"proposal_id","value":""}]},"description":"Review the current submitted proposal and obtain a fresh review token"}},{"id":"644ceb68-35ab-446b-87d8-ffd831cff514","name":"submitProjectCrmOpportunityProposal — Submit the current draft for internal review","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/crm/opportunities/:id/proposals/:proposal_id/submit","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","crm","opportunities",":id","proposals",":proposal_id","submit"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""},{"key":"proposal_id","value":""}]},"description":"Submit the current draft for internal review"}},{"id":"1da93bd8-29c8-458b-8bea-d238d88849e0","name":"withdrawProjectCrmOpportunityProposal — Withdraw the current draft or submitted proposal with a retained reason","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/crm/opportunities/:id/proposals/:proposal_id/withdraw","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","crm","opportunities",":id","proposals",":proposal_id","withdraw"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""},{"key":"proposal_id","value":""}]},"description":"Withdraw the current draft or submitted proposal with a retained reason","body":{"mode":"raw","raw":"{\n  \"withdrawal\": {\n    \"reason\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"046f6c6c-e25a-4b0e-8f64-939c73644510","name":"restoreProjectCrmOpportunity — Restore archived CRM opportunity","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/crm/opportunities/:id/restore","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","crm","opportunities",":id","restore"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Restore archived CRM opportunity\n\nClears archived_at so the opportunity returns to lists, summaries, forecasts and cohorts. Project CRM edit permission and crm:write, as for DELETE. Repeating the request, or restoring an active record, is a no-op. Records a restored history entry."}},{"id":"03fa6fc0-1280-41d6-8519-1f22070b5a24","name":"listProjectCrmOpportunitySourceHistory — Paginated staff-attributed opportunity source history","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/crm/opportunities/:id/source_history","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","crm","opportunities",":id","source_history"],"query":[{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Paginated staff-attributed opportunity source history\n\nBackfilled legacy opportunities begin with an unknown baseline; corrections preserve before/after values and staff reason. Requires current CRM scope access."}},{"id":"2ec18464-d91f-4c77-8231-1bb8e0f1b413","name":"listProjectCrmServiceCases — List private project customer service cases","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/crm/service_cases","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","crm","service_cases"],"query":[{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true},{"key":"status","value":"","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"List private project customer service cases\n\nRequires current project CRM view and crm:read token scope. List entries omit detailed event history; read an individual case for its events."}},{"id":"4a3f8d94-ecc3-4ec0-8023-9a673ac438e3","name":"createProjectCrmServiceCase — Record a staff-reported customer service request","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/crm/service_cases","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","crm","service_cases"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Record a staff-reported customer service request\n\nRequires project CRM create and crm:write token scope. Requester contact, location and assignee are scoped to the project. Does not send a customer message.","body":{"mode":"raw","raw":"{\n  \"service_case\": {\n    \"report_evidence\": \"\",\n    \"report_source\": \"phone\",\n    \"reported_at\": \"2026-01-31T12:00:00Z\",\n    \"title\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"c13de6d8-91b6-40e3-86e3-9f7952ad17ec","name":"listProjectCrmServiceCasesResponseQueue — Read the permission-scoped staff first-response worklist","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/crm/service_cases/response_queue","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","crm","service_cases","response_queue"],"query":[{"key":"filter","value":"","disabled":true},{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Read the permission-scoped staff first-response worklist\n\nRequires project CRM view and crm:read. Derived overdue and due-soon states use one server capture time. This queue does not send notifications or establish a contractual SLA."}},{"id":"ea9f4c70-4fea-4773-8320-062e4fcaa891","name":"getProjectCrmServiceCase — Read a private service case and event history","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/crm/service_cases/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","crm","service_cases",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Read a private service case and event history"}},{"id":"c6ce3a06-a101-42d1-8dd3-c1ef2de35cf1","name":"updateProjectCrmServiceCase — Record a version-checked service case update","request":{"method":"PATCH","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/crm/service_cases/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","crm","service_cases",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Record a version-checked service case update\n\nRequires project CRM edit and crm:write token scope. Customer response and warranty decisions require explicit evidence; status transitions do not change field-tool records.","body":{"mode":"raw","raw":"{\n  \"service_case\": {\n    \"version\": 0\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"07f99440-bc67-4a4b-8d58-623cbe15d31b","name":"listProjectCrmServiceCaseAssetLinks — List active installed assets linked to a service case","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/crm/service_cases/:id/asset_links","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","crm","service_cases",":id","asset_links"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"List active installed assets linked to a service case"}},{"id":"63b7b3f3-c3d6-46f8-8eb7-2ddeedc25018","name":"createProjectCrmServiceCaseAssetLink — Link a same-project active installed asset to a service case","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/crm/service_cases/:id/asset_links","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","crm","service_cases",":id","asset_links"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Link a same-project active installed asset to a service case\n\nRequires CRM edit and crm:write. Does not make a warranty eligibility decision or alter the asset.","body":{"mode":"raw","raw":"{\n  \"asset_link\": {\n    \"asset_id\": 0\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"9712a738-4d0b-4ea0-8bd7-0c99cf457d88","name":"deleteProjectCrmServiceCaseAssetLink — Remove a case-to-asset association and retain history","request":{"method":"DELETE","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/crm/service_cases/:id/asset_links/:link_id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","crm","service_cases",":id","asset_links",":link_id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""},{"key":"link_id","value":""}]},"description":"Remove a case-to-asset association and retain history","body":{"mode":"raw","raw":"{\n  \"note\": \"\"\n}","options":{"raw":{"language":"json"}}}}},{"id":"70ee86e8-3ae9-4774-8f05-601ee987e7d0","name":"listProjectCrmServiceCaseWorkLinks — List currently visible field work linked to a service case","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/crm/service_cases/:id/work_links","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","crm","service_cases",":id","work_links"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"List currently visible field work linked to a service case\n\nRequires crm:read and current item-level visibility in Punch List, Observations or Tasks. Scoped tokens also need the corresponding target tool read scope. Hidden or deleted links are omitted entirely, including their IDs and counts."}},{"id":"b979a563-21f6-4928-8bf5-b4041c7031f2","name":"createProjectCrmServiceCaseWorkLink — Link one currently visible field work item to a service case","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/crm/service_cases/:id/work_links","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","crm","service_cases",":id","work_links"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Link one currently visible field work item to a service case\n\nRequires CRM edit and crm:write plus target tool read and item-level visibility. Link evidence is retained separately from the general case event history to prevent hidden-link disclosure.","body":{"mode":"raw","raw":"{\n  \"work_link\": {\n    \"kind\": \"punch_item\",\n    \"target_id\": 0\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"0384845e-04cf-4ca6-8bfd-2eb57f948010","name":"deleteProjectCrmServiceCaseWorkLink — Remove a currently visible service-to-field-work association","request":{"method":"DELETE","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/crm/service_cases/:id/work_links/:link_id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","crm","service_cases",":id","work_links",":link_id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""},{"key":"link_id","value":""}]},"description":"Remove a currently visible service-to-field-work association\n\nRequires CRM edit, crm:write, current target item visibility and target tool read scope. Revocation retains private link evidence without changing general case history.","body":{"mode":"raw","raw":"{\n  \"note\": \"\"\n}","options":{"raw":{"language":"json"}}}}},{"id":"9db79da8-ef07-42a7-8a74-da705da9f66d","name":"listProjectCrmSummary — CRM totals and exact USD pipeline forecast","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/crm/summary","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","crm","summary"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"CRM totals and exact USD pipeline forecast"}},{"id":"bef5fb8c-cbe3-4103-8645-6e0d74d84e9f","name":"listProjectCrmWarrantyCoverages — List reviewed project warranty coverage evidence","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/crm/warranty_coverages","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","crm","warranty_coverages"],"query":[{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true},{"key":"search","value":"","disabled":true},{"key":"location_id","value":"","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"List reviewed project warranty coverage evidence\n\nRequires project CRM view and crm:read token scope. Dates do not automatically decide eligibility."}},{"id":"bb3083fa-c142-4d21-8649-e8160fefaf2e","name":"createProjectCrmWarrantyCoverage — Record reviewed project warranty coverage evidence","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/crm/warranty_coverages","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","crm","warranty_coverages"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Record reviewed project warranty coverage evidence\n\nRequires project CRM create and crm:write token scope. Records a source and exact term without inferring from project completion.","body":{"mode":"raw","raw":"{\n  \"warranty_coverage\": {\n    \"component_name\": \"\",\n    \"ends_on\": \"2026-01-31\",\n    \"evidence_note\": \"\",\n    \"issuer_name\": \"\",\n    \"source_reference\": \"\",\n    \"starts_on\": \"2026-01-31\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"9d47f9c2-4807-48a5-8721-1289b3765959","name":"getProjectCrmWarrantyCoverage — Read one private project warranty coverage source","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/crm/warranty_coverages/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","crm","warranty_coverages",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Read one private project warranty coverage source\n\nRequires current project CRM view and crm:read token scope."}}]},{"name":"Daily Log","description":"Module: daily_log","item":[{"id":"f1bd1525-36ce-4ff0-8cea-4da08d09261e","name":"listProjectAccidentLogs — List Accident Logs","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/accident_logs","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","accident_logs"],"query":[{"key":"per_page","value":"100","disabled":true},{"key":"page","value":"1","disabled":true},{"key":"log_date","value":"","disabled":true},{"key":"start_date","value":"","disabled":true},{"key":"end_date","value":"","disabled":true},{"key":"filters[created_by_id]","value":"","disabled":true},{"key":"filters[location_id]","value":"","disabled":true},{"key":"filters[daily_log_segment_id]","value":"","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"List Accident Logs"}},{"id":"1ad933c4-5120-4c0d-89a5-c93f166cc84d","name":"createProjectAccidentLog — Create Accident Log","request":{"method":"POST","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/accident_logs","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","accident_logs"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Create Accident Log","body":{"mode":"raw","raw":"{\n  \"accident_log\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"a0566681-22b9-46d3-8060-a45727558753","name":"getProjectAccidentLog — Show Accident Logs","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/accident_logs/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","accident_logs",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Show Accident Logs"}},{"id":"f2fb63d4-f1fe-49c4-80f7-3c579dd7d1f4","name":"updateProjectAccidentLog — Update Accident Log","request":{"method":"PATCH","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/accident_logs/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","accident_logs",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Update Accident Log","body":{"mode":"raw","raw":"{\n  \"accident_log\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"b5607f47-5cf0-47de-82ac-54594b357a5a","name":"deleteProjectAccidentLog — Delete Accident Log","request":{"method":"DELETE","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/accident_logs/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","accident_logs",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Delete Accident Log"}},{"id":"01ced5de-9beb-4dd3-81eb-2863f7c05856","name":"listProjectCallLogs — List Call Logs","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/call_logs","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","call_logs"],"query":[{"key":"log_date","value":"","disabled":true},{"key":"start_date","value":"","disabled":true},{"key":"end_date","value":"","disabled":true},{"key":"filters[created_by_id]","value":"","disabled":true},{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true},{"key":"filters[daily_log_segment_id]","value":"","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"List Call Logs"}},{"id":"806956dd-48e1-4eec-862f-e05864119b5e","name":"createProjectCallLog — Create Call Log","request":{"method":"POST","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/call_logs","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","call_logs"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Create Call Log","body":{"mode":"raw","raw":"{\n  \"call_log\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"e4840078-44bc-4931-8aba-306230084900","name":"getProjectCallLog — Show Call Logs","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/call_logs/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","call_logs",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Show Call Logs"}},{"id":"572f8b80-a76a-4e1e-89d2-9942cac96ce1","name":"updateProjectCallLog — Update Call Log","request":{"method":"PATCH","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/call_logs/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","call_logs",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Update Call Log","body":{"mode":"raw","raw":"{\n  \"call_log\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"06dcccca-3810-4d41-8a40-c8c57b9108ca","name":"deleteProjectCallLog — Delete Call Log","request":{"method":"DELETE","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/call_logs/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","call_logs",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Delete Call Log"}},{"id":"ba848e2f-13e9-4081-8f3e-643a0149afda","name":"listProjectDailyConstructionReportLogs — List Daily Construction Report Logs","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/daily_construction_report_logs","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","daily_construction_report_logs"],"query":[{"key":"log_date","value":"","disabled":true},{"key":"start_date","value":"","disabled":true},{"key":"end_date","value":"","disabled":true},{"key":"filters[status]","value":"","disabled":true},{"key":"filters[created_by_id]","value":"","disabled":true},{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true},{"key":"filters[daily_log_segment_id]","value":"","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"List Daily Construction Report Logs"}},{"id":"6a36163e-9409-4568-8c1a-00e7063be73d","name":"createProjectDailyConstructionReportLog — Create Daily Construction Report Log","request":{"method":"POST","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/daily_construction_report_logs","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","daily_construction_report_logs"],"query":[{"key":"run_configurable_validations","value":"","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Create Daily Construction Report Log","body":{"mode":"raw","raw":"{\n  \"daily_construction_report_log\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"4986e8d3-3902-4882-8672-98511569fa65","name":"listProjectDailyConstructionReportLogsVendorOptions — List Daily Construction Report Logs Vendor Options","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/daily_construction_report_logs/vendor_options","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","daily_construction_report_logs","vendor_options"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"List Daily Construction Report Logs Vendor Options"}},{"id":"13fda45e-5333-4b4a-8b26-fd5ca68a34fa","name":"getProjectDailyConstructionReportLog — Show Daily Construction Report Logs","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/daily_construction_report_logs/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","daily_construction_report_logs",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Show Daily Construction Report Logs"}},{"id":"93baa8eb-f6c9-4358-838b-3c53cfd3d122","name":"updateProjectDailyConstructionReportLog — Update Daily Construction Report Log","request":{"method":"PATCH","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/daily_construction_report_logs/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","daily_construction_report_logs",":id"],"query":[{"key":"run_configurable_validations","value":"","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Update Daily Construction Report Log","body":{"mode":"raw","raw":"{\n  \"daily_construction_report_log\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"3cc3b3ee-dae3-4aeb-812a-9b7b01a322a2","name":"deleteProjectDailyConstructionReportLog — Delete Daily Construction Report Log","request":{"method":"DELETE","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/daily_construction_report_logs/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","daily_construction_report_logs",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Delete Daily Construction Report Log"}},{"id":"13af4eec-dd0f-4238-8df5-a83ecfed4f04","name":"listProjectDailyLogHeaders — Get the Daily Log Header via date or id","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/daily_log_headers","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","daily_log_headers"],"query":[{"key":"id","value":"","disabled":true},{"key":"log_date","value":"","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Get the Daily Log Header via date or id"}},{"id":"3eaeeee3-6a51-47e4-8245-983a7520622f","name":"updateProjectDailyLogHeaders — Update the state of a Daily Log Header","request":{"method":"PATCH","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/daily_log_headers","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","daily_log_headers"],"query":[{"key":"id","value":"","disabled":true},{"key":"log_date","value":"","disabled":true},{"key":"app_name","value":"","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Update the state of a Daily Log Header","body":{"mode":"raw","raw":"{\n  \"daily_log_header\": {\n    \"completed\": false,\n    \"distributed\": false\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"873a9139-116d-43f8-8c18-29503e57b8bf","name":"listProjectDailyLogHeadersIndex — Get Daily Log Headers for the Project","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/daily_log_headers/index","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","daily_log_headers","index"],"query":[{"key":"start_date","value":"","disabled":true},{"key":"end_date","value":"","disabled":true},{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Get Daily Log Headers for the Project"}},{"id":"1b7d18d4-c9a2-477c-8533-4d83ad83984f","name":"updateProjectDailyLogsBulkUpdatesBulkUpdate — Bulk Updates for Daily Logs","request":{"method":"PATCH","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/daily_logs/bulk_updates/bulk_update","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","daily_logs","bulk_updates","bulk_update"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Bulk Updates for Daily Logs","body":{"mode":"raw","raw":"{\n  \"updates\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"a3941184-9f9e-4dd5-8ff7-cb510009d987","name":"createProjectDailyLogsClone — Clones Daily Logs from one Date to another Date","request":{"method":"POST","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/daily_logs/clones","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","daily_logs","clones"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Clones Daily Logs from one Date to another Date","body":{"mode":"raw","raw":"{\n  \"daily_log_segment_id\": 0,\n  \"from_date\": \"2026-01-31\",\n  \"log_types\": [\n    \"accident_log\"\n  ],\n  \"to_date\": \"2026-01-31\"\n}","options":{"raw":{"language":"json"}}}}},{"id":"1385cf34-52ec-4507-82aa-82cdcdcfe165","name":"listProjectDailyLogsCount — List Counts of Daily Logs","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/daily_logs/count","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","daily_logs","count"],"query":[{"key":"log_date","value":"","disabled":true},{"key":"start_date","value":"","disabled":true},{"key":"end_date","value":"","disabled":true},{"key":"filters[status]","value":"","disabled":true},{"key":"filters[created_by_id]","value":"","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"List Counts of Daily Logs"}},{"id":"35fedead-3f5e-43f0-83cf-b589874b0d4e","name":"listProjectDailyLogsDelayLogTypes — List Delay Log Types","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/daily_logs/delay_log_types","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","daily_logs","delay_log_types"],"query":[{"key":"filters[visible]","value":"","disabled":true},{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"List Delay Log Types"}},{"id":"879d8932-5fe5-4376-8355-5fc684b8b048","name":"createProjectDailyLogsDelayLogType — Create new Delay Log Type","request":{"method":"POST","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/daily_logs/delay_log_types","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","daily_logs","delay_log_types"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Create new Delay Log Type","body":{"mode":"raw","raw":"{\n  \"delay_log_type\": {\n    \"display_name\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"cb85a447-3d85-4e38-8909-51793307e79f","name":"updateProjectDailyLogsDelayLogType — Update a Delay Log Type","request":{"method":"PATCH","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/daily_logs/delay_log_types/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","daily_logs","delay_log_types",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Update a Delay Log Type","body":{"mode":"raw","raw":"{\n  \"delay_log_type\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"61948376-6114-4ae4-8469-03e161668765","name":"listProjectDailyLogsWeatherConditions — List Accepted Weather Conditions","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/daily_logs/weather_conditions","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","daily_logs","weather_conditions"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"List Accepted Weather Conditions"}},{"id":"a8c36e12-2726-4ce0-8a03-dea47a175a55","name":"createProjectDailyLogAttachment — Upload daily log attachment","request":{"method":"POST","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/daily_logs/:log_type/:id/attachments","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","daily_logs",":log_type",":id","attachments"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"log_type","value":""},{"key":"id","value":""}]},"description":"Upload daily log attachment"}},{"id":"f407902e-f6a0-46c7-839a-18df9e8e544b","name":"listProjectDelayLogs — List Delay Logs","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/delay_logs","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","delay_logs"],"query":[{"key":"log_date","value":"","disabled":true},{"key":"start_date","value":"","disabled":true},{"key":"end_date","value":"","disabled":true},{"key":"filters[created_by_id]","value":"","disabled":true},{"key":"filters[location_id]","value":"","disabled":true},{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true},{"key":"filters[daily_log_segment_id]","value":"","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"List Delay Logs"}},{"id":"ced23c64-38a4-4acc-8e83-33bb46bba672","name":"createProjectDelayLog — Create Delay Log","request":{"method":"POST","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/delay_logs","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","delay_logs"],"query":[{"key":"run_configurable_validations","value":"","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Create Delay Log","body":{"mode":"raw","raw":"{\n  \"delay_log\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"b3e813d9-c456-4d9a-8afa-24f1821c78fc","name":"getProjectDelayLog — Show Delay Logs","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/delay_logs/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","delay_logs",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Show Delay Logs"}},{"id":"03d7b7e3-077e-4f86-8e70-4b89ad16434e","name":"updateProjectDelayLog — Update Delay Log","request":{"method":"PATCH","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/delay_logs/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","delay_logs",":id"],"query":[{"key":"run_configurable_validations","value":"","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Update Delay Log","body":{"mode":"raw","raw":"{\n  \"delay_log\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"b06fe7aa-da60-41c1-8485-dc2095a4f4ed","name":"deleteProjectDelayLog — Delete Delay Log","request":{"method":"DELETE","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/delay_logs/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","delay_logs",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Delete Delay Log"}},{"id":"60e82710-b64d-4b98-8ad1-cba3e40cb40d","name":"listProjectDeliveryLogs — List Delivery Logs","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/delivery_logs","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","delivery_logs"],"query":[{"key":"log_date","value":"","disabled":true},{"key":"start_date","value":"","disabled":true},{"key":"end_date","value":"","disabled":true},{"key":"filters[status]","value":"","disabled":true},{"key":"filters[created_by_id]","value":"","disabled":true},{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true},{"key":"filters[daily_log_segment_id]","value":"","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"List Delivery Logs"}},{"id":"95c334e0-6a26-4d69-881b-bc71795b26f9","name":"createProjectDeliveryLog — Create Delivery Log","request":{"method":"POST","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/delivery_logs","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","delivery_logs"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Create Delivery Log","body":{"mode":"raw","raw":"{\n  \"delivery_log\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"0632ab86-cc17-4b9d-83db-86e81beca677","name":"getProjectDeliveryLog — Show Delivery Log","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/delivery_logs/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","delivery_logs",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Show Delivery Log"}},{"id":"cc9b69ff-bcc2-4fb2-8f43-03204873e72d","name":"updateProjectDeliveryLog — Update Delivery Log","request":{"method":"PATCH","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/delivery_logs/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","delivery_logs",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Update Delivery Log","body":{"mode":"raw","raw":"{\n  \"delivery_log\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"9195ebc3-1267-44ce-8e4e-cdb5d1ec45c9","name":"deleteProjectDeliveryLog — Delete Delivery Log","request":{"method":"DELETE","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/delivery_logs/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","delivery_logs",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Delete Delivery Log"}},{"id":"65af153d-43dc-408e-8e73-f6bc9164bd50","name":"listProjectDumpsterLogs — List Dumpster Logs","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/dumpster_logs","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","dumpster_logs"],"query":[{"key":"log_date","value":"","disabled":true},{"key":"start_date","value":"","disabled":true},{"key":"end_date","value":"","disabled":true},{"key":"filters[created_by_id]","value":"","disabled":true},{"key":"filters[vendor_id]","value":"","disabled":true},{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true},{"key":"filters[daily_log_segment_id]","value":"","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"List Dumpster Logs"}},{"id":"4e6e6086-a81a-4fd5-8b68-f64a5077d511","name":"createProjectDumpsterLog — Create Dumpster Log","request":{"method":"POST","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/dumpster_logs","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","dumpster_logs"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Create Dumpster Log","body":{"mode":"raw","raw":"{\n  \"dumpster_log\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"f9bbea76-47e3-41e5-8485-831ea2e4bdbf","name":"getProjectDumpsterLog — Show Dumpster Logs","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/dumpster_logs/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","dumpster_logs",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Show Dumpster Logs"}},{"id":"6369bf62-6f2a-49fe-8176-2265964779df","name":"updateProjectDumpsterLog — Update Dumpster Log","request":{"method":"PATCH","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/dumpster_logs/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","dumpster_logs",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Update Dumpster Log","body":{"mode":"raw","raw":"{\n  \"dumpster_log\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"55af5c11-3aa8-4954-8a52-3ad982ac81b0","name":"deleteProjectDumpsterLog — Delete Dumpster Log","request":{"method":"DELETE","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/dumpster_logs/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","dumpster_logs",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Delete Dumpster Log"}},{"id":"aec4635b-f58b-41a4-81c4-c7c86dc52043","name":"listProjectEquipmentLogs — List Equipment Logs","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/equipment_logs","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","equipment_logs"],"query":[{"key":"log_date","value":"","disabled":true},{"key":"start_date","value":"","disabled":true},{"key":"end_date","value":"","disabled":true},{"key":"filters[created_by_id]","value":"","disabled":true},{"key":"filters[location_id]","value":"","disabled":true},{"key":"per_page","value":"100","disabled":true},{"key":"page","value":"1","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"List Equipment Logs"}},{"id":"83282adb-6500-4785-8b85-c275a1ecd1d4","name":"createProjectEquipmentLog — Create Equipment Log","request":{"method":"POST","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/equipment_logs","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","equipment_logs"],"query":[{"key":"run_configurable_validations","value":"","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Create Equipment Log","body":{"mode":"raw","raw":"{\n  \"equipment_log\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"e935c36e-7c23-40db-8921-37b2724bf736","name":"getProjectEquipmentLog — Show Equipment Logs","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/equipment_logs/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","equipment_logs",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Show Equipment Logs"}},{"id":"2829913b-8650-41c6-8ead-537d9270a0ec","name":"updateProjectEquipmentLog — Update Equipment Log","request":{"method":"PATCH","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/equipment_logs/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","equipment_logs",":id"],"query":[{"key":"run_configurable_validations","value":"","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Update Equipment Log","body":{"mode":"raw","raw":"{\n  \"equipment_log\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"8e61be95-778e-4696-893a-978391de212c","name":"deleteProjectEquipmentLog — Delete Equipment Log","request":{"method":"DELETE","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/equipment_logs/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","equipment_logs",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Delete Equipment Log"}},{"id":"06591f7e-9ada-40af-8757-673b25eac50e","name":"listProjectManpowerLogs — List Manpower Logs","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/manpower_logs","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","manpower_logs"],"query":[{"key":"log_date","value":"","disabled":true},{"key":"start_date","value":"","disabled":true},{"key":"end_date","value":"","disabled":true},{"key":"filters[status]","value":"","disabled":true},{"key":"filters[created_by_id]","value":"","disabled":true},{"key":"filters[location_id]","value":"","disabled":true},{"key":"filters[vendor_id]","value":"","disabled":true},{"key":"filters[search]","value":"","disabled":true},{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true},{"key":"filters[daily_log_segment_id]","value":"","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"List Manpower Logs"}},{"id":"a97b49f1-451c-4e9c-8fbb-958326727b44","name":"createProjectManpowerLog — Create Manpower Log","request":{"method":"POST","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/manpower_logs","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","manpower_logs"],"query":[{"key":"run_configurable_validations","value":"","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Create Manpower Log","body":{"mode":"raw","raw":"{\n  \"manpower_log\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"4d3a5c64-4c87-4dec-86f0-df2e7be769f4","name":"listProjectManpowerLogsContactOptions — List Manpower Logs Contact Options","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/manpower_logs/contact_options","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","manpower_logs","contact_options"],"query":[{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true},{"key":"filters[is_employee]","value":"","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"List Manpower Logs Contact Options"}},{"id":"aa1f20da-4e42-4d19-8696-4868e598669f","name":"listProjectManpowerLogsDailyTotals — Get total workers and man hours","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/manpower_logs/daily_totals","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","manpower_logs","daily_totals"],"query":[{"key":"start_date","value":"","disabled":true},{"key":"end_date","value":"","disabled":true},{"key":"filters[created_by_id]","value":"","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Get total workers and man hours"}},{"id":"5020eecb-12e5-4b3a-8a0b-b8e50137d568","name":"listProjectManpowerLogsVendorOptions — List Manpower Logs Vendor Options","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/manpower_logs/vendor_options","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","manpower_logs","vendor_options"],"query":[{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"List Manpower Logs Vendor Options"}},{"id":"0b8f4eb7-52e9-4220-88ee-eeb5a445a430","name":"getProjectManpowerLog — Show Manpower Logs","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/manpower_logs/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","manpower_logs",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Show Manpower Logs"}},{"id":"9ee34661-4f77-4ed6-86ca-8ca3156c52ce","name":"updateProjectManpowerLog — Update Manpower Log","request":{"method":"PATCH","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/manpower_logs/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","manpower_logs",":id"],"query":[{"key":"run_configurable_validations","value":"","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Update Manpower Log","body":{"mode":"raw","raw":"{\n  \"manpower_log\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"b3abecbf-b47e-44df-8090-6c761a4d12a7","name":"deleteProjectManpowerLog — Delete Manpower Log","request":{"method":"DELETE","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/manpower_logs/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","manpower_logs",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Delete Manpower Log"}},{"id":"55f023b5-ec83-49e5-84fa-e1038161b037","name":"listProjectNotesLogs — List Notes Logs","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/notes_logs","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","notes_logs"],"query":[{"key":"log_date","value":"","disabled":true},{"key":"start_date","value":"","disabled":true},{"key":"end_date","value":"","disabled":true},{"key":"filters[status]","value":"","disabled":true},{"key":"filters[created_by_id]","value":"","disabled":true},{"key":"filters[location_id]","value":"","disabled":true},{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true},{"key":"filters[daily_log_segment_id]","value":"","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"List Notes Logs"}},{"id":"b2dda691-ae1b-4347-894e-026f22c57e16","name":"createProjectNotesLog — Create Notes Log","request":{"method":"POST","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/notes_logs","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","notes_logs"],"query":[{"key":"run_configurable_validations","value":"","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Create Notes Log","body":{"mode":"raw","raw":"{\n  \"notes_log\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"61469407-c084-41c7-8e69-96724e64ed50","name":"getProjectNotesLog — Show Notes Logs","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/notes_logs/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","notes_logs",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Show Notes Logs"}},{"id":"23ba18d6-e1a8-4dca-8e5b-aeffae3c1aae","name":"updateProjectNotesLog — Update Notes Log","request":{"method":"PATCH","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/notes_logs/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","notes_logs",":id"],"query":[{"key":"run_configurable_validations","value":"","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Update Notes Log","body":{"mode":"raw","raw":"{\n  \"notes_log\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"4b05d962-4637-4cd4-87bf-071fe50d9cce","name":"deleteProjectNotesLog — Delete Notes Log","request":{"method":"DELETE","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/notes_logs/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","notes_logs",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Delete Notes Log"}},{"id":"2cc9f642-38d3-4d62-8d91-766a320e3e69","name":"listProjectPlanRevisionLogs — List Plan Revision Logs","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/plan_revision_logs","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","plan_revision_logs"],"query":[{"key":"log_date","value":"","disabled":true},{"key":"start_date","value":"","disabled":true},{"key":"end_date","value":"","disabled":true},{"key":"filters[created_by_id]","value":"","disabled":true},{"key":"filters[daily_log_segment_id]","value":"","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"List Plan Revision Logs"}},{"id":"ab7791c3-991f-42ca-847c-ba20eba0e819","name":"createProjectPlanRevisionLog — Create Plan Revision Log","request":{"method":"POST","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/plan_revision_logs","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","plan_revision_logs"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Create Plan Revision Log","body":{"mode":"raw","raw":"{\n  \"plan_revision_log\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"9c44ca95-53bd-451f-8239-030cf4a6d29b","name":"getProjectPlanRevisionLog — Show Plan Revision Logs","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/plan_revision_logs/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","plan_revision_logs",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Show Plan Revision Logs"}},{"id":"162664e5-3c2b-437d-800c-474018320863","name":"updateProjectPlanRevisionLog — Update Plan Revision Log","request":{"method":"PATCH","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/plan_revision_logs/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","plan_revision_logs",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Update Plan Revision Log","body":{"mode":"raw","raw":"{\n  \"plan_revision_log\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"ef353f56-d054-4c72-8ba9-e664c4b09efd","name":"deleteProjectPlanRevisionLog — Delete Plan Revision Log","request":{"method":"DELETE","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/plan_revision_logs/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","plan_revision_logs",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Delete Plan Revision Log"}},{"id":"899b571c-da24-45c6-8586-d980e1d9b959","name":"listProjectProductivityLogs — List Productivity Logs","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/productivity_logs","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","productivity_logs"],"query":[{"key":"log_date","value":"","disabled":true},{"key":"start_date","value":"","disabled":true},{"key":"end_date","value":"","disabled":true},{"key":"filters[created_by_id]","value":"","disabled":true},{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true},{"key":"filters[daily_log_segment_id]","value":"","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"List Productivity Logs"}},{"id":"b998b409-b6fd-475b-822c-40a1f68cd8bb","name":"createProjectProductivityLog — Create Productivity Log","request":{"method":"POST","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/productivity_logs","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","productivity_logs"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Create Productivity Log","body":{"mode":"raw","raw":"{\n  \"productivity_log\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"2969d59b-0868-4228-8148-ec52a9cce08a","name":"getProjectProductivityLog — Show Productivity Logs","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/productivity_logs/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","productivity_logs",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Show Productivity Logs"}},{"id":"88c00bcc-ccd9-4f9a-8977-094b6184dfc5","name":"updateProjectProductivityLog — Update Productivity Log","request":{"method":"PATCH","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/productivity_logs/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","productivity_logs",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Update Productivity Log","body":{"mode":"raw","raw":"{\n  \"productivity_log\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"b63562b6-e5db-45c9-8f96-b2663f6ba7a1","name":"deleteProjectProductivityLog — Delete Productivity Log","request":{"method":"DELETE","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/productivity_logs/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","productivity_logs",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Delete Productivity Log"}},{"id":"c732e76f-dacf-4407-8450-f8398b3ec239","name":"listProjectQuantityLogs — List Quantity Logs","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/quantity_logs","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","quantity_logs"],"query":[{"key":"log_date","value":"","disabled":true},{"key":"start_date","value":"","disabled":true},{"key":"end_date","value":"","disabled":true},{"key":"filters[created_by_id]","value":"","disabled":true},{"key":"filters[location_id]","value":"","disabled":true},{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true},{"key":"filters[daily_log_segment_id]","value":"","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"List Quantity Logs"}},{"id":"f8f6762d-0e1a-428f-88fa-339c5b6e641e","name":"createProjectQuantityLog — Create Quantity Log","request":{"method":"POST","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/quantity_logs","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","quantity_logs"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Create Quantity Log","body":{"mode":"raw","raw":"{\n  \"quantity_log\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"2bb359fa-0b48-4a4e-87ba-4d0287a69c26","name":"getProjectQuantityLog — Show Quantity Logs","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/quantity_logs/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","quantity_logs",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Show Quantity Logs"}},{"id":"5aa8d288-cd4f-4ab2-84dd-241bd1746dd8","name":"updateProjectQuantityLog — Update Quantity Log","request":{"method":"PATCH","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/quantity_logs/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","quantity_logs",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Update Quantity Log","body":{"mode":"raw","raw":"{\n  \"quantity_log\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"efd1aa1e-8d4a-4c6b-8ebe-08a1fa0da565","name":"deleteProjectQuantityLog — Delete Quantity Log","request":{"method":"DELETE","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/quantity_logs/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","quantity_logs",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Delete Quantity Log"}},{"id":"4d5efa7b-4877-4625-8a0f-c376a8ca3f4c","name":"listProjectSafetyViolationLogs — List Safety Violation Logs","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/safety_violation_logs","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","safety_violation_logs"],"query":[{"key":"log_date","value":"","disabled":true},{"key":"start_date","value":"","disabled":true},{"key":"end_date","value":"","disabled":true},{"key":"filters[created_by_id]","value":"","disabled":true},{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true},{"key":"filters[daily_log_segment_id]","value":"","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"List Safety Violation Logs"}},{"id":"4513a994-b90c-4f93-80c4-7cf284951142","name":"createProjectSafetyViolationLog — Create Safety Violation Log","request":{"method":"POST","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/safety_violation_logs","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","safety_violation_logs"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Create Safety Violation Log","body":{"mode":"raw","raw":"{\n  \"safety_violation_log\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"253f7f5d-d6c0-4dd1-8d2b-e6d1b97ee039","name":"getProjectSafetyViolationLog — Show Safety Violation Logs","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/safety_violation_logs/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","safety_violation_logs",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Show Safety Violation Logs"}},{"id":"580be836-c768-446e-8d77-e2e5fd714157","name":"updateProjectSafetyViolationLog — Update Safety Violation Log","request":{"method":"PATCH","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/safety_violation_logs/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","safety_violation_logs",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Update Safety Violation Log","body":{"mode":"raw","raw":"{\n  \"safety_violation_log\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"5366829b-f156-482b-852f-0ae857709089","name":"deleteProjectSafetyViolationLog — Delete Safety Violation Log","request":{"method":"DELETE","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/safety_violation_logs/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","safety_violation_logs",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Delete Safety Violation Log"}},{"id":"86b71bba-b378-4e1a-84f4-b5a30b909bda","name":"listProjectVisitorLogs — List Visitor Logs","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/visitor_logs","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","visitor_logs"],"query":[{"key":"log_date","value":"","disabled":true},{"key":"start_date","value":"","disabled":true},{"key":"end_date","value":"","disabled":true},{"key":"filters[created_by_id]","value":"","disabled":true},{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true},{"key":"filters[daily_log_segment_id]","value":"","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"List Visitor Logs"}},{"id":"6ea3175a-b060-4d0e-84d3-7da9178f9883","name":"createProjectVisitorLog — Create Visitor Log","request":{"method":"POST","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/visitor_logs","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","visitor_logs"],"query":[{"key":"run_configurable_validations","value":"","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Create Visitor Log","body":{"mode":"raw","raw":"{\n  \"visitor_log\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"8f9b6c17-9c63-44fa-8083-27e900eda80f","name":"getProjectVisitorLog — Show Visitor Logs","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/visitor_logs/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","visitor_logs",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Show Visitor Logs"}},{"id":"6be0a74a-8a79-4ff9-85cf-c2e38dc41950","name":"updateProjectVisitorLog — Update Visitor Log","request":{"method":"PATCH","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/visitor_logs/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","visitor_logs",":id"],"query":[{"key":"run_configurable_validations","value":"","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Update Visitor Log","body":{"mode":"raw","raw":"{\n  \"visitor_log\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"d551674b-9ebe-41df-8a84-13b8dda57d50","name":"deleteProjectVisitorLog — Delete Visitor Log","request":{"method":"DELETE","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/visitor_logs/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","visitor_logs",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Delete Visitor Log"}},{"id":"cd7a5373-1083-481e-8f7a-3aa059dec5af","name":"listProjectWasteLogs — List Waste Logs","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/waste_logs","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","waste_logs"],"query":[{"key":"log_date","value":"","disabled":true},{"key":"start_date","value":"","disabled":true},{"key":"end_date","value":"","disabled":true},{"key":"filters[created_by_id]","value":"","disabled":true},{"key":"filters[vendor_id]","value":"","disabled":true},{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true},{"key":"filters[daily_log_segment_id]","value":"","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"List Waste Logs"}},{"id":"e56ee34a-c249-4d21-827a-6653b9510a34","name":"createProjectWasteLog — Create Waste Log","request":{"method":"POST","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/waste_logs","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","waste_logs"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Create Waste Log","body":{"mode":"raw","raw":"{\n  \"waste_log\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"24b8c4ee-6dc4-48ff-82a5-1f7f91cccd66","name":"getProjectWasteLog — Show Waste Logs","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/waste_logs/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","waste_logs",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Show Waste Logs"}},{"id":"95a1ec7c-54ec-4e47-88f4-63202c0faca7","name":"updateProjectWasteLog — Update Waste Log","request":{"method":"PATCH","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/waste_logs/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","waste_logs",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Update Waste Log","body":{"mode":"raw","raw":"{\n  \"waste_log\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"05144fa5-09de-413b-896c-cd05c69ce8e0","name":"deleteProjectWasteLog — Delete Waste Log","request":{"method":"DELETE","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/waste_logs/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","waste_logs",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Delete Waste Log"}},{"id":"57caa1c2-944a-4b28-8365-e2bc7d6ee904","name":"listProjectWeatherLogs — List Weather Logs","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/weather_logs","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","weather_logs"],"query":[{"key":"log_date","value":"","disabled":true},{"key":"start_date","value":"","disabled":true},{"key":"end_date","value":"","disabled":true},{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true},{"key":"filters[daily_log_segment_id]","value":"","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"List Weather Logs"}},{"id":"5953254e-b31d-46d3-89b5-66126de5f3ab","name":"createProjectWeatherLog — Create Weather Log","request":{"method":"POST","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/weather_logs","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","weather_logs"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Create Weather Log","body":{"mode":"raw","raw":"{\n  \"weather_log\": {\n    \"date\": \"2026-01-31\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"f54f133d-f955-47f1-8311-b5ab223e1d7a","name":"listProjectWeatherLogsConditions — List Accepted Weather Conditions","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/weather_logs/conditions","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","weather_logs","conditions"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"List Accepted Weather Conditions"}},{"id":"b69353b2-f0ef-46df-816f-012dbabcf7db","name":"getProjectWeatherLog — Show Weather Logs","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/weather_logs/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","weather_logs",":id"],"query":[{"key":"log_date","value":"","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Show Weather Logs"}},{"id":"58c88150-ea83-42e5-8a7a-d165e9ef89b6","name":"updateProjectWeatherLog — Update Weather Log","request":{"method":"PATCH","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/weather_logs/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","weather_logs",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Update Weather Log","body":{"mode":"raw","raw":"{\n  \"weather_log\": {\n    \"date\": \"2026-01-31\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"f7027c74-b2ac-48eb-86d0-91274eee6268","name":"deleteProjectWeatherLog — Delete Weather Log","request":{"method":"DELETE","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/weather_logs/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","weather_logs",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Delete Weather Log"}},{"id":"77b0f933-398f-4679-8a43-05771412ae6a","name":"listProjectWorkLogs — List Work Logs","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/work_logs","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","work_logs"],"query":[{"key":"log_date","value":"","disabled":true},{"key":"start_date","value":"","disabled":true},{"key":"end_date","value":"","disabled":true},{"key":"filters[created_by_id]","value":"","disabled":true},{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true},{"key":"filters[daily_log_segment_id]","value":"","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"List Work Logs"}},{"id":"ebea0ad4-e313-43b6-8c74-26b020f26a5d","name":"createProjectWorkLog — Create Work Log","request":{"method":"POST","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/work_logs","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","work_logs"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Create Work Log","body":{"mode":"raw","raw":"{\n  \"work_log\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"45072d92-1d8c-4470-84f9-eaf344980c0a","name":"getProjectWorkLog — Show Work Logs","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/work_logs/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","work_logs",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Show Work Logs"}},{"id":"559c1c85-3d1b-43d7-8711-846192cc565c","name":"updateProjectWorkLog — Update Work Log","request":{"method":"PATCH","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/work_logs/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","work_logs",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Update Work Log","body":{"mode":"raw","raw":"{\n  \"work_log\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"469569ad-804d-4a6f-82c7-1836a2a01fbd","name":"deleteProjectWorkLog — Delete Work Log","request":{"method":"DELETE","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/work_logs/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","work_logs",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Delete Work Log"}},{"id":"f5422f93-30f9-4d16-877b-1470600c5af1","name":"listProjectDailyLogsCountsV11 — List Counts of Daily Logs","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.1/projects/:project_id/daily_logs/counts","host":["{{baseUrl}}"],"path":["rest","v1.1","projects",":project_id","daily_logs","counts"],"query":[{"key":"log_date","value":"","disabled":true},{"key":"start_date","value":"","disabled":true},{"key":"end_date","value":"","disabled":true},{"key":"filters[status]","value":"","disabled":true},{"key":"filters[created_by_id]","value":"","disabled":true},{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true},{"key":"filters[daily_log_segment_id]","value":"","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"List Counts of Daily Logs"}},{"id":"16e6d5cd-0f6e-4cfe-8ecf-f11c44e598fb","name":"listProjectDailyLogsWeatherLogsV11 — List Weather Logs","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.1/projects/:project_id/daily_logs/weather_logs","host":["{{baseUrl}}"],"path":["rest","v1.1","projects",":project_id","daily_logs","weather_logs"],"query":[{"key":"log_date","value":"","disabled":true},{"key":"start_date","value":"","disabled":true},{"key":"end_date","value":"","disabled":true},{"key":"filters[status]","value":"","disabled":true},{"key":"filters[created_by_id]","value":"","disabled":true},{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true},{"key":"filters[daily_log_segment_id]","value":"","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"List Weather Logs"}},{"id":"ff56c5e0-0219-415c-8fd7-cbd367965495","name":"createProjectDailyLogsWeatherLogV11 — Create Weather Log","request":{"method":"POST","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.1/projects/:project_id/daily_logs/weather_logs","host":["{{baseUrl}}"],"path":["rest","v1.1","projects",":project_id","daily_logs","weather_logs"],"query":[{"key":"run_configurable_validations","value":"","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Create Weather Log","body":{"mode":"raw","raw":"{\n  \"weather_log\": {\n    \"date\": \"2026-01-31\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"de68e989-1504-4c4a-8ccd-b6b4127e4842","name":"getProjectDailyLogsWeatherLogV11 — Show Weather Log","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.1/projects/:project_id/daily_logs/weather_logs/:id","host":["{{baseUrl}}"],"path":["rest","v1.1","projects",":project_id","daily_logs","weather_logs",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Show Weather Log"}},{"id":"4a8dbfc3-dbec-4b3c-8f07-c9c1a6578547","name":"updateProjectDailyLogsWeatherLogV11 — Update Weather Log","request":{"method":"PATCH","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.1/projects/:project_id/daily_logs/weather_logs/:id","host":["{{baseUrl}}"],"path":["rest","v1.1","projects",":project_id","daily_logs","weather_logs",":id"],"query":[{"key":"run_configurable_validations","value":"","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Update Weather Log","body":{"mode":"raw","raw":"{\n  \"weather_log\": {\n    \"date\": \"2026-01-31\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"3778a2a2-f63c-4368-8123-2d58528f157c","name":"deleteProjectDailyLogsWeatherLogV11 — Delete Weather Log","request":{"method":"DELETE","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.1/projects/:project_id/daily_logs/weather_logs/:id","host":["{{baseUrl}}"],"path":["rest","v1.1","projects",":project_id","daily_logs","weather_logs",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Delete Weather Log"}}]},{"name":"Direct Costs","description":"Module: direct_costs","item":[{"id":"5f0646ea-4a5c-415f-81a3-408a1ffbf247","name":"listProjectDirectCosts — List Direct Cost Items","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/direct_costs","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","direct_costs"],"query":[{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true},{"key":"filters[id]","value":"","disabled":true},{"key":"filters[origin_id]","value":"","disabled":true},{"key":"filters[invoice_number]","value":"","disabled":true},{"key":"filters[created_at]","value":"","disabled":true},{"key":"filters[updated_at]","value":"","disabled":true},{"key":"filters[payment_date]","value":"","disabled":true},{"key":"filters[received_date]","value":"","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"List Direct Cost Items"}},{"id":"daae3089-8fa7-43e6-83ab-d84cda4ecf8a","name":"createProjectDirectCost — Create Direct Cost Item","request":{"method":"POST","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/direct_costs","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","direct_costs"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Create Direct Cost Item","body":{"mode":"raw","raw":"{\n  \"attachments\": [\n    \"\"\n  ],\n  \"item\": {\n    \"direct_cost_type\": \"invoice\",\n    \"invoice_number\": \"\",\n    \"vendor_id\": 0\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"536f2755-8f54-470c-87b4-86101781a435","name":"listProjectDirectCostsLineItems — List All Direct Cost Line Items","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/direct_costs/line_items","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","direct_costs","line_items"],"query":[{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true},{"key":"filters[direct_cost_id]","value":"","disabled":true},{"key":"filters[id]","value":"","disabled":true},{"key":"filters[created_at]","value":"","disabled":true},{"key":"filters[updated_at]","value":"","disabled":true},{"key":"filters[cost_code_id]","value":"","disabled":true},{"key":"filters[line_item_type_id]","value":"","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"List All Direct Cost Line Items"}},{"id":"36aee6ca-6597-40d7-8569-7f79c194adc6","name":"updateProjectDirectCostsLineItemsSync — Sync Direct Cost Line Items","request":{"method":"PATCH","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/direct_costs/line_items/sync","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","direct_costs","line_items","sync"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Sync Direct Cost Line Items\n\nCreate or update up to 100 direct cost line items in one request. Items with `id` update that record; items without `id` create one under `direct_cost_id` (required on every item). Nothing is deleted. Each item runs through the same checks as the single-record routes; failures are listed in `errors` and do not roll back other items.","body":{"mode":"raw","raw":"{\n  \"updates\": [\n    {}\n  ]\n}","options":{"raw":{"language":"json"}}}}},{"id":"08e90d23-5fe6-436b-869b-06cf19f59bfb","name":"updateProjectDirectCostsSync — Sync Direct Cost Items","request":{"method":"PATCH","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/direct_costs/sync","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","direct_costs","sync"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Sync Direct Cost Items\n\nCreate or update up to 100 direct costs in one request. Items with `id` update that record; items without `id` create one. Nothing is deleted. Each item runs through the same checks as the single-record routes; failures are listed in `errors` and do not roll back other items.","body":{"mode":"raw","raw":"{\n  \"updates\": [\n    {}\n  ]\n}","options":{"raw":{"language":"json"}}}}},{"id":"36470574-2ae5-4dab-8f4a-86e14ebfc370","name":"listProjectDirectCostLineItems — List Direct Cost Line Items","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/direct_costs/:direct_cost_id/line_items","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","direct_costs",":direct_cost_id","line_items"],"query":[{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true},{"key":"filters[id]","value":"","disabled":true},{"key":"filters[created_at]","value":"","disabled":true},{"key":"filters[updated_at]","value":"","disabled":true},{"key":"filters[cost_code_id]","value":"","disabled":true},{"key":"filters[line_item_type_id]","value":"","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"direct_cost_id","value":""}]},"description":"List Direct Cost Line Items"}},{"id":"561af014-d545-4bc5-8360-ca342e7c0648","name":"createProjectDirectCostLineItem — Create Direct Cost Line Item","request":{"method":"POST","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/direct_costs/:direct_cost_id/line_items","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","direct_costs",":direct_cost_id","line_items"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"direct_cost_id","value":""}]},"description":"Create Direct Cost Line Item","body":{"mode":"raw","raw":"{\n  \"line_item\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"8461d488-a45a-44ca-8618-7ee8606380a6","name":"getProjectDirectCostLineItem — Show Direct Cost Line Item","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/direct_costs/:direct_cost_id/line_items/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","direct_costs",":direct_cost_id","line_items",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"direct_cost_id","value":""},{"key":"id","value":""}]},"description":"Show Direct Cost Line Item"}},{"id":"503d72a8-81e5-4a64-8082-aef43a3b0567","name":"updateProjectDirectCostLineItem — Update Direct Cost Line Item","request":{"method":"PATCH","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/direct_costs/:direct_cost_id/line_items/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","direct_costs",":direct_cost_id","line_items",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"direct_cost_id","value":""},{"key":"id","value":""}]},"description":"Update Direct Cost Line Item","body":{"mode":"raw","raw":"{\n  \"line_item\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"ee8aaa4f-c51b-42d0-8b56-15dfe76e397e","name":"deleteProjectDirectCostLineItem — Delete a Direct Cost Line Item","request":{"method":"DELETE","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/direct_costs/:direct_cost_id/line_items/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","direct_costs",":direct_cost_id","line_items",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"direct_cost_id","value":""},{"key":"id","value":""}]},"description":"Delete a Direct Cost Line Item"}},{"id":"8e70e71d-ba0a-4f6a-800d-b23c0bc6cf93","name":"getProjectDirectCost — Show Direct Cost Item","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/direct_costs/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","direct_costs",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Show Direct Cost Item"}},{"id":"ff8e4950-d61a-427b-89e3-7775e89c5748","name":"updateProjectDirectCost — Update Direct Cost Item","request":{"method":"PATCH","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/direct_costs/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","direct_costs",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Update Direct Cost Item","body":{"mode":"raw","raw":"{\n  \"attachments\": [\n    \"\"\n  ],\n  \"item\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"387c1765-4e45-487f-8caa-c55435f1faa9","name":"deleteProjectDirectCost — Delete Direct Cost Item","request":{"method":"DELETE","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/direct_costs/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","direct_costs",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Delete Direct Cost Item"}},{"id":"e5aec423-c771-4dc4-8eb9-0aa3955585be","name":"createProjectDirectCostAttachment — Upload direct cost attachment","request":{"method":"POST","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/direct_costs/:id/attachments","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","direct_costs",":id","attachments"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Upload direct cost attachment"}},{"id":"71a683c9-8faf-488f-860c-6a72f72bd6b5","name":"listProjectDirectCostsV11 — List Direct Cost Items","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.1/projects/:project_id/direct_costs","host":["{{baseUrl}}"],"path":["rest","v1.1","projects",":project_id","direct_costs"],"query":[{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true},{"key":"filters[id]","value":"","disabled":true},{"key":"filters[origin_id]","value":"","disabled":true},{"key":"filters[invoice_number]","value":"","disabled":true},{"key":"filters[created_at]","value":"","disabled":true},{"key":"filters[updated_at]","value":"","disabled":true},{"key":"filters[payment_date]","value":"","disabled":true},{"key":"filters[received_date]","value":"","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"List Direct Cost Items"}},{"id":"2643ac8a-52f7-44ac-8c9b-77e555f7c550","name":"createProjectDirectCostV11 — Create Direct Cost Item","request":{"method":"POST","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.1/projects/:project_id/direct_costs","host":["{{baseUrl}}"],"path":["rest","v1.1","projects",":project_id","direct_costs"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Create Direct Cost Item","body":{"mode":"raw","raw":"{\n  \"attachments\": [\n    \"\"\n  ],\n  \"direct_cost\": {\n    \"direct_cost_type\": \"invoice\",\n    \"invoice_number\": \"\",\n    \"vendor_id\": 0\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"5c798e59-4a9a-4cb9-88e3-e94e292d71bc","name":"getProjectDirectCostV11 — Show Direct Cost Item","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.1/projects/:project_id/direct_costs/:id","host":["{{baseUrl}}"],"path":["rest","v1.1","projects",":project_id","direct_costs",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Show Direct Cost Item"}},{"id":"8d11d951-f41b-415f-8063-5846ed1a9fd8","name":"updateProjectDirectCostV11 — Update Direct Cost Item","request":{"method":"PATCH","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.1/projects/:project_id/direct_costs/:id","host":["{{baseUrl}}"],"path":["rest","v1.1","projects",":project_id","direct_costs",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Update Direct Cost Item","body":{"mode":"raw","raw":"{\n  \"attachments\": [\n    \"\"\n  ],\n  \"direct_cost\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"c2ae4dd9-a0ae-4553-882a-2bee1da8ba26","name":"deleteProjectDirectCostV11 — Delete Direct Cost Item","request":{"method":"DELETE","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.1/projects/:project_id/direct_costs/:id","host":["{{baseUrl}}"],"path":["rest","v1.1","projects",":project_id","direct_costs",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Delete Direct Cost Item"}},{"id":"0cfb9c65-2968-4f8b-8f47-5660f70dd3d9","name":"createProjectDirectCostAttachmentV11 — Upload direct cost attachment","request":{"method":"POST","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.1/projects/:project_id/direct_costs/:id/attachments","host":["{{baseUrl}}"],"path":["rest","v1.1","projects",":project_id","direct_costs",":id","attachments"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Upload direct cost attachment"}}]},{"name":"Direct Uploads","description":"Module: direct_uploads","item":[{"id":"e9bb6ad9-f601-470a-8c75-2eb8fbda5503","name":"createCompanyUploadV11 — Initiate a local nonsegmented upload","request":{"method":"POST","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.1/companies/:company_id/uploads","host":["{{baseUrl}}"],"path":["rest","v1.1","companies",":company_id","uploads"],"variable":[{"key":"company_id","value":"{{companyId}}"}]},"description":"Initiate a local nonsegmented upload","body":{"mode":"raw","raw":"{\n  \"attachment_content_disposition\": false,\n  \"response_content_type\": \"\",\n  \"response_filename\": \"\",\n  \"size\": 0\n}","options":{"raw":{"language":"json"}}}}},{"id":"a52ee750-5d6c-42fe-8b44-7ef0e7300ca0","name":"getCompanyUploadV11 — Show a local nonsegmented upload","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.1/companies/:company_id/uploads/:uuid","host":["{{baseUrl}}"],"path":["rest","v1.1","companies",":company_id","uploads",":uuid"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"uuid","value":""}]},"description":"Show a local nonsegmented upload"}},{"id":"a9768d91-6f76-43ea-842a-7b1ef5c7b1b5","name":"createProjectUploadV11 — Initiate a local nonsegmented upload","request":{"method":"POST","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.1/projects/:project_id/uploads","host":["{{baseUrl}}"],"path":["rest","v1.1","projects",":project_id","uploads"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Initiate a local nonsegmented upload","body":{"mode":"raw","raw":"{\n  \"attachment_content_disposition\": false,\n  \"response_content_type\": \"\",\n  \"response_filename\": \"\",\n  \"size\": 0\n}","options":{"raw":{"language":"json"}}}}},{"id":"b7bdbf78-0db1-4084-8545-aa972fe47ad6","name":"getProjectUploadV11 — Show a local nonsegmented upload","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.1/projects/:project_id/uploads/:uuid","host":["{{baseUrl}}"],"path":["rest","v1.1","projects",":project_id","uploads",":uuid"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"uuid","value":""}]},"description":"Show a local nonsegmented upload"}}]},{"name":"Directory","description":"Module: directory","item":[{"id":"29b85268-fcb3-47c1-8180-1c72a1f4efee","name":"listProjectDistributionGroups — List Project Distribution Groups","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/distribution_groups","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","distribution_groups"],"query":[{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true},{"key":"filters[search]","value":"","disabled":true},{"key":"sort","value":"","disabled":true},{"key":"view","value":"","disabled":true},{"key":"include_ancestors","value":"","disabled":true},{"key":"domain_id","value":"","disabled":true},{"key":"min_ual","value":"","disabled":true},{"key":"ual","value":"","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"List Project Distribution Groups"}},{"id":"971c8e01-9649-4752-8f45-b50298f09491","name":"createProjectDistributionGroup — Create Project Distribution Group","request":{"method":"POST","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/distribution_groups","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","distribution_groups"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Create Project Distribution Group","body":{"mode":"raw","raw":"{\n  \"distribution_group\": {\n    \"name\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"5aec0f30-b38c-4455-8016-6f25986c7097","name":"getProjectDistributionGroup — Show Project Distribution Group","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/distribution_groups/:distribution_group_id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","distribution_groups",":distribution_group_id"],"query":[{"key":"view","value":"","disabled":true},{"key":"include_ancestors","value":"","disabled":true},{"key":"domain_id","value":"","disabled":true},{"key":"min_ual","value":"","disabled":true},{"key":"ual","value":"","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"distribution_group_id","value":""}]},"description":"Show Project Distribution Group"}},{"id":"1fd0409f-eac7-4aee-863f-53ee65d5bbbc","name":"updateProjectDistributionGroup — Update Project Distribution Group","request":{"method":"PATCH","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/distribution_groups/:distribution_group_id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","distribution_groups",":distribution_group_id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"distribution_group_id","value":""}]},"description":"Update Project Distribution Group","body":{"mode":"raw","raw":"{\n  \"distribution_group\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"ece933fa-9858-467e-8d15-b7ff9c1c0260","name":"deleteProjectDistributionGroup — Delete Project Distribution Group","request":{"method":"DELETE","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/distribution_groups/:distribution_group_id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","distribution_groups",":distribution_group_id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"distribution_group_id","value":""}]},"description":"Delete Project Distribution Group"}},{"id":"1f0ae0a5-e948-4dd4-8283-5f4ddaf2cd3c","name":"listProjectProjectRoles — List Project Roles","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/project_roles","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","project_roles"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"List Project Roles"}},{"id":"c34c86b9-0ddf-4e06-8dec-95e206eb077e","name":"listProjectUsers — List Project Users","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/users","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","users"],"query":[{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true},{"key":"view","value":"","disabled":true},{"key":"filters[created_at]","value":"","disabled":true},{"key":"filters[updated_at]","value":"","disabled":true},{"key":"filters[permission_template]","value":"","disabled":true},{"key":"filters[vendor_id]","value":"","disabled":true},{"key":"filters[origin_id]","value":"","disabled":true},{"key":"filters[trade_id][]","value":"","disabled":true},{"key":"filters[search]","value":"","disabled":true},{"key":"filters[employee]","value":"","disabled":true},{"key":"filters[id][]","value":"","disabled":true},{"key":"filters[search_by_full_name]","value":"","disabled":true},{"key":"sort","value":"","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"List Project Users"}},{"id":"63f9822d-3fc2-42ba-8012-03b56eed483a","name":"createProjectUser — Create project user","request":{"method":"POST","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/users","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","users"],"query":[{"key":"run_configurable_validations","value":"","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Create project user","body":{"mode":"raw","raw":"{\n  \"user\": {\n    \"email_address\": \"\",\n    \"last_name\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"389f31a1-702b-4a84-8769-ec78e376467b","name":"getProjectUser — Show project user","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/users/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","users",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Show project user"}},{"id":"af5626a9-39aa-4fb3-857c-32589f238317","name":"updateProjectUser — Update project user","request":{"method":"PATCH","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/users/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","users",":id"],"query":[{"key":"run_configurable_validations","value":"","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Update project user","body":{"mode":"raw","raw":"{\n  \"user\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"77309ce5-0ff8-485f-88c7-319089481712","name":"listProjectVendors — List project vendors","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/vendors","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","vendors"],"query":[{"key":"view","value":"","disabled":true},{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true},{"key":"filters[search]","value":"","disabled":true},{"key":"filters[standard_cost_code_id][]","value":"","disabled":true},{"key":"filters[trade_id][]","value":"","disabled":true},{"key":"filters[id][]","value":"","disabled":true},{"key":"filters[parent_id][]","value":"","disabled":true},{"key":"filters[abbreviated_name][]","value":"","disabled":true},{"key":"sort","value":"","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"List project vendors"}},{"id":"bc706940-7181-458b-85ce-4056f9bdf211","name":"createProjectVendor — Create project vendor","request":{"method":"POST","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/vendors","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","vendors"],"query":[{"key":"view","value":"","disabled":true},{"key":"run_configurable_validations","value":"","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Create project vendor","body":{"mode":"raw","raw":"{\n  \"vendor\": {\n    \"name\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"b2084a42-5797-444d-88a7-8d2e1f187b6c","name":"getProjectVendor — Show project vendor","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/vendors/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","vendors",":id"],"query":[{"key":"view","value":"","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Show project vendor"}},{"id":"7a07e552-b4b3-452e-80bb-3c4faf63f149","name":"updateProjectVendor — Update project vendor","request":{"method":"PATCH","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/vendors/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","vendors",":id"],"query":[{"key":"view","value":"","disabled":true},{"key":"run_configurable_validations","value":"","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Update project vendor","body":{"mode":"raw","raw":"{\n  \"vendor\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"3ece2d08-d7a5-4296-8997-98e09ae6abe6","name":"listProjectVendorUsers — List company (vendor) people","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/vendors/:id/users","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","vendors",":id","users"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"List company (vendor) people"}}]},{"name":"Documents","description":"Module: documents","item":[{"id":"0c049f44-2969-476d-80d0-04b0802a9132","name":"listFiles — List files visible to the caller in a project","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/files","host":["{{baseUrl}}"],"path":["rest","v1.0","files"],"query":[{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true}]},"description":"List files visible to the caller in a project\n\nRequires documents:read and the Documents view capability. Lists non-deleted project files after applying file and inherited folder ACLs. Use a small page because records include version metadata. Total counts items visible to the caller."}},{"id":"ad9b1064-39f0-42f3-85eb-c797104f257e","name":"createFile — Create project File","request":{"method":"POST","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/files","host":["{{baseUrl}}"],"path":["rest","v1.0","files"],"query":[{"key":"project_id","value":"","disabled":false}]},"description":"Create project File","body":{"mode":"raw","raw":"{\n  \"file\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"99c79fd9-9670-4839-8138-fd45396f8988","name":"getFile — Show project File","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/files/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","files",":id"],"query":[{"key":"project_id","value":"","disabled":false},{"key":"show_latest_version_only","value":"","disabled":true}],"variable":[{"key":"id","value":""}]},"description":"Show project File"}},{"id":"967c0fdd-64ef-4fe8-8567-42bf57515e1f","name":"updateFile — Update project File","request":{"method":"PATCH","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/files/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","files",":id"],"query":[{"key":"project_id","value":"","disabled":false}],"variable":[{"key":"id","value":""}]},"description":"Update project File","body":{"mode":"raw","raw":"{\n  \"file\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"7e3079d6-3e40-4464-8ed3-8d3a4fb2aed0","name":"deleteFile — Delete project File","request":{"method":"DELETE","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/files/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","files",":id"],"query":[{"key":"project_id","value":"","disabled":false}],"variable":[{"key":"id","value":""}]},"description":"Delete project File"}},{"id":"7eb1c50c-8c04-4d16-8cab-dc298ffbe0cb","name":"cancelCheckoutFile — Cancel a document checkout without creating a version","request":{"method":"POST","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/files/:id/cancel_checkout","host":["{{baseUrl}}"],"path":["rest","v1.0","files",":id","cancel_checkout"],"query":[{"key":"project_id","value":"","disabled":false,"description":"Project in the authenticated company's workspace."}],"variable":[{"key":"id","value":""}]},"description":"Cancel a document checkout without creating a version\n\nRequires documents:write and the Documents edit capability plus file edit access. The checkout holder may cancel their own checkout. A Documents administrator may cancel another user's checkout. An unchecked file returns a conflict."}},{"id":"f57382b8-4ba2-49ec-8021-703c4a6be669","name":"checkinFile — Check in a document file with optional JSON version source","request":{"method":"POST","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/files/:id/checkin","host":["{{baseUrl}}"],"path":["rest","v1.0","files",":id","checkin"],"query":[{"key":"project_id","value":"","disabled":false,"description":"Project in the authenticated company's workspace."}],"variable":[{"key":"id","value":""}]},"description":"Check in a document file with optional JSON version source\n\nRequires documents:write and the Documents edit capability plus file edit access. The checkout holder or a Documents administrator can check in. Omit the version source to release the checkout without a new version. A staged upload ID creates a new version under the source upload's live scope and ACL checks. An opaque direct-upload reference requires uploads:read and a configured direct-upload flow. This catalog uses the JSON request variant.","body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}}}},{"id":"cf8605a6-d134-4f39-864c-bade4c820082","name":"checkoutFile — Check out a document file","request":{"method":"POST","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/files/:id/checkout","host":["{{baseUrl}}"],"path":["rest","v1.0","files",":id","checkout"],"query":[{"key":"project_id","value":"","disabled":false,"description":"Project in the authenticated company's workspace."}],"variable":[{"key":"id","value":""}]},"description":"Check out a document file\n\nRequires documents:write and the Documents edit capability plus file edit access. Locks the file for editing by the caller. A caller who owns the checkout can set a new expiry. A checkout held by another user conflicts.","body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}}}},{"id":"d8515766-52c7-4a47-8d45-68e12350ea13","name":"listFilePermissions — List explicit permission grants on a document file","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/files/:id/permissions","host":["{{baseUrl}}"],"path":["rest","v1.0","files",":id","permissions"],"query":[{"key":"project_id","value":"","disabled":false,"description":"Project in the authenticated company's workspace."}],"variable":[{"key":"id","value":""}]},"description":"List explicit permission grants on a document file\n\nRequires documents:read, the Documents view capability, and view access under the file's effective ACL. Returns the explicit grants recorded on this file. This does not expand inherited grants or compute effective access for every grantee."}},{"id":"11772db1-19b7-410a-8006-ec6acdfe8c06","name":"createFilePermission — Create or update a permission grant on a document file","request":{"method":"POST","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/files/:id/permissions","host":["{{baseUrl}}"],"path":["rest","v1.0","files",":id","permissions"],"query":[{"key":"project_id","value":"","disabled":false,"description":"Project in the authenticated company's workspace."}],"variable":[{"key":"id","value":""}]},"description":"Create or update a permission grant on a document file\n\nRequires documents:write and Documents administrator access on the project. The user or permission-template grantee must belong to the authenticated company. The request upserts the explicit grant for this file and grantee. It can change the effective ACL at this level.","body":{"mode":"raw","raw":"{\n  \"permission\": {\n    \"grantee_id\": 0,\n    \"grantee_type\": \"role\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"755be64a-4c72-481e-85ab-965f570d0250","name":"deleteFilePermission — Revoke an explicit permission grant on a document file","request":{"method":"DELETE","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/files/:id/permissions/:permission_id","host":["{{baseUrl}}"],"path":["rest","v1.0","files",":id","permissions",":permission_id"],"query":[{"key":"project_id","value":"","disabled":false,"description":"Project in the authenticated company's workspace."}],"variable":[{"key":"id","value":""},{"key":"permission_id","value":""}]},"description":"Revoke an explicit permission grant on a document file\n\nRequires documents:write and Documents administrator access on the project. The grant must belong to this project and file. Removing a grant can cause the file to inherit permissions from an ancestor."}},{"id":"101e147f-f0a1-4f14-8270-3d48377abda8","name":"restoreFile — Restore a recycled document file","request":{"method":"PATCH","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/files/:id/restore","host":["{{baseUrl}}"],"path":["rest","v1.0","files",":id","restore"],"query":[{"key":"project_id","value":"","disabled":false,"description":"Project in the authenticated company's workspace."}],"variable":[{"key":"id","value":""}]},"description":"Restore a recycled document file\n\nRequires documents:write and the Documents delete capability (administrator). The file returns to its original folder when that ancestry remains live. An administrator can restore it to the project root if the original ancestry is unavailable. Conflicting concurrent changes fail without a partial restore."}},{"id":"0fc55c40-e626-4373-8e6b-fb983b06b92c","name":"listFileVersions — List version history for a document file","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/files/:id/versions","host":["{{baseUrl}}"],"path":["rest","v1.0","files",":id","versions"],"query":[{"key":"project_id","value":"","disabled":false,"description":"Project in the authenticated company's workspace."}],"variable":[{"key":"id","value":""}]},"description":"List version history for a document file\n\nRequires documents:read and the Documents view capability. The caller must also have file view access under its effective ACL. History is returned newest first without pagination. The highest version number is marked current. For a stored upload, retrieve bytes through the authorized download flow."}},{"id":"df163dd6-336f-4544-8112-eae3bbca3a6a","name":"listFolders — List project folders and files","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/folders","host":["{{baseUrl}}"],"path":["rest","v1.0","folders"],"query":[{"key":"project_id","value":"","disabled":false},{"key":"exclude_folders","value":"","disabled":true},{"key":"exclude_files","value":"","disabled":true},{"key":"show_latest_file_version_only","value":"","disabled":true}]},"description":"List project folders and files"}},{"id":"ae14569a-31bc-4537-800d-6be3b44edadb","name":"createFolder — Create Project Folder","request":{"method":"POST","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/folders","host":["{{baseUrl}}"],"path":["rest","v1.0","folders"],"query":[{"key":"project_id","value":"","disabled":false}]},"description":"Create Project Folder","body":{"mode":"raw","raw":"{\n  \"folder\": {\n    \"name\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"55abf789-45d4-4fbd-8818-034cb3fffbc4","name":"getFolder — Show Project Folder","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/folders/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","folders",":id"],"query":[{"key":"project_id","value":"","disabled":false},{"key":"exclude_folders","value":"","disabled":true},{"key":"exclude_files","value":"","disabled":true},{"key":"show_latest_file_version_only","value":"","disabled":true}],"variable":[{"key":"id","value":""}]},"description":"Show Project Folder"}},{"id":"cb8d426c-361f-431e-802b-90db54595af4","name":"updateFolder — Update Project Folder","request":{"method":"PATCH","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/folders/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","folders",":id"],"query":[{"key":"project_id","value":"","disabled":false}],"variable":[{"key":"id","value":""}]},"description":"Update Project Folder","body":{"mode":"raw","raw":"{\n  \"folder\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"b39336a7-a514-4b0a-8944-930f578e1e7c","name":"deleteFolder — Delete Project Folder","request":{"method":"DELETE","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/folders/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","folders",":id"],"query":[{"key":"project_id","value":"","disabled":false}],"variable":[{"key":"id","value":""}]},"description":"Delete Project Folder"}},{"id":"1d54b12a-c3d1-4f2e-8c91-13cfbe859aee","name":"listFolderPermissions — List explicit permission grants on a document folder","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/folders/:id/permissions","host":["{{baseUrl}}"],"path":["rest","v1.0","folders",":id","permissions"],"query":[{"key":"project_id","value":"","disabled":false,"description":"Project in the authenticated company's workspace."}],"variable":[{"key":"id","value":""}]},"description":"List explicit permission grants on a document folder\n\nRequires documents:read, the Documents view capability, and view access under the folder's effective ACL. Returns the explicit grants recorded on this folder. This does not expand inherited grants or compute effective access for every grantee."}},{"id":"949fcd3f-f2c1-4888-8220-1db50b5cda1e","name":"createFolderPermission — Create or update a permission grant on a document folder","request":{"method":"POST","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/folders/:id/permissions","host":["{{baseUrl}}"],"path":["rest","v1.0","folders",":id","permissions"],"query":[{"key":"project_id","value":"","disabled":false,"description":"Project in the authenticated company's workspace."}],"variable":[{"key":"id","value":""}]},"description":"Create or update a permission grant on a document folder\n\nRequires documents:write and Documents administrator access on the project. The user or permission-template grantee must belong to the authenticated company. The request upserts the explicit grant for this folder and grantee. It can change the effective ACL at this level.","body":{"mode":"raw","raw":"{\n  \"permission\": {\n    \"grantee_id\": 0,\n    \"grantee_type\": \"role\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"44fd4af2-4e39-4520-89ae-8c8251edd1bd","name":"deleteFolderPermission — Revoke an explicit permission grant on a document folder","request":{"method":"DELETE","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/folders/:id/permissions/:permission_id","host":["{{baseUrl}}"],"path":["rest","v1.0","folders",":id","permissions",":permission_id"],"query":[{"key":"project_id","value":"","disabled":false,"description":"Project in the authenticated company's workspace."}],"variable":[{"key":"id","value":""},{"key":"permission_id","value":""}]},"description":"Revoke an explicit permission grant on a document folder\n\nRequires documents:write and Documents administrator access on the project. The grant must belong to this project and folder. Removing a grant can cause the folder to inherit permissions from an ancestor."}},{"id":"711a8893-1f65-49ef-8096-5b4202f13ecd","name":"restoreFolder — Restore a recycled document folder","request":{"method":"PATCH","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/folders/:id/restore","host":["{{baseUrl}}"],"path":["rest","v1.0","folders",":id","restore"],"query":[{"key":"project_id","value":"","disabled":false,"description":"Project in the authenticated company's workspace."}],"variable":[{"key":"id","value":""}]},"description":"Restore a recycled document folder\n\nRequires documents:write and the Documents delete capability (administrator). Restores the folder and its recycled descendants as one operation. An administrator can restore it to the project root if its original ancestry is unavailable. A subtree above the 10,000-folder safety cap returns a conflict. Conflicting concurrent changes fail without a partial restore."}},{"id":"6759c203-20ba-4ffa-82d1-58ac8d384454","name":"createProjectUpload — Create upload","request":{"method":"POST","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/uploads","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","uploads"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Create upload"}},{"id":"44e96d2e-f63c-4eb3-83c4-961d9589f3b6","name":"getUpload — Get upload","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/uploads/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","uploads",":id"],"variable":[{"key":"id","value":""}]},"description":"Get upload\n\nStream the stored file bytes with the correct Content-Type. The disposition is type-aware (see serveUpload): inert preview types (raster images, PDF, plain text) render inline; active content such as SVG/HTML is forced to attachment to prevent stored-XSS in the app origin. Scoped to the caller's company, project membership, and bound form permissions."}},{"id":"501da0c7-441e-43e7-8b26-88c35644e476","name":"listUploadDownload — Download upload","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/uploads/:id/download","host":["{{baseUrl}}"],"path":["rest","v1.0","uploads",":id","download"],"variable":[{"key":"id","value":""}]},"description":"Download upload\n\nSame as the serve route but forces an attachment Content-Disposition so browsers download rather than render."}}]},{"name":"Drawings","description":"Module: drawings","item":[{"id":"3fc2da69-a678-4ede-8d87-43d1fe62d0bd","name":"listDrawingAreaDrawings — List drawings","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/drawing_areas/:drawing_area_id/drawings","host":["{{baseUrl}}"],"path":["rest","v1.0","drawing_areas",":drawing_area_id","drawings"],"query":[{"key":"project_id","value":"","disabled":true},{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true}],"variable":[{"key":"drawing_area_id","value":""}]},"description":"List drawings"}},{"id":"e545e17b-8324-49e5-8b6c-35dfddde4631","name":"createDrawingAreaDrawing — Create drawing area drawing","request":{"method":"POST","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/drawing_areas/:drawing_area_id/drawings","host":["{{baseUrl}}"],"path":["rest","v1.0","drawing_areas",":drawing_area_id","drawings"],"variable":[{"key":"drawing_area_id","value":""}]},"description":"Create drawing area drawing\n\nAlias of `POST /rest/v1.1/drawing_areas/{drawing_area_id}/drawings`, with the same behaviour."}},{"id":"abf04a0b-0557-406b-8b7b-4415c5e0f6f7","name":"getDrawingAreaDrawing — Get drawing area drawing","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/drawing_areas/:drawing_area_id/drawings/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","drawing_areas",":drawing_area_id","drawings",":id"],"variable":[{"key":"drawing_area_id","value":""},{"key":"id","value":""}]},"description":"Get drawing area drawing\n\nAlias of `GET /rest/v1.1/drawing_areas/{drawing_area_id}/drawings/{id}`, with the same behaviour. Requires the `view` permission on the project's drawings tool. A scoped API token needs `drawings:read`.","body":{"mode":"raw","raw":"{\n  \"drawing\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"413fc005-07e1-47fa-8414-3d65a6feb9e3","name":"updateDrawingAreaDrawing — Update Drawing","request":{"method":"PATCH","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/drawing_areas/:drawing_area_id/drawings/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","drawing_areas",":drawing_area_id","drawings",":id"],"variable":[{"key":"drawing_area_id","value":""},{"key":"id","value":""}]},"description":"Update Drawing","body":{"mode":"raw","raw":"{\n  \"drawing\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"fd48cda8-eb58-4f7d-8a41-70c2e002ac54","name":"listProjectDrawingAreas — List drawing areas","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/drawing_areas","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","drawing_areas"],"query":[{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true},{"key":"filters[exclude_empty_connected]","value":"","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"List drawing areas"}},{"id":"9aeb1d67-559d-4d38-87bc-1a2b82316bb8","name":"createProjectDrawingArea — Create drawing area","request":{"method":"POST","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/drawing_areas","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","drawing_areas"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Create drawing area","body":{"mode":"raw","raw":"{\n  \"name\": \"\"\n}","options":{"raw":{"language":"json"}}}}},{"id":"88b14d4a-f446-4590-8353-f76ed3cf876f","name":"getProjectDrawingArea — Get drawing area","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/drawing_areas/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","drawing_areas",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Get drawing area\n\nAlias of `GET /rest/v1.1/projects/{project_id}/drawing_areas/{id}`, with the same behaviour. Requires the `view` permission on the project's drawings tool. A scoped API token needs `drawings:read`.","body":{"mode":"raw","raw":"{\n  \"description\": \"\",\n  \"name\": \"\"\n}","options":{"raw":{"language":"json"}}}}},{"id":"05463f8c-6de8-403e-877e-23f5086a11bf","name":"updateProjectDrawingArea — Update a drawing area","request":{"method":"PATCH","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/drawing_areas/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","drawing_areas",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Update a drawing area","body":{"mode":"raw","raw":"{\n  \"name\": \"\"\n}","options":{"raw":{"language":"json"}}}}},{"id":"3ceff922-eaa7-42cb-8910-90d88e2dca01","name":"deleteProjectDrawingArea — Delete a drawing area","request":{"method":"DELETE","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/drawing_areas/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","drawing_areas",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Delete a drawing area\n\nDelete an empty drawing area. An area that still holds drawings (current or recycled) returns 409; move them to another area first. Needs drawings delete permission."}},{"id":"5c040e33-544c-49a7-8f1e-b830462c1dff","name":"listProjectDrawingDisciplines — List Drawing Disciplines","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/drawing_disciplines","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","drawing_disciplines"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"List Drawing Disciplines"}},{"id":"36358368-dc50-4408-89e8-c26e8c12e079","name":"createProjectDrawingDiscipline — Create drawing discipline","request":{"method":"POST","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/drawing_disciplines","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","drawing_disciplines"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Create drawing discipline"}},{"id":"ef47a513-68e8-4c1c-8efe-07f53ac1fa23","name":"getProjectDrawingDiscipline — Show Drawing Discipline","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/drawing_disciplines/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","drawing_disciplines",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Show Drawing Discipline"}},{"id":"d65560b9-8f1c-44c9-8c31-56670780f438","name":"updateProjectDrawingDiscipline — Update Drawing Discipline","request":{"method":"PATCH","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/drawing_disciplines/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","drawing_disciplines",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Update Drawing Discipline"}},{"id":"1b7326e2-a44e-4213-8f64-7c32d8beea12","name":"sendEmailProjectDrawingRevisionEmail — Send email","request":{"method":"POST","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/drawing_revision_emails/:id/send_email","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","drawing_revision_emails",":id","send_email"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Send email","body":{"mode":"raw","raw":"{\n  \"bcc_distribution_ids\": [\n    0\n  ],\n  \"body\": \"\",\n  \"cc_distribution_ids\": [\n    0\n  ],\n  \"distribution_ids\": [\n    0\n  ],\n  \"subject\": \"\"\n}","options":{"raw":{"language":"json"}}}}},{"id":"f31698f7-b371-4358-83ec-b21a66214a7e","name":"listProjectDrawingRevisionTerms — List drawing revision terms","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/drawing_revision_terms","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","drawing_revision_terms"],"query":[{"key":"drawing_revision_ids","value":"","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"List drawing revision terms"}},{"id":"813119a3-eb4f-4ec9-8b3b-7b86f3262aab","name":"listProjectDrawingRevisions — List drawing revisions","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/drawing_revisions","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","drawing_revisions"],"query":[{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true},{"key":"drawing_area_id","value":"","disabled":true},{"key":"drawing_id","value":"","disabled":true},{"key":"drawing_discipline_id","value":"","disabled":true},{"key":"drawing_set_id","value":"","disabled":true},{"key":"id","value":"","disabled":true},{"key":"filters[ids]","value":"","disabled":true},{"key":"filters[updated_at]","value":"","disabled":true},{"key":"filters[deleted]","value":"","disabled":true},{"key":"filters[viewer_experience]","value":"","disabled":true},{"key":"is_reviewed","value":"","disabled":true},{"key":"query","value":"","disabled":true},{"key":"with_obsolete","value":"","disabled":true},{"key":"sort","value":"","disabled":true},{"key":"view","value":"","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"List drawing revisions"}},{"id":"9e037956-3a2a-47a8-826f-267380420c10","name":"createProjectDrawingRevision — Create drawing revision","request":{"method":"POST","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/drawing_revisions","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","drawing_revisions"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Create drawing revision"}},{"id":"23b4c8cf-c631-42e8-800f-927ba6c3c90d","name":"createProjectDrawingRevisionsPublish — Publish Drawing Revisions","request":{"method":"POST","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/drawing_revisions/publish","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","drawing_revisions","publish"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Publish Drawing Revisions","body":{"mode":"raw","raw":"{\n  \"distribute\": false,\n  \"drawing_area_id\": 0,\n  \"drawing_set_id\": 0\n}","options":{"raw":{"language":"json"}}}}},{"id":"294a9a1a-96d4-4621-87e9-b453645b9787","name":"listProjectDrawingRevisionDrawingTiles — List drawing tiles","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/drawing_revisions/:drawing_revision_id/drawing_tiles","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","drawing_revisions",":drawing_revision_id","drawing_tiles"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"drawing_revision_id","value":""}]},"description":"List drawing tiles"}},{"id":"02eb6090-0216-4015-8f1f-ca46b01fe829","name":"getProjectDrawingRevision — Show Drawing Revision","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/drawing_revisions/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","drawing_revisions",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Show Drawing Revision"}},{"id":"27f8350d-1dfa-4131-8431-460f27d4ad6f","name":"updateProjectDrawingRevision — Update Drawing Revision","request":{"method":"PATCH","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/drawing_revisions/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","drawing_revisions",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Update Drawing Revision","body":{"mode":"raw","raw":"{\n  \"drawing_revision\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"fae185c3-529a-4ce1-8fa3-af2c208f2af9","name":"listProjectDrawingRevisionMarkups — List markups for a drawing revision","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/drawing_revisions/:id/markups","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","drawing_revisions",":id","markups"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"List markups for a drawing revision"}},{"id":"06e6b307-7453-419e-8e7e-d0fc1f826c8d","name":"createProjectDrawingRevisionMarkup — Create a markup layer on a drawing revision","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/drawing_revisions/:id/markups","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","drawing_revisions",":id","markups"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Create a markup layer on a drawing revision","body":{"mode":"raw","raw":"{\n  \"markup\": {\n    \"data\": [\n      {}\n    ]\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"5168b8dd-f1cc-4bb1-883d-ed427d3d5849","name":"getProjectDrawingRevisionMarkup — Show a markup","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/drawing_revisions/:id/markups/:markup_id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","drawing_revisions",":id","markups",":markup_id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""},{"key":"markup_id","value":""}]},"description":"Show a markup"}},{"id":"a12fe4f3-169e-416b-8504-2aa953640fff","name":"updateProjectDrawingRevisionMarkup — Update a markup layer","request":{"method":"PATCH","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/drawing_revisions/:id/markups/:markup_id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","drawing_revisions",":id","markups",":markup_id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""},{"key":"markup_id","value":""}]},"description":"Update a markup layer\n\nConcurrency contract transition: unconditional writes are no longer accepted. GET this markup first and send its exact ETag in If-Match. A changed version returns 412 without writing; review the latest contents before retrying. Missing If-Match returns 428. One strong token only; wildcard, weak and multiple tokens are rejected. Authorization and nested revision checks still apply before checking the precondition.","body":{"mode":"raw","raw":"{\n  \"markup\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"484d16ff-2aad-4d5b-8600-623eb0cb5b84","name":"deleteProjectDrawingRevisionMarkup — Delete a markup layer","request":{"method":"DELETE","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/drawing_revisions/:id/markups/:markup_id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","drawing_revisions",":id","markups",":markup_id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""},{"key":"markup_id","value":""}]},"description":"Delete a markup layer\n\nConcurrency contract transition: unconditional writes are no longer accepted. GET this markup first and send its exact ETag in If-Match. A changed version returns 412 without writing; review the latest contents before retrying. Missing If-Match returns 428. One strong token only; wildcard, weak and multiple tokens are rejected. Authorization and nested revision checks still apply before checking the precondition."}},{"id":"5cb6d5ba-a4e9-4123-875c-813f2ecc7b68","name":"listProjectDrawingSets — List drawing sets","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/drawing_sets","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","drawing_sets"],"query":[{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true},{"key":"filters[exclude_empty_sets]","value":"","disabled":true},{"key":"filters[only_attachable_sets]","value":"","disabled":true},{"key":"filters[with_sketches]","value":"","disabled":true},{"key":"filters[with_measurements]","value":"","disabled":true},{"key":"drawing_area_id","value":"","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"List drawing sets"}},{"id":"97dfb32c-57bf-4826-8bbb-073911e346fe","name":"createProjectDrawingSet — Create drawing set","request":{"method":"POST","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/drawing_sets","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","drawing_sets"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Create drawing set","body":{"mode":"raw","raw":"{\n  \"date\": \"2026-01-31\",\n  \"name\": \"\"\n}","options":{"raw":{"language":"json"}}}}},{"id":"c9032056-e4cb-4030-820f-f1378a8470b8","name":"getProjectDrawingSet — Get drawing set","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/drawing_sets/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","drawing_sets",":id"],"query":[{"key":"drawing_area_id","value":"","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Get drawing set\n\nRequires the `view` permission on the project's drawings tool. A scoped API token needs `drawings:read`.","body":{"mode":"raw","raw":"{\n  \"date\": \"\",\n  \"name\": \"\",\n  \"received_date\": \"\",\n  \"status\": \"draft\"\n}","options":{"raw":{"language":"json"}}}}},{"id":"e805094a-a1d1-4121-8b56-2d4b78bad78c","name":"updateProjectDrawingSet — Update drawing set","request":{"method":"PATCH","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/drawing_sets/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","drawing_sets",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Update drawing set","body":{"mode":"raw","raw":"{\n  \"drawing_set\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"e1fbbfff-7bc7-4beb-8f2b-ce926e1afbb9","name":"deleteProjectDrawingSet — Delete drawing set","request":{"method":"DELETE","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/drawing_sets/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","drawing_sets",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Delete drawing set\n\nDelete an unused drawing set. A published set, or a set holding revisions, returns 409. Needs drawings delete permission."}},{"id":"0c5a71a1-bcb9-49bd-8b12-9b853306cc8b","name":"publishProjectDrawingSet — Publish drawing set","request":{"method":"POST","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/drawing_sets/:id/publish","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","drawing_sets",":id","publish"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Publish drawing set"}},{"id":"4b43dc68-9a19-4faf-84cb-9c0e834a8956","name":"listProjectDrawingSheetIndex — Sheet Index","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/drawing_sheet_index","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","drawing_sheet_index"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Sheet Index"}},{"id":"128081f7-b946-4533-819c-933f07b0f55c","name":"listProjectDrawingsRecycleBin — List recycled drawings (os.construction extension)","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/drawings/recycle_bin","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","drawings","recycle_bin"],"query":[{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"List recycled drawings (os.construction extension)"}},{"id":"f4e7a1ab-3c4b-4f21-8559-7ecb8db546af","name":"deleteProjectDrawing — Delete (recycle) a drawing (os.construction extension)","request":{"method":"DELETE","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/drawings/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","drawings",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Delete (recycle) a drawing (os.construction extension)"}},{"id":"e5c403fb-a092-4633-84b9-97e267d6bfdd","name":"listProjectDrawingCompare — Compare two revisions of a drawing (os.construction extension)","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/drawings/:id/compare","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","drawings",":id","compare"],"query":[{"key":"a","value":"","disabled":false},{"key":"b","value":"","disabled":false}],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Compare two revisions of a drawing (os.construction extension)"}},{"id":"e608039a-0c18-4ffe-895a-5f859a982113","name":"restoreProjectDrawing — Restore a recycled drawing (os.construction extension)","request":{"method":"PATCH","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/drawings/:id/restore","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","drawings",":id","restore"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Restore a recycled drawing (os.construction extension)"}},{"id":"99f40b57-d874-4179-8b1d-e66bae0a0452","name":"listDrawingAreaDrawingsV11 — List drawings","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.1/drawing_areas/:drawing_area_id/drawings","host":["{{baseUrl}}"],"path":["rest","v1.1","drawing_areas",":drawing_area_id","drawings"],"query":[{"key":"project_id","value":"","disabled":true},{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true},{"key":"filters[drawing_discipline_id]","value":"","disabled":true},{"key":"filters[drawing_set_id]","value":"","disabled":true},{"key":"with_position","value":"","disabled":true},{"key":"view","value":"","disabled":true}],"variable":[{"key":"drawing_area_id","value":""}]},"description":"List drawings"}},{"id":"583a40bb-2447-4fc8-8408-a8d560e355c8","name":"createDrawingAreaDrawingV11 — Create Drawing","request":{"method":"POST","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.1/drawing_areas/:drawing_area_id/drawings","host":["{{baseUrl}}"],"path":["rest","v1.1","drawing_areas",":drawing_area_id","drawings"],"variable":[{"key":"drawing_area_id","value":""}]},"description":"Create Drawing","body":{"mode":"raw","raw":"{\n  \"drawing\": {\n    \"drawing_discipline\": {\n      \"name\": \"\"\n    },\n    \"number\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"4dfb3b1b-9323-4b1b-857c-d4229afb0fe3","name":"getDrawingAreaDrawingV11 — Get drawing area drawing","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.1/drawing_areas/:drawing_area_id/drawings/:id","host":["{{baseUrl}}"],"path":["rest","v1.1","drawing_areas",":drawing_area_id","drawings",":id"],"variable":[{"key":"drawing_area_id","value":""},{"key":"id","value":""}]},"description":"Get drawing area drawing\n\nRequires the `view` permission on the project's drawings tool. A scoped API token needs `drawings:read`.","body":{"mode":"raw","raw":"{\n  \"drawing\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"66a224f4-3c77-4425-8457-9af98ac16af4","name":"updateDrawingAreaDrawingV11 — Update Drawing","request":{"method":"PATCH","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.1/drawing_areas/:drawing_area_id/drawings/:id","host":["{{baseUrl}}"],"path":["rest","v1.1","drawing_areas",":drawing_area_id","drawings",":id"],"variable":[{"key":"drawing_area_id","value":""},{"key":"id","value":""}]},"description":"Update Drawing","body":{"mode":"raw","raw":"{\n  \"drawing\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"6559fb80-9ca3-4bc2-8e40-30d7fdd26e80","name":"listProjectDrawingAreasV11 — List drawing areas","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.1/projects/:project_id/drawing_areas","host":["{{baseUrl}}"],"path":["rest","v1.1","projects",":project_id","drawing_areas"],"query":[{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true},{"key":"filters[id]","value":"","disabled":true},{"key":"filters[exclude_empty_connected]","value":"","disabled":true},{"key":"view","value":"","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"List drawing areas"}},{"id":"5c5e98dc-4980-4ca0-825e-09fefce6cc5f","name":"createProjectDrawingAreaV11 — Create drawing area","request":{"method":"POST","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.1/projects/:project_id/drawing_areas","host":["{{baseUrl}}"],"path":["rest","v1.1","projects",":project_id","drawing_areas"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Create drawing area","body":{"mode":"raw","raw":"{\n  \"name\": \"\"\n}","options":{"raw":{"language":"json"}}}}},{"id":"3c639d88-6165-47b2-8090-edfc997f20a5","name":"getProjectDrawingAreaV11 — Get drawing area","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.1/projects/:project_id/drawing_areas/:id","host":["{{baseUrl}}"],"path":["rest","v1.1","projects",":project_id","drawing_areas",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Get drawing area\n\nRequires the `view` permission on the project's drawings tool. A scoped API token needs `drawings:read`.","body":{"mode":"raw","raw":"{\n  \"description\": \"\",\n  \"name\": \"\"\n}","options":{"raw":{"language":"json"}}}}},{"id":"40d5fbe9-bea5-442d-85b2-b475d8da6973","name":"updateProjectDrawingAreaV11 — Update a drawing area","request":{"method":"PATCH","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.1/projects/:project_id/drawing_areas/:id","host":["{{baseUrl}}"],"path":["rest","v1.1","projects",":project_id","drawing_areas",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Update a drawing area","body":{"mode":"raw","raw":"{\n  \"name\": \"\"\n}","options":{"raw":{"language":"json"}}}}},{"id":"fabbf6f6-6906-4ca0-8aca-ee49f6afddc4","name":"deleteProjectDrawingAreaV11 — Delete a drawing area","request":{"method":"DELETE","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.1/projects/:project_id/drawing_areas/:id","host":["{{baseUrl}}"],"path":["rest","v1.1","projects",":project_id","drawing_areas",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Delete a drawing area\n\nDelete an empty drawing area. An area that still holds drawings (current or recycled) returns 409; move them to another area first. Needs drawings delete permission."}},{"id":"a18a55c8-a8a8-44f6-8f42-2772d693405e","name":"listProjectDrawingDisciplinesV11 — List Drawing Disciplines","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.1/projects/:project_id/drawing_disciplines","host":["{{baseUrl}}"],"path":["rest","v1.1","projects",":project_id","drawing_disciplines"],"query":[{"key":"filters[id]","value":"","disabled":true},{"key":"view","value":"","disabled":true},{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"List Drawing Disciplines"}},{"id":"91630197-2e41-4dc6-8271-b36859b997fe","name":"createProjectDrawingDisciplineV11 — Create drawing discipline","request":{"method":"POST","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.1/projects/:project_id/drawing_disciplines","host":["{{baseUrl}}"],"path":["rest","v1.1","projects",":project_id","drawing_disciplines"],"query":[{"key":"filters[id]","value":"","disabled":true},{"key":"view","value":"","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Create drawing discipline\n\nAlias of `POST /rest/v1.0/projects/{project_id}/drawing_disciplines`, with the same behaviour."}},{"id":"caa2ce18-53db-4d0b-88a7-70717a914fe9","name":"getProjectDrawingDisciplineV11 — Get drawing discipline","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.1/projects/:project_id/drawing_disciplines/:id","host":["{{baseUrl}}"],"path":["rest","v1.1","projects",":project_id","drawing_disciplines",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Get drawing discipline\n\nAlias of `GET /rest/v1.0/projects/{project_id}/drawing_disciplines/{id}`, with the same behaviour. Requires the `view` permission on the project's drawings tool. A scoped API token needs `drawings:read`.","body":{"mode":"raw","raw":"{\n  \"name\": \"\",\n  \"position\": 0\n}","options":{"raw":{"language":"json"}}}}},{"id":"c1687503-2ad9-4c93-8b59-3dc50442c462","name":"updateProjectDrawingDisciplineV11 — Update drawing discipline","request":{"method":"PATCH","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.1/projects/:project_id/drawing_disciplines/:id","host":["{{baseUrl}}"],"path":["rest","v1.1","projects",":project_id","drawing_disciplines",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Update drawing discipline","body":{"mode":"raw","raw":"{\n  \"name\": \"\"\n}","options":{"raw":{"language":"json"}}}}},{"id":"836328cb-6dc7-4192-8729-c74fd8d96936","name":"listProjectDrawingRevisionTermsV11 — List drawing revision terms","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.1/projects/:project_id/drawing_revision_terms","host":["{{baseUrl}}"],"path":["rest","v1.1","projects",":project_id","drawing_revision_terms"],"query":[{"key":"drawing_revision_ids","value":"","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"List drawing revision terms"}}]},{"name":"Email Intake","description":"Module: email_intake","item":[{"id":"60ae61d5-c964-42d5-895e-165644d71f92","name":"listProjectEmailIntakeAddresses — List inbound email addresses","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/email_intake/addresses","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","email_intake","addresses"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"List inbound email addresses\n\nRequires the project Admin tool at admin level (token scope admin:read for reads, admin:write for writes)."}},{"id":"8f8d0e03-0fde-4f92-8800-6cf205d439d1","name":"createProjectEmailIntakeAddress — Create an inbound email address","request":{"method":"POST","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/email_intake/addresses","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","email_intake","addresses"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Create an inbound email address\n\nRequires the project Admin tool at admin level (token scope admin:read for reads, admin:write for writes).","body":{"mode":"raw","raw":"{\n  \"inbound_address\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"b7febfde-c709-4ce4-88b4-7be5dde6d0d4","name":"getProjectEmailIntakeAddress — Show an inbound email address","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/email_intake/addresses/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","email_intake","addresses",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Show an inbound email address\n\nRequires the project Admin tool at admin level (token scope admin:read for reads, admin:write for writes)."}},{"id":"2cfcd577-2d99-4fbf-829d-d56ba0bc98df","name":"updateProjectEmailIntakeAddress — Update an inbound email address","request":{"method":"PATCH","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/email_intake/addresses/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","email_intake","addresses",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Update an inbound email address\n\nRequires the project Admin tool at admin level (token scope admin:read for reads, admin:write for writes). Disable an address to stop it accepting mail; mail to a disabled address is logged as rejected.","body":{"mode":"raw","raw":"{\n  \"inbound_address\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"4cb4ddd4-1d34-43e9-848c-6ec35cc8ac4a","name":"rotateProjectEmailIntakeAddress — Rotate an inbound email address","request":{"method":"POST","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/email_intake/addresses/:id/rotate","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","email_intake","addresses",":id","rotate"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Rotate an inbound email address\n\nRequires the project Admin tool at admin level (token scope admin:read for reads, admin:write for writes). Issues a new unguessable address; the previous one stops accepting mail immediately."}},{"id":"72de23bd-581b-4681-8f3a-891b63b6e42c","name":"listProjectEmailIntakeMessages — List the email intake log","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/email_intake/messages","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","email_intake","messages"],"query":[{"key":"status","value":"","disabled":true},{"key":"address_id","value":"","disabled":true},{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"List the email intake log\n\nRequires the project Admin tool at admin level (token scope admin:read for reads, admin:write for writes). Newest first. Bodies are not stored in the log; open the draft record."}},{"id":"cd132e09-b683-4285-85f9-de58d9f27d99","name":"createProjectEmailIntakeMessage — Upload an .eml as a draft","request":{"method":"POST","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/email_intake/messages","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","email_intake","messages"],"query":[{"key":"target_type","value":"","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Upload an .eml as a draft\n\nUploads one RFC 5322 message (.eml) and turns it into a DRAFT for review, created as the caller. target_type rfi needs RFI create permission (rfis:write), submittal needs submittal create permission (submittals:write), ap_invoice needs AP entry (accounting:write) and puts the PDF/image attachments in the AP capture inbox. Auto-replies, list mail and loops are rejected. A repeat upload of the same message (same Message-ID) answers 200 with the earlier log entry. Works whether or not inbound mail receiving is enabled.","body":{"mode":"formdata","formdata":[{"key":"file","type":"file","src":[]}]}}},{"id":"d408b8b1-486a-4ba6-8d9c-7452c9ebbf40","name":"getProjectEmailIntakeMessage — Show an email intake log entry","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/email_intake/messages/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","email_intake","messages",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Show an email intake log entry\n\nRequires the project Admin tool at admin level (token scope admin:read for reads, admin:write for writes)."}}]},{"name":"Emails","description":"Module: emails","item":[{"id":"eaabd928-c8d3-47db-8032-3c2aa7d0cb20","name":"listCommunicationThreads — List Communication Threads","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/communications/:communication_id/threads","host":["{{baseUrl}}"],"path":["rest","v1.0","communications",":communication_id","threads"],"query":[{"key":"project_id","value":"","disabled":false}],"variable":[{"key":"communication_id","value":""}]},"description":"List Communication Threads"}},{"id":"b78ecf08-5bc3-466d-8236-18cb66429e8c","name":"getCommunicationThread — Show Communication Thread","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/communications/:communication_id/threads/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","communications",":communication_id","threads",":id"],"query":[{"key":"project_id","value":"","disabled":false}],"variable":[{"key":"communication_id","value":""},{"key":"id","value":""}]},"description":"Show Communication Thread"}},{"id":"d99db41a-b127-4920-88b9-46889f72e3e3","name":"getCommunication — Show Communication","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/communications/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","communications",":id"],"query":[{"key":"project_id","value":"","disabled":false}],"variable":[{"key":"id","value":""}]},"description":"Show Communication"}},{"id":"f9ee92d2-aa41-48ff-8ec5-2476905fdd93","name":"createCompanyEmailCommunication — Create Company-level Email Communication","request":{"method":"POST","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/email_communications","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","email_communications"],"query":[{"key":"topic_type","value":"","disabled":false},{"key":"topic_id","value":"","disabled":false,"description":"The project id."}],"variable":[{"key":"company_id","value":"{{companyId}}"}]},"description":"Create Company-level Email Communication\n\nCreate a communication from the company-level inbox. Every communication belongs to a project: topic_type must be `project` (the default) and topic_id the project id. The write is the same as POST /rest/v1.0/project/{project_id}/email_communications (email create permission, tool enablement, recipient tenancy on that project).","body":{"mode":"raw","raw":"{\n  \"communication\": {},\n  \"email\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"8e58aad6-3687-4370-8d0f-1b5f270e9410","name":"listCompanyEmailCommunicationsEmails — List of Company-level Emails","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/email_communications/emails","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","email_communications","emails"],"query":[{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true},{"key":"topic_type","value":"","disabled":false},{"key":"topic_id","value":"","disabled":false}],"variable":[{"key":"company_id","value":"{{companyId}}"}]},"description":"List of Company-level Emails"}},{"id":"fb9f15ab-624c-4a24-81ca-a3cbc405e25d","name":"createCompanyEmailCommunicationEmail — Create Company-level Email","request":{"method":"POST","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/email_communications/:communication_id/emails","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","email_communications",":communication_id","emails"],"query":[{"key":"topic_type","value":"","disabled":false},{"key":"topic_id","value":"","disabled":false}],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"communication_id","value":""}]},"description":"Create Company-level Email\n\nReply on a communication from the company-level inbox. The communication is resolved only among those the caller can see (otherwise 404); the reply is written on its project with email create permission. topic_type/topic_id are accepted and ignored.","body":{"mode":"raw","raw":"{\n  \"email\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"cfcf200f-ce5f-40b9-803f-3b6b5a3057ca","name":"listCompanyEmailCommunicationEmailDownloadAttachments — Download all company-level email attachments","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/email_communications/:communication_id/emails/:email_id/download_attachments","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","email_communications",":communication_id","emails",":email_id","download_attachments"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"communication_id","value":""},{"key":"email_id","value":""}]},"description":"Download all company-level email attachments"}},{"id":"5dc0ebb4-75bd-495d-815a-f62fef9f137b","name":"getCompanyEmailCommunication — Show Company-level Email Communication","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/email_communications/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","email_communications",":id"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Show Company-level Email Communication"}},{"id":"42ca00b7-5e39-453d-806a-2c56f9a8191d","name":"updateCompanyEmailCommunication — Update a private field in Company-level Email Communication","request":{"method":"PATCH","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/email_communications/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","email_communications",":id"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Update a private field in Company-level Email Communication\n\nSet a communication's private flag from the company-level inbox. Resolved among communications the caller can see, then updated on its project with email edit permission.","body":{"mode":"raw","raw":"{\n  \"private\": false\n}","options":{"raw":{"language":"json"}}}}},{"id":"4317fb31-fa96-421b-81cf-cc7cc7995805","name":"listCompanyEmailCommunicationExport — Export Company-level Email Communication","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/email_communications/:id/export","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","email_communications",":id","export"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Export Company-level Email Communication"}},{"id":"ffe7cee3-72fd-4213-86fb-5cdaad5b9a49","name":"createProjectEmailCommunication — Create Email Communication","request":{"method":"POST","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/project/:project_id/email_communications","host":["{{baseUrl}}"],"path":["rest","v1.0","project",":project_id","email_communications"],"query":[{"key":"topic_type","value":"","disabled":false},{"key":"topic_id","value":"","disabled":false}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Create Email Communication","body":{"mode":"raw","raw":"{\n  \"communication\": {},\n  \"email\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"703288c7-54d5-4d56-89ab-9943f22ea101","name":"listProjectEmailCommunicationsEmails — List of Emails","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/project/:project_id/email_communications/emails","host":["{{baseUrl}}"],"path":["rest","v1.0","project",":project_id","email_communications","emails"],"query":[{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true},{"key":"topic_type","value":"","disabled":false},{"key":"topic_id","value":"","disabled":false}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"List of Emails"}},{"id":"f7c82c60-26ba-4e3f-87e3-de858307c489","name":"listProjectEmailCommunicationsFolderCounts — Count email communications by folder","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/project/:project_id/email_communications/folder_counts","host":["{{baseUrl}}"],"path":["rest","v1.0","project",":project_id","email_communications","folder_counts"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Count email communications by folder\n\nRequires the `view` permission on the project's emails tool. A scoped API token needs `emails:read`."}},{"id":"da287b2b-6cae-403c-87b5-6cbe40817f80","name":"createProjectEmailCommunicationEmail — Create Email","request":{"method":"POST","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/project/:project_id/email_communications/:communication_id/emails","host":["{{baseUrl}}"],"path":["rest","v1.0","project",":project_id","email_communications",":communication_id","emails"],"query":[{"key":"topic_type","value":"","disabled":false},{"key":"topic_id","value":"","disabled":false}],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"communication_id","value":""}]},"description":"Create Email","body":{"mode":"raw","raw":"{\n  \"email\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"a8feef61-542b-4941-8266-f705f2248ca7","name":"listProjectEmailCommunicationEmailDownloadAttachments — Download all email attachments","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/project/:project_id/email_communications/:communication_id/emails/:email_id/download_attachments","host":["{{baseUrl}}"],"path":["rest","v1.0","project",":project_id","email_communications",":communication_id","emails",":email_id","download_attachments"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"communication_id","value":""},{"key":"email_id","value":""}]},"description":"Download all email attachments"}},{"id":"2a6971bd-c9c4-47ae-8df4-461efd2617c2","name":"listProjectEmailCommunicationExport — Export Email Communication to PDF","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/project/:project_id/email_communications/:communication_id/export","host":["{{baseUrl}}"],"path":["rest","v1.0","project",":project_id","email_communications",":communication_id","export"],"query":[{"key":"topic_type","value":"","disabled":false}],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"communication_id","value":""}]},"description":"Export Email Communication to PDF"}},{"id":"7fbf9cea-5dae-48d3-8f35-887556e083ae","name":"getProjectEmailCommunication — Show Email Communication","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/project/:project_id/email_communications/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","project",":project_id","email_communications",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Show Email Communication"}},{"id":"0ae41fc0-b00d-4dcf-8194-69186851ca3f","name":"updateProjectEmailCommunication — Update a private field in Email Communication","request":{"method":"PATCH","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/project/:project_id/email_communications/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","project",":project_id","email_communications",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Update a private field in Email Communication","body":{"mode":"raw","raw":"{\n  \"private\": false\n}","options":{"raw":{"language":"json"}}}}},{"id":"59d4c468-5514-4551-8627-f0b9f35626ba","name":"moveProjectEmailCommunication — Move email communication","request":{"method":"POST","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/project/:project_id/email_communications/:id/move","host":["{{baseUrl}}"],"path":["rest","v1.0","project",":project_id","email_communications",":id","move"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Move email communication\n\nMove a communication's visible active messages to a folder tab (inbox/archive/spam). If none are active, restore its visible recycled messages first. Active conversations retain recycled siblings. Folder state is modeled locally. Returns the updated communication show shape."}},{"id":"f8d3de4a-f6f2-45bd-8a58-725d576cde4b","name":"readProjectEmailCommunication — Mark a whole communication thread read","request":{"method":"POST","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/project/:project_id/email_communications/:id/read","host":["{{baseUrl}}"],"path":["rest","v1.0","project",":project_id","email_communications",":id","read"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Mark a whole communication thread read"}},{"id":"da60ebfa-90c8-4796-8d37-73407422d7e9","name":"listProjectEmailCommunicationRelatedItems — List email communication related items","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/project/:project_id/email_communications/:id/related_items","host":["{{baseUrl}}"],"path":["rest","v1.0","project",":project_id","email_communications",":id","related_items"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"List email communication related items\n\nRequires the `view` permission on the project's emails tool. A scoped API token needs `emails:read`.","body":{"mode":"raw","raw":"{\n  \"related_item\": {\n    \"item_id\": 0,\n    \"item_type\": \"rfis\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"c5765be4-34f1-419b-8106-77349103e086","name":"createProjectEmailCommunicationRelatedItem — Create email communication related item","request":{"method":"POST","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/project/:project_id/email_communications/:id/related_items","host":["{{baseUrl}}"],"path":["rest","v1.0","project",":project_id","email_communications",":id","related_items"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Create email communication related item"}},{"id":"12b85969-2223-4255-84dc-ba4e3f8cf7a9","name":"deleteProjectEmailCommunicationRelatedItem — Delete email communication related item","request":{"method":"DELETE","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/project/:project_id/email_communications/:id/related_items/:related_item_id","host":["{{baseUrl}}"],"path":["rest","v1.0","project",":project_id","email_communications",":id","related_items",":related_item_id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""},{"key":"related_item_id","value":""}]},"description":"Delete email communication related item"}}]},{"name":"Equipment","description":"Module: equipment","item":[{"id":"d65e6dae-c263-4ddd-82ec-a0b1eeb928e5","name":"listCompanyManagedEquipment — List equipment register","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/managed_equipment","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","managed_equipment"],"variable":[{"key":"company_id","value":"{{companyId}}"}]},"description":"List equipment register"}},{"id":"73e470be-040e-4b39-8100-e772f8e67f1c","name":"managedEquipmentCompany — Create equipment","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/managed_equipment","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","managed_equipment"],"variable":[{"key":"company_id","value":"{{companyId}}"}]},"description":"Create equipment","body":{"mode":"raw","raw":"{\n  \"managed_equipment\": {\n    \"name\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"561dc1c8-840b-468d-82f6-50298d2d8fff","name":"listCompanyManagedEquipmentFilterOptionsCategory — Category filter options","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/managed_equipment/filter_options/category","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","managed_equipment","filter_options","category"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company ID for the authenticated workspace."}]},"description":"Category filter options\n\nRequires equipment:read. Returns distinct nonempty categories in ascending order from active equipment in the company register. Each option uses the category string for both key and value."}},{"id":"9415e70d-857c-4171-810f-358f77a6fc64","name":"listCompanyManagedEquipmentFilterOptionsStatus — Status filter options","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/managed_equipment/filter_options/status","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","managed_equipment","filter_options","status"],"variable":[{"key":"company_id","value":"{{companyId}}"}]},"description":"Status filter options"}},{"id":"413bf97e-21cb-44d9-8326-bb58402009a2","name":"getCompanyManagedEquipment — Show equipment","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/managed_equipment/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","managed_equipment",":id"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Show equipment"}},{"id":"f312401b-952a-46dc-8ff3-76af7e3c95b1","name":"updateCompanyManagedEquipment — Update equipment","request":{"method":"PATCH","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/managed_equipment/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","managed_equipment",":id"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Update equipment"}},{"id":"7a9056d8-4c54-4b26-887f-321b57790ff9","name":"deleteCompanyManagedEquipment — Move equipment to the recycle bin","request":{"method":"DELETE","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/managed_equipment/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","managed_equipment",":id"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company ID for the authenticated workspace."},{"key":"id","value":"","description":"Managed equipment ID."}]},"description":"Move equipment to the recycle bin\n\nRequires equipment:write and an active company administrator. Soft-deletes active equipment so it can be restored from the company's recycle bin."}},{"id":"c7aaccb6-7ad0-45c9-884b-37656795c4c8","name":"listCompanyManagedEquipmentAssignments — List assignments","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/managed_equipment/:id/assignments","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","managed_equipment",":id","assignments"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"List assignments"}},{"id":"92d362bb-153b-406a-8019-d98c82d778fa","name":"createCompanyManagedEquipmentAssignment — Create assignment","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/managed_equipment/:id/assignments","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","managed_equipment",":id","assignments"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Create assignment"}},{"id":"47c30464-4784-4125-8528-de7063330bd5","name":"updateCompanyManagedEquipmentAssignment — Update an equipment assignment","request":{"method":"PATCH","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/managed_equipment/:id/assignments/:assignment_id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","managed_equipment",":id","assignments",":assignment_id"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company ID for the authenticated workspace."},{"key":"id","value":"","description":"Managed equipment ID."},{"key":"assignment_id","value":"","description":"Assignment ID on the managed equipment."}]},"description":"Update an equipment assignment\n\nRequires equipment:write and an active company administrator. The destination project must belong to the company and have the equipment tool enabled. Completing the current active assignment clears the equipment's current project and location and changes in_use to available. Activating a completed assignment or moving the current active assignment updates the dispatch and preserves under_maintenance status.","body":{"mode":"raw","raw":"{\n  \"equipment_assignment\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"8bf13554-7a3b-477c-824f-0da8914d45ac","name":"listCompanyManagedEquipmentInspections — List inspection records","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/managed_equipment/:id/inspections","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","managed_equipment",":id","inspections"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"List inspection records"}},{"id":"c7602781-013c-4f15-8467-9db983d682d4","name":"createCompanyManagedEquipmentInspection — Create inspection record","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/managed_equipment/:id/inspections","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","managed_equipment",":id","inspections"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Create inspection record","body":{"mode":"raw","raw":"{\n  \"managed_equipment_inspection\": {\n    \"date\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"37210280-c302-4a92-8c5f-8e669e8544cd","name":"getCompanyManagedEquipmentInspection — Show inspection record","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/managed_equipment/:id/inspections/:inspection_id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","managed_equipment",":id","inspections",":inspection_id"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""},{"key":"inspection_id","value":""}]},"description":"Show inspection record"}},{"id":"85f87a5e-b044-432c-8bb2-abf9983fa019","name":"updateCompanyManagedEquipmentInspection — Update inspection record","request":{"method":"PATCH","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/managed_equipment/:id/inspections/:inspection_id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","managed_equipment",":id","inspections",":inspection_id"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""},{"key":"inspection_id","value":""}]},"description":"Update inspection record"}},{"id":"1a875a67-a4ec-424b-8dcb-eae67005e072","name":"deleteCompanyManagedEquipmentInspection — Delete inspection record","request":{"method":"DELETE","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/managed_equipment/:id/inspections/:inspection_id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","managed_equipment",":id","inspections",":inspection_id"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""},{"key":"inspection_id","value":""}]},"description":"Delete inspection record"}},{"id":"d569cde0-acd1-4b77-8a9a-b9923030c5b9","name":"listCompanyManagedEquipmentMaintenanceLogs — List maintenance logs","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/managed_equipment/:id/maintenance_logs","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","managed_equipment",":id","maintenance_logs"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"List maintenance logs"}},{"id":"842641d9-f3e3-4cd1-8f46-4d2f2bd7d101","name":"createCompanyManagedEquipmentMaintenanceLog — Create maintenance log","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/managed_equipment/:id/maintenance_logs","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","managed_equipment",":id","maintenance_logs"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Create maintenance log"}},{"id":"c335d1d1-c152-43e0-85bc-3f4deec561c9","name":"getCompanyManagedEquipmentMaintenanceLog — Show an equipment maintenance log","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/managed_equipment/:id/maintenance_logs/:maintenance_id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","managed_equipment",":id","maintenance_logs",":maintenance_id"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company ID for the authenticated workspace."},{"key":"id","value":"","description":"Managed equipment ID."},{"key":"maintenance_id","value":"","description":"Maintenance log ID on the managed equipment."}]},"description":"Show an equipment maintenance log\n\nRequires equipment:read. Returns an active maintenance log on the specified active equipment in the authenticated company."}},{"id":"755af554-1a21-4724-889a-ab5d60ac5cf0","name":"updateCompanyManagedEquipmentMaintenanceLog — Update an equipment maintenance log","request":{"method":"PATCH","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/managed_equipment/:id/maintenance_logs/:maintenance_id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","managed_equipment",":id","maintenance_logs",":maintenance_id"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company ID for the authenticated workspace."},{"key":"id","value":"","description":"Managed equipment ID."},{"key":"maintenance_id","value":"","description":"Maintenance log ID on the managed equipment."}]},"description":"Update an equipment maintenance log\n\nRequires equipment:write and an active company administrator. Updates an existing active maintenance log on the specified equipment. Omitted fields keep their current values.","body":{"mode":"raw","raw":"{\n  \"managed_equipment_maintenance_log\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"0e95cd23-1cf8-4a67-8425-9f36f87789a9","name":"deleteCompanyManagedEquipmentMaintenanceLog — Delete an equipment maintenance log","request":{"method":"DELETE","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/managed_equipment/:id/maintenance_logs/:maintenance_id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","managed_equipment",":id","maintenance_logs",":maintenance_id"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company ID for the authenticated workspace."},{"key":"id","value":"","description":"Managed equipment ID."},{"key":"maintenance_id","value":"","description":"Maintenance log ID on the managed equipment."}]},"description":"Delete an equipment maintenance log\n\nRequires equipment:write and an active company administrator. Soft-deletes the active maintenance log on the specified equipment."}},{"id":"c482c627-d579-49d2-8242-f2d58c2d135b","name":"restoreCompanyManagedEquipment — Restore equipment from the recycle bin","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/managed_equipment/:id/restore","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","managed_equipment",":id","restore"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company ID for the authenticated workspace."},{"key":"id","value":"","description":"Managed equipment ID."}]},"description":"Restore equipment from the recycle bin\n\nRequires equipment:write and an active company administrator. Restores an equipment record previously moved to the company's recycle bin and returns the active record."}},{"id":"520d7bfa-92e1-4de7-888d-b34a81f536ae","name":"updateCompanyManagedEquipmentStatus — Set equipment operational status","request":{"method":"PATCH","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/managed_equipment/:id/status","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","managed_equipment",":id","status"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Company ID for the authenticated workspace."},{"key":"id","value":"","description":"Managed equipment ID."}]},"description":"Set equipment operational status\n\nRequires equipment:write and an active company administrator. Sets the status on active equipment. An equivalent managed_equipment.status field is accepted when the top-level status is absent or null.","body":{"mode":"raw","raw":"{\n  \"status\": \"available\"\n}","options":{"raw":{"language":"json"}}}}},{"id":"d0736ae1-c3f8-4547-89f1-0e902e2890ab","name":"listProjectManagedEquipment — List project-assigned equipment","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/managed_equipment","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","managed_equipment"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"List project-assigned equipment"}}]},{"name":"Expense Reports","description":"Module: expense_reports","item":[{"id":"34e92b27-841d-40c1-86be-d97e85ff370e","name":"listProjectExpenseReports — GET /rest/v1.0/projects/{project_id}/expense_reports","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/expense_reports","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","expense_reports"],"query":[{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true},{"key":"status","value":"","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"GET /rest/v1.0/projects/{project_id}/expense_reports"}},{"id":"b4aacf07-b253-4ebf-86d6-3d91b59cc023","name":"createProjectExpenseReport — POST /rest/v1.0/projects/{project_id}/expense_reports","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/expense_reports","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","expense_reports"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"POST /rest/v1.0/projects/{project_id}/expense_reports","body":{"mode":"raw","raw":"{\n  \"report\": {\n    \"currency\": \"USD\",\n    \"lines\": [\n      {\n        \"amount\": \"\",\n        \"cost_code_id\": 0,\n        \"description\": \"\"\n      }\n    ],\n    \"merchant\": \"\",\n    \"occurred_on\": \"2026-01-31\",\n    \"purpose\": \"\"\n  },\n  \"request_key\": \"\"\n}","options":{"raw":{"language":"json"}}}}},{"id":"a015943f-55ef-4be0-86f5-6f5a6bb3714d","name":"createProjectExpenseReportsReimbursementPayee — POST /rest/v1.0/projects/{project_id}/expense_reports/reimbursement_payees","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/expense_reports/reimbursement_payees","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","expense_reports","reimbursement_payees"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"POST /rest/v1.0/projects/{project_id}/expense_reports/reimbursement_payees\n\nRequires expense report admin, accounting manageVendorBanking with unrestricted entity access, accounting step-up, expense_reports:read/write and accounting:write scopes. Active same-company project claimant and payee; mapper cannot be claimant. One vendor maps to one claimant. expected_version=0 creates; changes use current version and an audited identity-verification reason.","body":{"mode":"raw","raw":"{\n  \"claimant_id\": 0,\n  \"expected_version\": 0,\n  \"reason\": \"\",\n  \"vendor_id\": 0\n}","options":{"raw":{"language":"json"}}}}},{"id":"fd0ffed4-54e0-46ef-834f-095ebf58407e","name":"getProjectExpenseReport — GET /rest/v1.0/projects/{project_id}/expense_reports/{id}","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/expense_reports/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","expense_reports",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"GET /rest/v1.0/projects/{project_id}/expense_reports/{id}"}},{"id":"784ea18b-7a2d-4127-88ca-e0938002b0f4","name":"updateProjectExpenseReport — PATCH /rest/v1.0/projects/{project_id}/expense_reports/{id}","request":{"method":"PATCH","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/expense_reports/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","expense_reports",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"PATCH /rest/v1.0/projects/{project_id}/expense_reports/{id}","body":{"mode":"raw","raw":"{\n  \"expected_version\": 0,\n  \"report\": {\n    \"currency\": \"USD\",\n    \"lines\": [\n      {\n        \"amount\": \"\",\n        \"cost_code_id\": 0,\n        \"description\": \"\"\n      }\n    ],\n    \"merchant\": \"\",\n    \"occurred_on\": \"2026-01-31\",\n    \"purpose\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"06695cd1-eeb6-436f-8c02-8efea8182603","name":"listProjectExpenseReportReimbursement — GET /rest/v1.0/projects/{project_id}/expense_reports/{id}/reimbursement","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/expense_reports/:id/reimbursement","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","expense_reports",":id","reimbursement"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"GET /rest/v1.0/projects/{project_id}/expense_reports/{id}/reimbursement\n\nRequires expense report admin, expense_reports:read/write and accounting:write; returns management choices without receipt URLs. Receipt evidence additionally requires documents:read and live ACL access."}},{"id":"e9ecfda5-a05a-4500-8bb6-7b5be34f79d5","name":"reimbursementProjectExpenseReport — POST /rest/v1.0/projects/{project_id}/expense_reports/{id}/reimbursement","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/expense_reports/:id/reimbursement","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","expense_reports",":id","reimbursement"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"POST /rest/v1.0/projects/{project_id}/expense_reports/{id}/reimbursement\n\nCreates only a draft AP bill from the current approved revision. Explicit verified employee/payee mapping; claimant, reviewer and converter must differ. Currency must match both company base and entity functional currency. Amount, company, entity and payee cannot be supplied. Identical same-converter request replays its original bill forever, including after void. Changed retry conflicts. Source evidence remains protected in Expense Reports.","body":{"mode":"raw","raw":"{\n  \"expected_version\": 0,\n  \"lines\": [\n    {\n      \"account_id\": 0,\n      \"claim_line_id\": 0\n    }\n  ],\n  \"mapping_version\": 0,\n  \"reason\": \"\"\n}","options":{"raw":{"language":"json"}}}}},{"id":"f2a9b36d-6b02-46c6-83a4-47c012d8cfa9","name":"createProjectExpenseReportTransition — POST /rest/v1.0/projects/{project_id}/expense_reports/{id}/transitions","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/expense_reports/:id/transitions","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","expense_reports",":id","transitions"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"POST /rest/v1.0/projects/{project_id}/expense_reports/{id}/transitions","body":{"mode":"raw","raw":"{\n  \"accept_missing_receipt\": false,\n  \"action\": \"submit\",\n  \"expected_version\": 0,\n  \"reason\": \"\"\n}","options":{"raw":{"language":"json"}}}}}]},{"name":"Forms","description":"Module: forms","item":[{"id":"8d3f2652-9517-4270-8995-2e595246a281","name":"listCompanyFormTemplates — List Company Form Templates","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/form_templates","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","form_templates"],"query":[{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true},{"key":"filters[id]","value":"","disabled":true},{"key":"filters[created_at]","value":"","disabled":true},{"key":"filters[updated_at]","value":"","disabled":true}],"variable":[{"key":"company_id","value":"{{companyId}}"}]},"description":"List Company Form Templates"}},{"id":"67d7f988-383b-446f-8731-c0a1afe4e737","name":"createCompanyFormTemplate — Create Company Form Template","request":{"method":"POST","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/form_templates","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","form_templates"],"variable":[{"key":"company_id","value":"{{companyId}}"}]},"description":"Create Company Form Template","body":{"mode":"formdata","formdata":[{"key":"fillable_pdf","type":"file","src":[]},{"key":"form_template","value":"","type":"text"}]}}},{"id":"0c87f514-7d56-46da-83ec-92d48a54b712","name":"getCompanyFormTemplate — Show Company Form Template","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/form_templates/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","form_templates",":id"],"variable":[{"key":"id","value":""},{"key":"company_id","value":"{{companyId}}"}]},"description":"Show Company Form Template"}},{"id":"93e60551-ca9c-48ee-8137-7e4eeebd128d","name":"updateCompanyFormTemplate — Update Company Form Template","request":{"method":"PATCH","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/form_templates/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","form_templates",":id"],"variable":[{"key":"id","value":""},{"key":"company_id","value":"{{companyId}}"}]},"description":"Update Company Form Template","body":{"mode":"raw","raw":"{\n  \"form_template\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"ff32e428-14bc-49e0-8278-8a3961bff24a","name":"deleteCompanyFormTemplate — Delete Company Form Template","request":{"method":"DELETE","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/form_templates/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","form_templates",":id"],"variable":[{"key":"id","value":""},{"key":"company_id","value":"{{companyId}}"}]},"description":"Delete Company Form Template"}},{"id":"769c6a14-78a2-46a0-8ca4-23df5f470038","name":"listCompanyFormTemplateDocument — Generate form template document","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/form_templates/:id/document","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","form_templates",":id","document"],"query":[{"key":"original_id","value":"","disabled":true},{"key":"download","value":"","disabled":true}],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Generate form template document\n\nA scoped API token needs `forms:read`."}},{"id":"5fe8ec0d-326b-4d2a-8813-ede1dd06e6d6","name":"listCompanyRecycleBinFormTemplates — List Recycled Company Form Templates","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/recycle_bin/form_templates","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","recycle_bin","form_templates"],"query":[{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true},{"key":"filters[id]","value":"","disabled":true},{"key":"filters[created_at]","value":"","disabled":true},{"key":"filters[updated_at]","value":"","disabled":true}],"variable":[{"key":"company_id","value":"{{companyId}}"}]},"description":"List Recycled Company Form Templates"}},{"id":"1eb549a6-5bdc-4997-8aca-86181aebf2aa","name":"getCompanyRecycleBinFormTemplate — Show Recycled Company Form Template","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/recycle_bin/form_templates/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","recycle_bin","form_templates",":id"],"variable":[{"key":"id","value":""},{"key":"company_id","value":"{{companyId}}"}]},"description":"Show Recycled Company Form Template"}},{"id":"052ea351-ed4d-408e-8ea1-39a2f3deb518","name":"restoreCompanyRecycleBinFormTemplate — Restore Company Form Template","request":{"method":"PATCH","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/recycle_bin/form_templates/:id/restore","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","recycle_bin","form_templates",":id","restore"],"variable":[{"key":"id","value":""},{"key":"company_id","value":"{{companyId}}"}]},"description":"Restore Company Form Template"}},{"id":"d7a7e177-8ee2-4dbe-8822-adcbb8bbeef6","name":"listProjectFormTemplates — List Company Form Templates from Project","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/form_templates","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","form_templates"],"query":[{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true},{"key":"filters[id]","value":"","disabled":true},{"key":"filters[created_at]","value":"","disabled":true},{"key":"filters[updated_at]","value":"","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"List Company Form Templates from Project"}},{"id":"dbac095b-a128-4c18-802a-3d39881076fe","name":"getProjectFormTemplate — Show Company Form Template from Project","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/form_templates/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","form_templates",":id"],"variable":[{"key":"id","value":""},{"key":"project_id","value":"{{projectId}}"}]},"description":"Show Company Form Template from Project"}},{"id":"7041535a-64b7-409d-83db-4af77ea2d780","name":"listProjectForms — List Forms on a project","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/forms","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","forms"],"query":[{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true},{"key":"filters[id]","value":"","disabled":true},{"key":"filters[created_by_id]","value":"","disabled":true},{"key":"filters[form_template_id]","value":"","disabled":true},{"key":"filters[search]","value":"","disabled":true},{"key":"filters[created_at]","value":"","disabled":true},{"key":"filters[updated_at]","value":"","disabled":true},{"key":"sort","value":"","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"List Forms on a project"}},{"id":"83fa784c-6f00-4c95-8394-31ae53dcdee6","name":"createProjectForm — Create Form","request":{"method":"POST","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/forms","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","forms"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Create Form","body":{"mode":"raw","raw":"{\n  \"form\": {\n    \"fillable_pdf_prostore_file_id\": 0,\n    \"form_template_id\": 0,\n    \"name\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"1ed0e04a-4e81-4f31-8100-8284407a734f","name":"createProjectFormsCreateFromTemplate — Create form from template","request":{"method":"POST","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/forms/create_from_template","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","forms","create_from_template"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Create form from template"}},{"id":"c6dff608-895e-48dd-8b23-5227ba2ac39f","name":"createProjectFormsCreateWithFile — Create form with files","request":{"method":"POST","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/forms/create_with_files","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","forms","create_with_files"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Create form with files"}},{"id":"ebf3293c-281f-4281-81ed-96f7cb978f88","name":"getProjectForm — Show Form","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/forms/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","forms",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Show Form"}},{"id":"e085acb6-c1a8-4e89-8157-320ec2d3faf2","name":"updateProjectForm — Update Form","request":{"method":"PATCH","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/forms/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","forms",":id"],"query":[{"key":"send_emails","value":"","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Update Form","body":{"mode":"raw","raw":"{\n  \"form\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"e388ea11-ea45-4346-87f6-24122d58ebaf","name":"deleteProjectForm — Delete Form","request":{"method":"DELETE","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/forms/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","forms",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Delete Form"}},{"id":"d44563fa-639c-4b33-83ca-f9388f40fcaf","name":"createProjectFormAttachment — Upload form attachment","request":{"method":"POST","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/forms/:id/attachments","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","forms",":id","attachments"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Upload form attachment"}},{"id":"c8055d64-17a0-470e-8478-7e6b86ca5724","name":"listProjectFormDocument — Generate form document","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/forms/:id/document","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","forms",":id","document"],"query":[{"key":"download","value":"","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Generate form document\n\nRequires the `view` permission on the project's forms tool. A scoped API token needs `forms:read`.","body":{"mode":"formdata","formdata":[{"key":"file","type":"file","src":[]}]}}},{"id":"3767e04c-78dc-43c3-850f-6f1947a1c09e","name":"documentProjectForm — Generate form document","request":{"method":"POST","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/forms/:id/document","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","forms",":id","document"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Generate form document"}},{"id":"86887a81-0ead-488e-83f9-dbd0380b9d93","name":"updateProjectFormFieldValues — Update form field values","request":{"method":"PATCH","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/forms/:id/field_values","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","forms",":id","field_values"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Update form field values"}},{"id":"9e64e588-6171-4267-8cb8-dc89a80f9bbe","name":"listProjectRecycleBinForms — List Recycled Project Forms","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/recycle_bin/forms","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","recycle_bin","forms"],"query":[{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true},{"key":"filters[id]","value":"","disabled":true},{"key":"filters[created_at]","value":"","disabled":true},{"key":"filters[updated_at]","value":"","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"List Recycled Project Forms"}},{"id":"6e4debf1-ea61-4e55-8392-cbc44eab5c3d","name":"getProjectRecycleBinForm — Show Recycled Project Form","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/recycle_bin/forms/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","recycle_bin","forms",":id"],"variable":[{"key":"id","value":""},{"key":"project_id","value":"{{projectId}}"}]},"description":"Show Recycled Project Form"}},{"id":"d1239ff7-b218-46d6-8f2f-a421e72e0455","name":"restoreProjectRecycleBinForm — Restore Project Form","request":{"method":"PATCH","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/recycle_bin/forms/:id/restore","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","recycle_bin","forms",":id","restore"],"variable":[{"key":"id","value":""},{"key":"project_id","value":"{{projectId}}"}]},"description":"Restore Project Form"}},{"id":"bc315670-5e62-4d62-8649-3a2f87a8cfb5","name":"listProjectFormsV11 — List Forms on a project","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.1/projects/:project_id/forms","host":["{{baseUrl}}"],"path":["rest","v1.1","projects",":project_id","forms"],"query":[{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true},{"key":"filters[id]","value":"","disabled":true},{"key":"filters[private]","value":"","disabled":true},{"key":"filters[created_by_id]","value":"","disabled":true},{"key":"filters[form_template_id]","value":"","disabled":true},{"key":"filters[search]","value":"","disabled":true},{"key":"filters[created_at]","value":"","disabled":true},{"key":"filters[updated_at]","value":"","disabled":true},{"key":"sort","value":"","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"List Forms on a project"}}]},{"name":"Identity","description":"Module: identity","item":[{"id":"a8168d8f-7f80-4075-8d26-eb7a540fb8ab","name":"listAuthConnectedApps — List your connected apps","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/auth/connected_apps","host":["{{baseUrl}}"],"path":["rest","v1.0","auth","connected_apps"],"query":[{"key":"after","value":"","disabled":true}]},"description":"List your connected apps\n\nYour own live authorizations. People only."}},{"id":"6cdc0eac-394b-41a4-8330-8b27a39ceae8","name":"deleteAuthConnectedApp — Revoke one of your connected apps","request":{"method":"DELETE","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/auth/connected_apps/:grant_id","host":["{{baseUrl}}"],"path":["rest","v1.0","auth","connected_apps",":grant_id"],"variable":[{"key":"grant_id","value":"","description":"Authorization id (uuid)"}]},"description":"Revoke one of your connected apps\n\nPeople only."}},{"id":"cb77e4e4-82c1-4022-8227-5bff746f4dbc","name":"listCompanyAgentActivity — Non-human API activity","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/agent_activity","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","agent_activity"],"query":[{"key":"actor_type","value":"","disabled":true},{"key":"outcome","value":"","disabled":true},{"key":"writes","value":"","disabled":true},{"key":"before","value":"","disabled":true},{"key":"per_page","value":"100","disabled":true}],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Your company id; must match the caller's company."}]},"description":"Non-human API activity\n\nCalls by service accounts, agents and partner apps, newest first. actor_type=agent&writes=true&outcome=allowed lists agent proposals awaiting human review; outcome=denied lists refused attempts."}},{"id":"0d05f75d-3ea0-4ce6-852f-2eb8097119ef","name":"listCompanyConnectedApps — List every app authorization in your company","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/connected_apps","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","connected_apps"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Your company id; must match the caller's company."}]},"description":"List every app authorization in your company\n\nLive authorizations of partner apps and MCP clients held by your company's people."}},{"id":"32c6c9b1-c924-4e8a-81e9-3cf135a6259e","name":"deleteCompanyConnectedApp — Revoke a person's app authorization","request":{"method":"DELETE","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/connected_apps/:grant_id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","connected_apps",":grant_id"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Your company id; must match the caller's company."},{"key":"grant_id","value":"","description":"Authorization id (uuid)"}]},"description":"Revoke a person's app authorization\n\nEnds the authorization and all its tokens now."}},{"id":"2285f69c-2fe5-4629-8b29-acd3d08923b3","name":"listCompanyOauthApps — List partner apps registered by your company","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/oauth_apps","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","oauth_apps"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Your company id; must match the caller's company."}]},"description":"List partner apps registered by your company"}},{"id":"7b54a727-75e0-4361-8d2b-12ab5bc0f598","name":"createCompanyOauthApp — Register a partner app","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/oauth_apps","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","oauth_apps"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Your company id; must match the caller's company."}]},"description":"Register a partner app\n\nRegisters a public OAuth client (authorization code with PKCE S256, no client secret). Apps your company registers can only be authorized by your company's people. A platform review sets the verified badge.","body":{"mode":"raw","raw":"{\n  \"oauth_app\": {\n    \"name\": \"\",\n    \"redirect_uris\": [\n      \"\"\n    ],\n    \"scopes\": [\n      \"rfis:read\"\n    ]\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"38df3584-a077-4532-8bac-89f95affdac9","name":"getCompanyOauthApp — Show a partner app","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/oauth_apps/:client_id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","oauth_apps",":client_id"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Your company id; must match the caller's company."},{"key":"client_id","value":"","description":"Partner app client id"}]},"description":"Show a partner app"}},{"id":"f39ef689-e83b-4f3c-80e0-244bce311b6f","name":"updateCompanyOauthApp — Update a partner app","request":{"method":"PATCH","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/oauth_apps/:client_id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","oauth_apps",":client_id"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Your company id; must match the caller's company."},{"key":"client_id","value":"","description":"Partner app client id"}]},"description":"Update a partner app\n\nNarrowing scopes invalidates authorizations outside the new set at once; widening needs fresh consent. Changing the name, logo, redirect URIs or scopes clears the verified badge. enabled: false pauses every token.","body":{"mode":"raw","raw":"{\n  \"oauth_app\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"dbbfc365-05b3-4d2c-8a40-add6c80b6eb8","name":"deleteCompanyOauthApp — Retire a partner app","request":{"method":"DELETE","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/oauth_apps/:client_id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","oauth_apps",":client_id"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Your company id; must match the caller's company."},{"key":"client_id","value":"","description":"Partner app client id"}]},"description":"Retire a partner app\n\nRevokes every authorization in the same transaction. The client id stays reserved."}},{"id":"b052632f-75ab-4f8c-8ee0-e91ba601eb24","name":"listCompanyServiceAccounts — List service accounts","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/service_accounts","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","service_accounts"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Your company id; must match the caller's company."}]},"description":"List service accounts\n\nCompany admins only. Never returns secrets."}},{"id":"508bb706-fae6-40c3-8055-b518a37eb62f","name":"createCompanyServiceAccount — Create a service account","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/service_accounts","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","service_accounts"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Your company id; must match the caller's company."}]},"description":"Create a service account\n\nCreates a non-human account for an unattended integration. It cannot sign in to the app, cannot be a super admin and does not use a seat. Add credentials and project access next.","body":{"mode":"raw","raw":"{\n  \"service_account\": {\n    \"name\": \"\",\n    \"owner_user_id\": 0\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"d4855194-c241-4f2d-8f78-36426a2ce512","name":"getCompanyServiceAccount — Show a service account","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/service_accounts/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","service_accounts",":id"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Your company id; must match the caller's company."},{"key":"id","value":"","description":"Service account id"}]},"description":"Show a service account"}},{"id":"e49adb6e-3e54-4218-887e-578578b7da86","name":"updateCompanyServiceAccount — Update or disable a service account","request":{"method":"PATCH","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/service_accounts/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","service_accounts",":id"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Your company id; must match the caller's company."},{"key":"id","value":"","description":"Service account id"}]},"description":"Update or disable a service account\n\ndisabled: true revokes every credential and access token immediately.","body":{"mode":"raw","raw":"{\n  \"service_account\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"c8af918e-ac90-4607-8b02-51c7e54e016d","name":"listCompanyServiceAccountCalls — Service account audit log","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/service_accounts/:id/calls","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","service_accounts",":id","calls"],"query":[{"key":"before","value":"","disabled":true},{"key":"per_page","value":"100","disabled":true}],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Your company id; must match the caller's company."},{"key":"id","value":"","description":"Service account id"}]},"description":"Service account audit log\n\nEvery API call the account made, newest first, including denied attempts. The next page cursor is in X-Next-Before."}},{"id":"da521121-d9cb-406a-8665-2e92795c4f78","name":"listCompanyServiceAccountCredentials — List credentials","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/service_accounts/:id/credentials","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","service_accounts",":id","credentials"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Your company id; must match the caller's company."},{"key":"id","value":"","description":"Service account id"}]},"description":"List credentials\n\nNever returns secrets."}},{"id":"81c9e910-6ab5-4fd2-88d4-6f7d6a7a29f9","name":"createCompanyServiceAccountCredential — Create a credential","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/service_accounts/:id/credentials","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","service_accounts",":id","credentials"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Your company id; must match the caller's company."},{"key":"id","value":"","description":"Service account id"}]},"description":"Create a credential\n\nIssues an API key (bearer) or an OAuth client secret (client_credentials). The secret is returned once. Scopes cannot exceed the scopes of the token making this call. At most 10 active credentials; expiry 1 to 365 days (default 90).","body":{"mode":"raw","raw":"{\n  \"credential\": {\n    \"label\": \"\",\n    \"scopes\": [\n      \"rfis:read\"\n    ]\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"a39d5fed-8d1a-440d-86f4-826a02c94031","name":"deleteCompanyServiceAccountCredential — Revoke a credential","request":{"method":"DELETE","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/service_accounts/:id/credentials/:credential_id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","service_accounts",":id","credentials",":credential_id"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Your company id; must match the caller's company."},{"key":"id","value":"","description":"Service account id"},{"key":"credential_id","value":"","description":"Credential id"}]},"description":"Revoke a credential\n\nStops the credential and every token minted from it now."}},{"id":"5eb9e73b-b4e4-4832-807b-9d8234fb701d","name":"rotateCompanyServiceAccountCredential — Rotate a credential","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/service_accounts/:id/credentials/:credential_id/rotate","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","service_accounts",":id","credentials",":credential_id","rotate"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Your company id; must match the caller's company."},{"key":"id","value":"","description":"Service account id"},{"key":"credential_id","value":"","description":"Credential id"}]},"description":"Rotate a credential\n\nIssues a replacement with the same kind, label and scopes (secret shown once). The old secret keeps working for overlap_hours (0 to 168, default 24), then stops.","body":{"mode":"raw","raw":"{\n  \"rotation\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"185d40b8-f548-4e7d-869c-83f4de59dbf1","name":"listCompanyServiceAccountProjects — List project access","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/service_accounts/:id/projects","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","service_accounts",":id","projects"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Your company id; must match the caller's company."},{"key":"id","value":"","description":"Service account id"}]},"description":"List project access"}},{"id":"c108174b-92cb-4413-8689-24fed9988af0","name":"replaceCompanyServiceAccountProjects — Set project access","request":{"method":"PUT","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/service_accounts/:id/projects","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","service_accounts",":id","projects"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Your company id; must match the caller's company."},{"key":"id","value":"","description":"Service account id"}]},"description":"Set project access\n\nAdds the account to a project with a permission template, or removes it (permission_template_id null). Permission templates apply exactly as for a person.","body":{"mode":"raw","raw":"{\n  \"project_access\": {\n    \"permission_template_id\": 0,\n    \"project_id\": 0\n  }\n}","options":{"raw":{"language":"json"}}}}}]},{"name":"Incidents","description":"Module: incidents","item":[{"id":"5d4b0fd6-2d43-4483-87d2-9e1165781539","name":"listProjectIncidents — List Incidents","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/incidents","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","incidents"],"query":[{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true},{"key":"filters[id]","value":"","disabled":true},{"key":"filters[created_at]","value":"","disabled":true},{"key":"filters[updated_at]","value":"","disabled":true},{"key":"filters[event_date]","value":"","disabled":true},{"key":"filters[location_id]","value":"","disabled":true},{"key":"filters[status]","value":"","disabled":true},{"key":"filters[contributing_behavior_id]","value":"","disabled":true},{"key":"filters[contributing_condition_id]","value":"","disabled":true},{"key":"filters[hazard_id]","value":"","disabled":true},{"key":"filters[time_unknown]","value":"","disabled":true},{"key":"filters[recordable]","value":"","disabled":true},{"key":"filters[with_record_types]","value":"","disabled":true},{"key":"filters[has_root_cause_analysis]","value":"","disabled":true},{"key":"filters[custom_status_id]","value":"","disabled":true},{"key":"filters[type_id]","value":"","disabled":true},{"key":"filters[assignee_id]","value":"","disabled":true},{"key":"filters[query]","value":"","disabled":true},{"key":"sort","value":"","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"List Incidents"}},{"id":"6e483418-d067-4371-8f51-688e1afdc800","name":"createProjectIncident — Create Incident","request":{"method":"POST","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/incidents","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","incidents"],"query":[{"key":"run_configurable_validations","value":"","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Create Incident","body":{"mode":"raw","raw":"{\n  \"incident\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"098a9a70-2ae3-4b3a-8c1b-e824fbf266d6","name":"listProjectIncidentsActions — List Actions","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/incidents/actions","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","incidents","actions"],"query":[{"key":"incident_id","value":"","disabled":true},{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true},{"key":"filters[created_at]","value":"","disabled":true},{"key":"filters[updated_at]","value":"","disabled":true},{"key":"filters[query]","value":"","disabled":true},{"key":"sort","value":"","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"List Actions"}},{"id":"a0f44f42-e690-46ff-8cc7-dcb8248e844c","name":"createProjectIncidentsAction — Create Action","request":{"method":"POST","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/incidents/actions","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","incidents","actions"],"query":[{"key":"run_configurable_validations","value":"","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Create Action","body":{"mode":"raw","raw":"{\n  \"incident_action\": {\n    \"action_type_id\": 0,\n    \"incident_id\": 0\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"20487af8-bdd3-4254-8f30-99cd60b3f368","name":"getProjectIncidentsAction — Show Action","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/incidents/actions/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","incidents","actions",":id"],"query":[{"key":"incident_id","value":"","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Show Action"}},{"id":"32a89d97-dc57-4bf4-857d-e21399b7eddd","name":"updateProjectIncidentsAction — Update Action","request":{"method":"PATCH","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/incidents/actions/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","incidents","actions",":id"],"query":[{"key":"incident_id","value":"","disabled":true},{"key":"run_configurable_validations","value":"","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Update Action","body":{"mode":"raw","raw":"{\n  \"incident_action\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"f7f4bff3-19c8-42a4-86bc-367bfa606167","name":"deleteProjectIncidentsAction — Destroy Action","request":{"method":"DELETE","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/incidents/actions/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","incidents","actions",":id"],"query":[{"key":"incident_id","value":"","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Destroy Action\n\nSoft-delete the corrective action. Needs incidents delete permission and visibility of the parent incident."}},{"id":"94d11e51-2f0c-463d-80f6-becca3f0463c","name":"listProjectIncidentsFilterOptionsAssignees — Get Assignee Filter Options","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/incidents/filter_options/assignees","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","incidents","filter_options","assignees"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Get Assignee Filter Options"}},{"id":"5035f10f-5c7a-4336-81c4-218dfd41dbcf","name":"listProjectIncidentsFilterOptionsLocations — Get Location Filter Options","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/incidents/filter_options/locations","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","incidents","filter_options","locations"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Get Location Filter Options"}},{"id":"4a440770-d041-4b2b-880b-48af5d3bb6de","name":"listProjectIncidentsFilterOptionsStatuses — Get Status Filter Options","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/incidents/filter_options/statuses","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","incidents","filter_options","statuses"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Get Status Filter Options"}},{"id":"b09ec39b-d08d-4b95-8e1d-e80053cac98d","name":"listProjectIncidentsInjuries — List Injuries","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/incidents/injuries","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","incidents","injuries"],"query":[{"key":"incident_id","value":"","disabled":true},{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true},{"key":"filters[created_at]","value":"","disabled":true},{"key":"filters[affected_company_id]","value":"","disabled":true},{"key":"filters[affected_party_id]","value":"","disabled":true},{"key":"filters[affected_person_id]","value":"","disabled":true},{"key":"filters[harm_source_id]","value":"","disabled":true},{"key":"filters[work_activity_id]","value":"","disabled":true},{"key":"filters[managed_equipment_id]","value":"","disabled":true},{"key":"filters[recordable]","value":"","disabled":true},{"key":"filters[affected_body_part]","value":"","disabled":true},{"key":"filters[affliction_type_id]","value":"","disabled":true},{"key":"filters[body_part_id]","value":"","disabled":true},{"key":"filters[filing_type]","value":"","disabled":true},{"key":"filters[query]","value":"","disabled":true},{"key":"sort","value":"","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"List Injuries"}},{"id":"2649dda2-ed7e-44a4-82c3-f210dbdd5dc8","name":"createProjectIncidentsInjury — Create Injury","request":{"method":"POST","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/incidents/injuries","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","incidents","injuries"],"query":[{"key":"run_configurable_validations","value":"","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Create Injury","body":{"mode":"raw","raw":"{\n  \"injury\": {\n    \"incident_id\": 0\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"f074045c-4a18-452c-8cc8-ab0bff17e8e0","name":"getProjectIncidentsInjury — Show Injury","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/incidents/injuries/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","incidents","injuries",":id"],"query":[{"key":"incident_id","value":"","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Show Injury"}},{"id":"49ed45aa-66b5-45cc-8d8a-7d6f6543de30","name":"updateProjectIncidentsInjury — Update Injury","request":{"method":"PATCH","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/incidents/injuries/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","incidents","injuries",":id"],"query":[{"key":"incident_id","value":"","disabled":true},{"key":"run_configurable_validations","value":"","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Update Injury","body":{"mode":"raw","raw":"{\n  \"injury\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"6cd76785-a594-43bc-8254-7918c148cce3","name":"deleteProjectIncidentsInjury — Destroy Injury","request":{"method":"DELETE","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/incidents/injuries/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","incidents","injuries",":id"],"query":[{"key":"incident_id","value":"","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Destroy Injury\n\nSoft-delete the injury/illness record (incident creator or an admin only). Needs incidents delete permission and visibility of the parent incident."}},{"id":"db3057d0-338e-49ca-8108-01fc3e7505b1","name":"listProjectIncidentsOsha300Log — Get OSHA 300 log","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/incidents/osha_300_log","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","incidents","osha_300_log"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Get OSHA 300 log\n\nRequires the `view` permission on the project's incidents tool. A scoped API token needs `incidents:read`."}},{"id":"f44c1bfc-c10c-4d42-8e73-70f796543beb","name":"listProjectIncidentsWitnessStatements — List Witness Statements","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/incidents/witness_statements","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","incidents","witness_statements"],"query":[{"key":"incident_id","value":"","disabled":true},{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true},{"key":"filters[created_at]","value":"","disabled":true},{"key":"filters[date_received]","value":"","disabled":true},{"key":"filters[witness_id]","value":"","disabled":true},{"key":"filters[query]","value":"","disabled":true},{"key":"sort","value":"","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"List Witness Statements"}},{"id":"8af0a37c-8dbc-402f-8e91-128beb8fb595","name":"createProjectIncidentsWitnessStatement — Create Witness Statement","request":{"method":"POST","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/incidents/witness_statements","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","incidents","witness_statements"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Create Witness Statement","body":{"mode":"raw","raw":"{\n  \"witness_statement\": {\n    \"incident_id\": 0,\n    \"witness_id\": 0\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"e3949bb7-02df-4dcd-8bc6-18efc985bbe9","name":"getProjectIncidentsWitnessStatement — Show Witness Statement","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/incidents/witness_statements/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","incidents","witness_statements",":id"],"query":[{"key":"incident_id","value":"","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Show Witness Statement"}},{"id":"3ec4139e-d4c1-4947-816a-62466e741679","name":"updateProjectIncidentsWitnessStatement — Update Witness Statement","request":{"method":"PATCH","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/incidents/witness_statements/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","incidents","witness_statements",":id"],"query":[{"key":"incident_id","value":"","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Update Witness Statement\n\nUpdate a witness statement: any of statement, date_received, witness_id, witness_name. Attachments and custom fields are not supported on witness statements.","body":{"mode":"raw","raw":"{\n  \"witness_statement\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"668d6e61-f8df-49ae-81ad-3a88d127ed44","name":"deleteProjectIncidentsWitnessStatement — Destroy Witness Statement","request":{"method":"DELETE","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/incidents/witness_statements/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","incidents","witness_statements",":id"],"query":[{"key":"incident_id","value":"","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Destroy Witness Statement\n\nSoft-delete the witness statement. Needs incidents delete permission and visibility of the parent incident."}},{"id":"8ad380fe-20c2-4f8a-8b50-90d6e4a619da","name":"getProjectIncident — Show Incident","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/incidents/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","incidents",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Show Incident"}},{"id":"60b78607-2bf2-4dd0-8c15-be44624aca5c","name":"updateProjectIncident — Update Incident","request":{"method":"PATCH","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/incidents/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","incidents",":id"],"query":[{"key":"run_configurable_validations","value":"","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Update Incident","body":{"mode":"raw","raw":"{\n  \"incident\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"046d6336-e93c-4635-8a83-1b085603a724","name":"deleteProjectIncident — Delete Incident","request":{"method":"DELETE","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/incidents/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","incidents",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Delete Incident"}}]},{"name":"Inspections","description":"Module: inspections","item":[{"id":"82c2cd5a-fa2d-44fd-8814-2c4f0ad3dbee","name":"listProjectChecklistItemItemResponse — Show Checklist Item Response","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/checklist/items/:item_id/item_response","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","checklist","items",":item_id","item_response"],"variable":[{"key":"item_id","value":""},{"key":"project_id","value":"{{projectId}}"}]},"description":"Show Checklist Item Response"}},{"id":"f000d79a-0a7b-4a0a-88de-e603d5b69af2","name":"itemResponseProjectChecklistItem — Create Checklist Item Response","request":{"method":"POST","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/checklist/items/:item_id/item_response","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","checklist","items",":item_id","item_response"],"variable":[{"key":"item_id","value":""},{"key":"project_id","value":"{{projectId}}"}]},"description":"Create Checklist Item Response","body":{"mode":"raw","raw":"{\n  \"item_response\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"444572d8-9b76-46cb-8616-5af4d54fe9c3","name":"deleteItemResponseProjectChecklistItem — Delete Checklist Item Response","request":{"method":"DELETE","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/checklist/items/:item_id/item_response","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","checklist","items",":item_id","item_response"],"variable":[{"key":"item_id","value":""},{"key":"project_id","value":"{{projectId}}"}]},"description":"Delete Checklist Item Response"}},{"id":"e4baf0aa-e950-4e33-8bb5-bab72a1bc8a5","name":"observationProjectChecklistItem — Create Observation From Item","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/checklist/items/:item_id/observation","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","checklist","items",":item_id","observation"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"item_id","value":""}]},"description":"Create Observation From Item"}},{"id":"8859f3d9-6162-449a-87d4-6e5124b257e0","name":"listProjectChecklistListItems — List Checklist (Inspections) Items","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/checklist/list_items","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","checklist","list_items"],"query":[{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true},{"key":"filters[id]","value":"","disabled":true},{"key":"filters[updated_at]","value":"","disabled":true},{"key":"filters[section_id]","value":"","disabled":true},{"key":"filters[list_id]","value":"","disabled":true},{"key":"filters[item_response_status]","value":"","disabled":true},{"key":"sort","value":"","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"List Checklist (Inspections) Items"}},{"id":"dd0b9d3d-975b-4f61-81ee-56196b5e6822","name":"listProjectChecklistListTemplates — List Project Checklist Templates","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/checklist/list_templates","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","checklist","list_templates"],"query":[{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true},{"key":"filters[inspection_type_id]","value":"","disabled":true},{"key":"filters[response_set_id]","value":"","disabled":true},{"key":"filters[trade_ids]","value":"","disabled":true},{"key":"filters[query]","value":"","disabled":true},{"key":"sort","value":"","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"List Project Checklist Templates"}},{"id":"da8bf20f-990e-45c9-871d-c19c85daed31","name":"createProjectChecklistListTemplate — Create Project Checklist Template","request":{"method":"POST","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/checklist/list_templates","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","checklist","list_templates"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Create Project Checklist Template","body":{"mode":"raw","raw":"{\n  \"attachments\": [\n    \"\"\n  ],\n  \"list_template\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"04c05e71-424b-42bd-8a08-f7d361d37104","name":"getProjectChecklistListTemplate — Show Project Checklist Template","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/checklist/list_templates/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","checklist","list_templates",":id"],"variable":[{"key":"id","value":""},{"key":"project_id","value":"{{projectId}}"}]},"description":"Show Project Checklist Template"}},{"id":"fc1128ab-779d-4458-820c-1529988abf1c","name":"updateProjectChecklistListTemplate — Update Project Checklist Template","request":{"method":"PATCH","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/checklist/list_templates/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","checklist","list_templates",":id"],"variable":[{"key":"id","value":""},{"key":"project_id","value":"{{projectId}}"}]},"description":"Update Project Checklist Template","body":{"mode":"raw","raw":"{\n  \"attachments\": [\n    \"\"\n  ],\n  \"list_template\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"f2affa40-b296-4707-8c8f-3a0ab8a9bbd0","name":"deleteProjectChecklistListTemplate — Delete Project Checklist Template","request":{"method":"DELETE","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/checklist/list_templates/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","checklist","list_templates",":id"],"variable":[{"key":"id","value":""},{"key":"project_id","value":"{{projectId}}"}]},"description":"Delete Project Checklist Template"}},{"id":"778feade-1b0a-4ef3-87de-f6d970242b50","name":"listProjectChecklistLists — List Checklists (Inspections)","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/checklist/lists","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","checklist","lists"],"query":[{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true},{"key":"filters[id]","value":"","disabled":true},{"key":"filters[inspection_date]","value":"","disabled":true},{"key":"filters[inspection_type_id]","value":"","disabled":true},{"key":"filters[inspector_id]","value":"","disabled":true},{"key":"filters[template_id]","value":"","disabled":true},{"key":"filters[location_id]","value":"","disabled":true},{"key":"filters[managed_equipment_id]","value":"","disabled":true},{"key":"filters[point_of_contact_id]","value":"","disabled":true},{"key":"filters[spec_section_id]","value":"","disabled":true},{"key":"filters[responsible_contractor_id]","value":"","disabled":true},{"key":"filters[closed_by_id]","value":"","disabled":true},{"key":"filters[created_by_id]","value":"","disabled":true},{"key":"filters[status]","value":"","disabled":true},{"key":"filters[trade_id]","value":"","disabled":true},{"key":"filters[query]","value":"","disabled":true},{"key":"filters[due_at]","value":"","disabled":true},{"key":"filters[created_at]","value":"","disabled":true},{"key":"filters[updated_at]","value":"","disabled":true},{"key":"filters[closed_at]","value":"","disabled":true},{"key":"sort","value":"","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"List Checklists (Inspections)"}},{"id":"d2f8d2bd-64b5-45d6-872b-7a7f1a646ee2","name":"createProjectChecklistList — Create Checklist (Inspection)","request":{"method":"POST","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/checklist/lists","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","checklist","lists"],"query":[{"key":"run_configurable_validations","value":"","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Create Checklist (Inspection)","body":{"mode":"raw","raw":"{\n  \"list\": {},\n  \"list_template_id\": 0\n}","options":{"raw":{"language":"json"}}}}},{"id":"b280cba7-d972-4c48-800f-bee958e8b313","name":"getProjectChecklistList — Show Checklist (Inspection)","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/checklist/lists/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","checklist","lists",":id"],"variable":[{"key":"id","value":""},{"key":"project_id","value":"{{projectId}}"}]},"description":"Show Checklist (Inspection)"}},{"id":"41fe6f6a-548b-46b9-87e1-c9a7e9ced677","name":"updateProjectChecklistList — Update Checklist (Inspection)","request":{"method":"PATCH","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/checklist/lists/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","checklist","lists",":id"],"query":[{"key":"run_configurable_validations","value":"","disabled":true}],"variable":[{"key":"id","value":""},{"key":"project_id","value":"{{projectId}}"}]},"description":"Update Checklist (Inspection)","body":{"mode":"raw","raw":"{\n  \"list\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"3cff9f42-6d0b-4491-8432-87542e425507","name":"deleteProjectChecklistList — Delete Checklist (Inspection)","request":{"method":"DELETE","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/checklist/lists/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","checklist","lists",":id"],"variable":[{"key":"id","value":""},{"key":"project_id","value":"{{projectId}}"}]},"description":"Delete Checklist (Inspection)"}},{"id":"a119186f-a394-4e43-8374-88864f7ce63a","name":"completeProjectChecklistList — Complete Inspection","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/checklist/lists/:id/complete","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","checklist","lists",":id","complete"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Complete Inspection"}},{"id":"9d8524db-a2ca-4d9e-824a-c8f14482d98a","name":"generateNextProjectChecklistList — Generate Next Occurrence","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/checklist/lists/:id/generate_next","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","checklist","lists",":id","generate_next"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Generate Next Occurrence"}},{"id":"9ca89812-840e-4eb0-8cbc-7899b4dec656","name":"sendEmailProjectChecklistList — Email checklist list","request":{"method":"POST","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/checklist/lists/:id/send_email","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","checklist","lists",":id","send_email"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Email checklist list"}},{"id":"79499957-476b-42f9-81d3-716895b6a80a","name":"listProjectChecklistListSignatures — List Checklist Signatures","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/checklist/lists/:id/signatures","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","checklist","lists",":id","signatures"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"List Checklist Signatures"}},{"id":"5352f53a-ed01-4bf2-8764-aee2c1e6cdd8","name":"createProjectChecklistListSignature — Create Checklist Signature","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/checklist/lists/:id/signatures","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","checklist","lists",":id","signatures"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Create Checklist Signature"}},{"id":"ed24926b-9b8e-4e51-822b-232175f03590","name":"deleteProjectChecklistListSignature — Delete checklist list signature","request":{"method":"DELETE","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/checklist/lists/:id/signatures/:signature_id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","checklist","lists",":id","signatures",":signature_id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""},{"key":"signature_id","value":""}]},"description":"Delete checklist list signature"}}]},{"name":"Locations","description":"Module: locations","item":[{"id":"7f15fa7d-bcfe-48e4-8885-f6829110a925","name":"listProjectLocations — List Project Locations","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/locations","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","locations"],"query":[{"key":"filters[id]","value":"","disabled":true},{"key":"filters[parent_id]","value":"","disabled":true},{"key":"filters[code]","value":"","disabled":true},{"key":"filters[search]","value":"","disabled":true},{"key":"filters[search_with_code]","value":"","disabled":true},{"key":"filters[superlocations_for]","value":"","disabled":true},{"key":"filters[sublocations_for]","value":"","disabled":true},{"key":"filters[updated_at]","value":"","disabled":true},{"key":"sort","value":"","disabled":true},{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true},{"key":"filters[depth_range]","value":"","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"List Project Locations"}},{"id":"d5e683ff-2413-4484-8983-a9a419404b3d","name":"createProjectLocation — Create Location (Admin)","request":{"method":"POST","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/locations","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","locations"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Create Location (Admin)","body":{"mode":"raw","raw":"{\n  \"location\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"8d457c22-27eb-41ba-8726-9d1d81db6b46","name":"getProjectLocation — Show Project Location","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/locations/:location_id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","locations",":location_id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"location_id","value":""}]},"description":"Show Project Location"}},{"id":"f8fc764f-10af-4914-8577-bb3eb091931a","name":"updateProjectLocation — Update Project Location","request":{"method":"PATCH","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/locations/:location_id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","locations",":location_id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"location_id","value":""}]},"description":"Update Project Location","body":{"mode":"raw","raw":"{\n  \"location\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"413b24d3-6984-4dca-814e-cc39d9d8207d","name":"deleteProjectLocation — Delete Project Location","request":{"method":"DELETE","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/locations/:location_id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","locations",":location_id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"location_id","value":""}]},"description":"Delete Project Location"}}]},{"name":"Materials","description":"Module: materials","item":[{"id":"be161116-5109-4519-8377-df7f067f15b7","name":"listProjectMaterials — List Materials","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/materials","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","materials"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"List Materials"}},{"id":"1e5711ce-bf94-4529-8af8-1cd3687dd8a3","name":"createProjectMaterial — Create Material","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/materials","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","materials"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Create Material"}},{"id":"f7226b04-45c5-49fd-8b4d-22d49e2b06ef","name":"listProjectMaterialsDeliveries — List Deliveries","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/materials/deliveries","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","materials","deliveries"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"List Deliveries"}},{"id":"1a94ac63-f517-4ade-8ee2-b13b6d65d293","name":"createProjectMaterialsDelivery — Create Delivery","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/materials/deliveries","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","materials","deliveries"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Create Delivery"}},{"id":"976451be-d5a9-4f8a-84bf-a8fcbd330af4","name":"listProjectMaterialsDeliveriesRecycleBin — List Recycled Deliveries","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/materials/deliveries/recycle_bin","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","materials","deliveries","recycle_bin"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"List Recycled Deliveries"}},{"id":"28007c19-c12e-4a32-8bcd-02ed87bb5b27","name":"getProjectMaterialsDelivery — Show Delivery","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/materials/deliveries/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","materials","deliveries",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Show Delivery"}},{"id":"2dc26f27-6195-4334-865a-69504ff0473c","name":"updateProjectMaterialsDelivery — Update Delivery","request":{"method":"PATCH","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/materials/deliveries/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","materials","deliveries",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Update Delivery"}},{"id":"5d550258-8af5-42df-873c-103527998607","name":"deleteProjectMaterialsDelivery — Delete delivery","request":{"method":"DELETE","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/materials/deliveries/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","materials","deliveries",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Delete delivery\n\nRecycle (reverses any stock a received delivery added)."}},{"id":"1d3a9aad-d3a9-40b7-8632-4c7a40322f12","name":"listProjectMaterialsDeliveryAttachments — List Delivery Attachments","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/materials/deliveries/:id/attachments","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","materials","deliveries",":id","attachments"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"List Delivery Attachments"}},{"id":"c57c867d-233d-474d-8ff9-0c7b27f78ffe","name":"createProjectMaterialsDeliveryAttachment — Add Delivery Attachments","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/materials/deliveries/:id/attachments","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","materials","deliveries",":id","attachments"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Add Delivery Attachments"}},{"id":"f24f4c7d-4e9f-46c9-8a88-b6b1075807a7","name":"deleteProjectMaterialsDeliveryAttachment — Remove Delivery Attachment","request":{"method":"DELETE","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/materials/deliveries/:id/attachments/:attachment_id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","materials","deliveries",":id","attachments",":attachment_id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""},{"key":"attachment_id","value":""}]},"description":"Remove Delivery Attachment"}},{"id":"413ab9e9-c04e-48ac-865c-291ba48e0e64","name":"listProjectMaterialsDeliveryReceiptReviews — Read source evidence and the latest 100 reviews (materials:read and commitments:read)","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/materials/deliveries/:id/receipt_reviews","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","materials","deliveries",":id","receipt_reviews"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Read source evidence and the latest 100 reviews (materials:read and commitments:read)"}},{"id":"5b93ad0e-0b4d-408e-8cf2-c9c765b95fc1","name":"createProjectMaterialsDeliveryReceiptReview — Submit immutable field quantities for independent review","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/materials/deliveries/:id/receipt_reviews","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","materials","deliveries",":id","receipt_reviews"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Submit immutable field quantities for independent review\n\nRequires materials:write, commitments:read and materials edit plus PO line visibility. Each delivery item is classified once. A returned review can be corrected only with a fresh snapshot and submission key.","body":{"mode":"raw","raw":"{\n  \"lines\": [\n    {\n      \"accepted_quantity\": \"\",\n      \"delivery_item_id\": 0,\n      \"po_line_id\": 0\n    }\n  ],\n  \"source_digest\": \"\",\n  \"submission_key\": \"\"\n}","options":{"raw":{"language":"json"}}}}},{"id":"7026661b-2465-447a-8149-ea9db519d9d3","name":"decisionProjectMaterialsDeliveryReceiptReview — Independently accept into AP or return the field review","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/materials/deliveries/:id/receipt_reviews/:review_id/decision","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","materials","deliveries",":id","receipt_reviews",":review_id","decision"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""},{"key":"review_id","value":""}]},"description":"Independently accept into AP or return the field review\n\nRequires accounting:write, materials:read, commitments:read, materials view, PO line visibility, apEnter and project entity authority. Submitter cannot decide. Accept records one AP receipt and freezes source mutations atomically. An already accepted review replays its original receipt, including after a later accounting void; it never creates a replacement.","body":{"mode":"raw","raw":"{\n  \"action\": \"accept\",\n  \"expected_version\": 0,\n  \"reason\": \"\"\n}","options":{"raw":{"language":"json"}}}}},{"id":"74a07305-080d-4517-896c-ef7ce6df32a7","name":"restoreProjectMaterialsDelivery — Restore Delivery","request":{"method":"PATCH","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/materials/deliveries/:id/restore","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","materials","deliveries",":id","restore"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Restore Delivery"}},{"id":"b68eb442-486d-4efc-8477-138223547982","name":"listProjectMaterialsFilterOptionsCategory — Material category filter options","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/materials/filter_options/category","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","materials","filter_options","category"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Material category filter options"}},{"id":"f2508ba9-6e22-4d0a-802d-93b39abc56c9","name":"listProjectMaterialsReceiptReviews — Pending independent receipt decisions","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/materials/receipt_reviews","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","materials","receipt_reviews"],"query":[{"key":"after","value":"","disabled":true},{"key":"limit","value":"","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Pending independent receipt decisions\n\nRead only. Requires Materials view, commitment SOV read and accounting apEnter. Token scopes: materials:read commitments:read accounting:write. Visibility precedes LIMIT; no total. Source changed rows remain available for return."}},{"id":"91df4b84-24da-42e2-88d7-022ef08f6a84","name":"listProjectMaterialsRecycleBin — List Recycled Materials","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/materials/recycle_bin","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","materials","recycle_bin"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"List Recycled Materials"}},{"id":"7792935c-1691-4707-8067-e1d82f661a84","name":"getProjectMaterial — Show Material","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/materials/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","materials",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Show Material"}},{"id":"dcadd91c-1890-44a1-886f-64c2cb657152","name":"updateProjectMaterial — Update Material","request":{"method":"PATCH","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/materials/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","materials",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Update Material"}},{"id":"b2c32715-e65b-45c9-8097-3babd0ee7d13","name":"deleteProjectMaterial — Delete material","request":{"method":"DELETE","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/materials/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","materials",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Delete material"}},{"id":"6395510e-2b98-4e86-8073-16de353e3862","name":"adjustProjectMaterial — Adjust material quantity","request":{"method":"PATCH","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/materials/:id/adjust","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","materials",":id","adjust"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Adjust material quantity"}},{"id":"2f1e4443-eb86-48dd-885c-cb52fc24d822","name":"restoreProjectMaterial — Restore Material","request":{"method":"PATCH","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/materials/:id/restore","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","materials",":id","restore"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Restore Material"}}]},{"name":"Meetings","description":"Module: meetings","item":[{"id":"2ea512cc-864a-40ce-8744-cbf3c42edd09","name":"createMeetingAttendeeRecord — Create meeting attendee record","request":{"method":"POST","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/meeting_attendee_records","host":["{{baseUrl}}"],"path":["rest","v1.0","meeting_attendee_records"],"query":[{"key":"project_id","value":"","disabled":false},{"key":"meeting_id","value":"","disabled":false}]},"description":"Create meeting attendee record","body":{"mode":"raw","raw":"{\n  \"meeting_attendee_record\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"238ef533-846a-4e44-8be7-f711e4f7c802","name":"updateMeetingAttendeeRecord — Update meeting attendee record","request":{"method":"PATCH","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/meeting_attendee_records/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","meeting_attendee_records",":id"],"query":[{"key":"meeting_id","value":"","disabled":false},{"key":"project_id","value":"","disabled":false}],"variable":[{"key":"id","value":""}]},"description":"Update meeting attendee record","body":{"mode":"raw","raw":"{\n  \"meeting_attendee_record\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"a7a9fb5b-87e2-4047-8d0d-fe03bc722cd3","name":"deleteMeetingAttendeeRecord — Delete meeting attendee record","request":{"method":"DELETE","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/meeting_attendee_records/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","meeting_attendee_records",":id"],"query":[{"key":"meeting_id","value":"","disabled":false},{"key":"project_id","value":"","disabled":false}],"variable":[{"key":"id","value":""}]},"description":"Delete meeting attendee record"}},{"id":"8d1b8f5a-2a77-4996-84b3-3b726bb5c830","name":"listMeetingCategories — List meeting categories","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/meeting_categories","host":["{{baseUrl}}"],"path":["rest","v1.0","meeting_categories"],"query":[{"key":"project_id","value":"","disabled":false},{"key":"meeting_id","value":"","disabled":false},{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true}]},"description":"List meeting categories"}},{"id":"09f8d3ed-c0b1-4173-8e86-355ec44f838c","name":"createMeetingCategory — Create meeting category","request":{"method":"POST","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/meeting_categories","host":["{{baseUrl}}"],"path":["rest","v1.0","meeting_categories"]},"description":"Create meeting category","body":{"mode":"raw","raw":"{\n  \"meeting_category\": {},\n  \"meeting_id\": 0,\n  \"project_id\": 0\n}","options":{"raw":{"language":"json"}}}}},{"id":"730191f8-ead0-4c72-8579-c9670cc5dd1e","name":"updateMeetingCategory — Update meeting category","request":{"method":"PATCH","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/meeting_categories/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","meeting_categories",":id"],"variable":[{"key":"id","value":""}]},"description":"Update meeting category","body":{"mode":"raw","raw":"{\n  \"meeting_category\": {},\n  \"meeting_id\": 0,\n  \"project_id\": 0\n}","options":{"raw":{"language":"json"}}}}},{"id":"85c95b33-bdba-4a3f-8f2c-5ec98938a251","name":"createMeetingTopic — Create meeting topic","request":{"method":"POST","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/meeting_topics","host":["{{baseUrl}}"],"path":["rest","v1.0","meeting_topics"]},"description":"Create meeting topic\n\nCreate a meeting topic. Same as POST /rest/v1.1/projects/{project_id}/meeting_topics with project_id in the body.","body":{"mode":"raw","raw":"{\n  \"attachments\": [\n    \"\"\n  ],\n  \"meeting_id\": 0,\n  \"meeting_topic\": {},\n  \"project_id\": 0\n}","options":{"raw":{"language":"json"}}}}},{"id":"3afc4b01-7150-4f50-8759-12e9b1395c2a","name":"listMeetingTopicsParentMinutes — Get the minutes and date created for all parent topics","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/meeting_topics/parent_minutes","host":["{{baseUrl}}"],"path":["rest","v1.0","meeting_topics","parent_minutes"],"query":[{"key":"meeting_id","value":"","disabled":false},{"key":"meeting_topic_id","value":"","disabled":false}]},"description":"Get the minutes and date created for all parent topics\n\nMinutes recorded on the same topic in earlier meetings of the series, newest ancestor first. The project comes from the meeting."}},{"id":"cbb41bdf-fd0c-4f28-8bf6-d68f5d2abfe4","name":"updateMeetingTopic — Update meeting topic","request":{"method":"PATCH","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/meeting_topics/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","meeting_topics",":id"],"variable":[{"key":"id","value":""}]},"description":"Update meeting topic\n\nUpdate a meeting topic. Same as PATCH /rest/v1.1/projects/{project_id}/meeting_topics/{id} with project_id in the body.","body":{"mode":"raw","raw":"{\n  \"attachments\": [\n    \"\"\n  ],\n  \"meeting_id\": 0,\n  \"meeting_topic\": {},\n  \"project_id\": 0\n}","options":{"raw":{"language":"json"}}}}},{"id":"806fea6d-5dd9-4f72-8451-d110d8a51436","name":"listMeetings — List meetings","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/meetings","host":["{{baseUrl}}"],"path":["rest","v1.0","meetings"],"query":[{"key":"project_id","value":"","disabled":false},{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true},{"key":"deleted_only","value":"","disabled":true},{"key":"serializer_view","value":"","disabled":true}]},"description":"List meetings\n\nMeetings of the project in project_id, grouped by series (same response as GET /rest/v1.1/projects/{project_id}/meetings). Private meetings are visible to admins, their creator and attendees. deleted_only=true lists the recycle bin."}},{"id":"545bbd20-50b5-4829-8bd6-d524e223c8bc","name":"createMeeting — Create meeting","request":{"method":"POST","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/meetings","host":["{{baseUrl}}"],"path":["rest","v1.0","meetings"]},"description":"Create meeting\n\nCreate a meeting in project_id. Same body and behaviour as POST /rest/v1.1/projects/{project_id}/meetings.","body":{"mode":"raw","raw":"{\n  \"meeting\": {\n    \"ends_at\": \"\",\n    \"position\": 0,\n    \"starts_at\": \"\"\n  },\n  \"project_id\": 0\n}","options":{"raw":{"language":"json"}}}}},{"id":"18e28bde-9177-4af0-8ed4-ecc1a00ced1e","name":"getMeeting — Show meeting","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/meetings/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","meetings",":id"],"query":[{"key":"project_id","value":"","disabled":false}],"variable":[{"key":"id","value":""}]},"description":"Show meeting"}},{"id":"eb4d7bae-1b45-4a20-8444-248e67821fcf","name":"updateMeeting — Update meeting","request":{"method":"PATCH","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/meetings/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","meetings",":id"],"variable":[{"key":"id","value":""}]},"description":"Update meeting\n\nUpdate a meeting. Same body as PATCH /rest/v1.1/projects/{project_id}/meetings/{id}, plus project_id.","body":{"mode":"raw","raw":"{\n  \"meeting\": {\n    \"ends_at\": \"\",\n    \"position\": 0,\n    \"starts_at\": \"\"\n  },\n  \"project_id\": 0\n}","options":{"raw":{"language":"json"}}}}},{"id":"8d83bedd-1db1-4962-8feb-cd9cad2d7067","name":"deleteMeeting — Delete meeting","request":{"method":"DELETE","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/meetings/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","meetings",":id"],"query":[{"key":"project_id","value":"","disabled":false}],"variable":[{"key":"id","value":""}]},"description":"Delete meeting\n\nSend the meeting to the recycle bin (meetings delete permission)."}},{"id":"942a225b-bbdb-4b1c-88fd-fc5a351ff6fc","name":"createProjectMeetingTopicV11 — Create meeting topic","request":{"method":"POST","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.1/projects/:project_id/meeting_topics","host":["{{baseUrl}}"],"path":["rest","v1.1","projects",":project_id","meeting_topics"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Create meeting topic","body":{"mode":"raw","raw":"{\n  \"attachments\": [\n    \"\"\n  ],\n  \"meeting_id\": 0,\n  \"meeting_topic\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"7da507ed-430e-4460-8f70-7bbf5d9e79a1","name":"updateProjectMeetingTopicV11 — Update meeting topic","request":{"method":"PATCH","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.1/projects/:project_id/meeting_topics/:id","host":["{{baseUrl}}"],"path":["rest","v1.1","projects",":project_id","meeting_topics",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Update meeting topic","body":{"mode":"raw","raw":"{\n  \"attachments\": [\n    \"\"\n  ],\n  \"meeting_id\": 0,\n  \"meeting_topic\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"c95ab953-64dd-46f6-8c65-98e290793cc4","name":"listProjectMeetingTopicParentMinutesV11 — Get the minutes and date created for all parent topics","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.1/projects/:project_id/meeting_topics/:meeting_topic_id/parent_minutes","host":["{{baseUrl}}"],"path":["rest","v1.1","projects",":project_id","meeting_topics",":meeting_topic_id","parent_minutes"],"query":[{"key":"meeting_id","value":"","disabled":false}],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"meeting_topic_id","value":""}]},"description":"Get the minutes and date created for all parent topics"}},{"id":"d7660ca1-f7e7-4b5e-8ca6-1ba2101a816a","name":"listProjectMeetingsV11 — List meetings","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.1/projects/:project_id/meetings","host":["{{baseUrl}}"],"path":["rest","v1.1","projects",":project_id","meetings"],"query":[{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true},{"key":"deleted_only","value":"","disabled":true},{"key":"filters[assignee_id]","value":"","disabled":true},{"key":"filters[id]","value":"","disabled":true},{"key":"filters[query]","value":"","disabled":true},{"key":"filters[search]","value":"","disabled":true},{"key":"serializer_view","value":"","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"List meetings"}},{"id":"49c45961-9b40-4b12-882f-0c3cf2a8a0be","name":"createProjectMeetingV11 — Create meeting","request":{"method":"POST","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.1/projects/:project_id/meetings","host":["{{baseUrl}}"],"path":["rest","v1.1","projects",":project_id","meetings"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Create meeting","body":{"mode":"raw","raw":"{\n  \"attachments\": [\n    \"\"\n  ],\n  \"meeting\": {\n    \"ends_at\": \"\",\n    \"position\": 0,\n    \"starts_at\": \"\"\n  },\n  \"project_id\": 0\n}","options":{"raw":{"language":"json"}}}}},{"id":"8101df19-980f-4e6f-84ab-436f6ac01458","name":"listProjectMeetingsReferencingV11 — List meetings that reference a record","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.1/projects/:project_id/meetings/referencing","host":["{{baseUrl}}"],"path":["rest","v1.1","projects",":project_id","meetings","referencing"],"query":[{"key":"tool","value":"","disabled":false},{"key":"id","value":"","disabled":false}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"List meetings that reference a record\n\nRequires the `view` permission on the project's meetings tool. A scoped API token needs `meetings:read`."}},{"id":"8f8f7019-69a8-425c-8afc-ad7281392aa4","name":"getProjectMeetingV11 — Show meeting","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.1/projects/:project_id/meetings/:id","host":["{{baseUrl}}"],"path":["rest","v1.1","projects",":project_id","meetings",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Show meeting"}},{"id":"960bf6ce-341e-4cab-8def-54afd50015b9","name":"updateProjectMeetingV11 — Update meeting","request":{"method":"PATCH","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.1/projects/:project_id/meetings/:id","host":["{{baseUrl}}"],"path":["rest","v1.1","projects",":project_id","meetings",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Update meeting","body":{"mode":"raw","raw":"{\n  \"attachments\": [\n    \"\"\n  ],\n  \"meeting\": {},\n  \"project_id\": 0\n}","options":{"raw":{"language":"json"}}}}},{"id":"ad496776-ddf3-497d-87d2-a9b431a591bd","name":"deleteProjectMeetingV11 — Delete meeting","request":{"method":"DELETE","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.1/projects/:project_id/meetings/:id","host":["{{baseUrl}}"],"path":["rest","v1.1","projects",":project_id","meetings",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Delete meeting"}},{"id":"fb9da841-05c7-43d4-861e-15274683b9df","name":"createProjectMeetingAttachmentV11 — Upload meeting attachment","request":{"method":"POST","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.1/projects/:project_id/meetings/:id/attachments","host":["{{baseUrl}}"],"path":["rest","v1.1","projects",":project_id","meetings",":id","attachments"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Upload meeting attachment"}},{"id":"30df7481-253c-4a32-8efd-0a22cd59ea9e","name":"listProjectMeetingDistributeV11 — List minutes distributions for a meeting","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.1/projects/:project_id/meetings/:id/distribute","host":["{{baseUrl}}"],"path":["rest","v1.1","projects",":project_id","meetings",":id","distribute"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"List minutes distributions for a meeting"}},{"id":"4b989026-dc21-43a1-8e00-b6acebe3e096","name":"distributeProjectMeetingV11 — Distribute a minutes-mode meeting's minutes","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.1/projects/:project_id/meetings/:id/distribute","host":["{{baseUrl}}"],"path":["rest","v1.1","projects",":project_id","meetings",":id","distribute"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Distribute a minutes-mode meeting's minutes","body":{"mode":"raw","raw":"{\n  \"distribution\": {},\n  \"project_id\": 0\n}","options":{"raw":{"language":"json"}}}}},{"id":"84ee2a84-5cc8-45ee-8bee-827a5b730965","name":"followUpProjectMeetingV11 — Create a follow-up meeting carrying forward open topics","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.1/projects/:project_id/meetings/:id/follow_up","host":["{{baseUrl}}"],"path":["rest","v1.1","projects",":project_id","meetings",":id","follow_up"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Create a follow-up meeting carrying forward open topics","body":{"mode":"raw","raw":"{\n  \"follow_up\": {},\n  \"project_id\": 0\n}","options":{"raw":{"language":"json"}}}}},{"id":"9bf9fe3a-cde6-4ed2-8c58-01e52a13ae5a","name":"listProjectMeetingRecurrenceV11 — Get a meeting series' recurrence definition and occurrences","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.1/projects/:project_id/meetings/:id/recurrence","host":["{{baseUrl}}"],"path":["rest","v1.1","projects",":project_id","meetings",":id","recurrence"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Get a meeting series' recurrence definition and occurrences"}},{"id":"e8f87a4b-0b5d-48c6-8b94-956032b62ca2","name":"recurrenceProjectMeetingV11 — Define a recurrence on a meeting series and generate occurrences","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.1/projects/:project_id/meetings/:id/recurrence","host":["{{baseUrl}}"],"path":["rest","v1.1","projects",":project_id","meetings",":id","recurrence"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Define a recurrence on a meeting series and generate occurrences","body":{"mode":"raw","raw":"{\n  \"project_id\": 0,\n  \"recurrence\": {\n    \"cadence\": \"weekly\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"2d9c192a-65d6-476a-829c-bb2c90bd41c6","name":"createProjectMeetingTopicAttachmentV11 — Upload topic attachment","request":{"method":"POST","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.1/projects/:project_id/meetings/:id/topics/:topic_id/attachments","host":["{{baseUrl}}"],"path":["rest","v1.1","projects",":project_id","meetings",":id","topics",":topic_id","attachments"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""},{"key":"topic_id","value":""}]},"description":"Upload topic attachment"}},{"id":"47420ffd-f835-4831-8819-218aa497285c","name":"listCompanyProjectMeetingsV20 — List meetings","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v2.0/companies/:company_id/projects/:project_id/meetings","host":["{{baseUrl}}"],"path":["rest","v2.0","companies",":company_id","projects",":project_id","meetings"],"query":[{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true},{"key":"filters[id]","value":"","disabled":true},{"key":"filters[assignee_id]","value":"","disabled":true},{"key":"filters[title]","value":"","disabled":true},{"key":"filters[public]","value":"","disabled":true},{"key":"filters[draft]","value":"","disabled":true},{"key":"filters[mode]","value":"","disabled":true},{"key":"filter[root_id]","value":"","disabled":true},{"key":"filters[template_id]","value":"","disabled":true},{"key":"filters[from]","value":"","disabled":true},{"key":"filters[to]","value":"","disabled":true},{"key":"filters[roots]","value":"","disabled":true},{"key":"filters[deleted]","value":"","disabled":true},{"key":"view","value":"","disabled":true},{"key":"sort","value":"","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"company_id","value":"{{companyId}}"}]},"description":"List meetings\n\nMeetings of the project as a flat list: { data: [meeting] }. Supported filters: filters[id], filters[assignee_id], filters[mode], filters[deleted]=true (recycle bin). Other listed filters are accepted and ignored."}},{"id":"988a7426-033e-47c0-8468-e142d299fa88","name":"createCompanyProjectMeetingV20 — POST Meeting","request":{"method":"POST","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v2.0/companies/:company_id/projects/:project_id/meetings","host":["{{baseUrl}}"],"path":["rest","v2.0","companies",":company_id","projects",":project_id","meetings"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"project_id","value":"{{projectId}}"}]},"description":"POST Meeting\n\nCreate a meeting. The body is the meeting itself (no wrapper); start_time / finish_time are accepted as aliases of starts_at / ends_at. meeting_template_id, custom fields and minutes approvers are not supported and are ignored.","body":{"mode":"raw","raw":"{\n  \"ends_at\": \"\",\n  \"position\": 0,\n  \"starts_at\": \"\"\n}","options":{"raw":{"language":"json"}}}}},{"id":"ab4b1966-c138-4dcc-8230-897db190109f","name":"getCompanyProjectMeetingV20 — GET Meeting","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v2.0/companies/:company_id/projects/:project_id/meetings/:id","host":["{{baseUrl}}"],"path":["rest","v2.0","companies",":company_id","projects",":project_id","meetings",":id"],"query":[{"key":"view","value":"","disabled":true}],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"GET Meeting"}},{"id":"f8ee6375-d084-4d20-8c23-accd5ae9a246","name":"deleteCompanyProjectMeetingCategoryV20 — Delete meeting category","request":{"method":"DELETE","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v2.0/companies/:company_id/projects/:project_id/meetings/:id/categories/:category_id","host":["{{baseUrl}}"],"path":["rest","v2.0","companies",":company_id","projects",":project_id","meetings",":id","categories",":category_id"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""},{"key":"category_id","value":""}]},"description":"Delete meeting category\n\nDelete a category of the meeting. Its topics stay on the meeting, uncategorized. Needs meetings edit permission."}},{"id":"c1e34fbf-1219-40d1-84e4-62057c0aa402","name":"listCompanyProjectMeetingChangeHistoryV20 — Get Meeting Change History","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v2.0/companies/:company_id/projects/:project_id/meetings/:id/change_history","host":["{{baseUrl}}"],"path":["rest","v2.0","companies",":company_id","projects",":project_id","meetings",":id","change_history"],"query":[{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true},{"key":"sort","value":"","disabled":true}],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Get Meeting Change History\n\nThe meeting's audit trail, newest first (sort=created_at for oldest first), one entry per changed field. Events without a field diff (created, recycled, distributed) have column, old_value and new_value null."}}]},{"name":"Models","description":"Module: models","item":[{"id":"63786955-f427-4472-8541-3ace88393c0d","name":"listProjectBimModels — List BIM models","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/bim_models","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","bim_models"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"List BIM models"}},{"id":"a980c27e-caef-4584-8d65-681465d0721d","name":"createProjectBimModel — Create BIM model","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/bim_models","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","bim_models"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Create BIM model"}},{"id":"60d84977-6c21-46d4-874d-6abf0fe1440e","name":"listProjectBimModelsFederatedModels — Federated model composition (file-bound revisions)","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/bim_models/federated_models","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","bim_models","federated_models"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Federated model composition (file-bound revisions)"}},{"id":"a7a0f246-1666-456f-8ce5-0dcb05148e0e","name":"getProjectBimModel — Show BIM model","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/bim_models/:bim_model_id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","bim_models",":bim_model_id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"bim_model_id","value":""}]},"description":"Show BIM model"}},{"id":"8c149881-20ae-47f6-8d96-e84f2c415c47","name":"updateProjectBimModel — Update BIM model","request":{"method":"PATCH","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/bim_models/:bim_model_id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","bim_models",":bim_model_id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"bim_model_id","value":""}]},"description":"Update BIM model"}},{"id":"9c9ed9c9-ca7f-41e4-81ff-1a5b6255be99","name":"listProjectBimModelCoordinationIssues — List coordination issues","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/bim_models/:bim_model_id/coordination_issues","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","bim_models",":bim_model_id","coordination_issues"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"bim_model_id","value":""}]},"description":"List coordination issues"}},{"id":"9966b017-3a52-464d-8577-59d81b4d0e23","name":"createProjectBimModelCoordinationIssue — Create coordination issue","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/bim_models/:bim_model_id/coordination_issues","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","bim_models",":bim_model_id","coordination_issues"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"bim_model_id","value":""}]},"description":"Create coordination issue"}},{"id":"3b9dc874-a095-480c-86ec-4917885395d1","name":"getProjectBimModelCoordinationIssue — Show coordination issue","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/bim_models/:bim_model_id/coordination_issues/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","bim_models",":bim_model_id","coordination_issues",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"bim_model_id","value":""},{"key":"id","value":""}]},"description":"Show coordination issue"}},{"id":"418c517d-44fc-418f-8a50-3e865fd7125a","name":"updateProjectBimModelCoordinationIssue — Update coordination issue","request":{"method":"PATCH","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/bim_models/:bim_model_id/coordination_issues/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","bim_models",":bim_model_id","coordination_issues",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"bim_model_id","value":""},{"key":"id","value":""}]},"description":"Update coordination issue"}},{"id":"ce6d5bd4-5c0e-4774-8849-f743591ff64c","name":"listProjectBimModelLinkedCoordinationIssues — List BIM model linked coordination issues","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/bim_models/:bim_model_id/linked_coordination_issues","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","bim_models",":bim_model_id","linked_coordination_issues"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"bim_model_id","value":""}]},"description":"List BIM model linked coordination issues\n\nRequires the `view` permission on the project's models tool. A scoped API token needs `models:read`."}},{"id":"dedc6321-4214-4857-852b-35f7e8ca364e","name":"listProjectBimModelRevisions — List revisions","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/bim_models/:bim_model_id/revisions","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","bim_models",":bim_model_id","revisions"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"bim_model_id","value":""}]},"description":"List revisions"}},{"id":"57e32aaa-4f5b-4ae8-8fb4-e97bca5f75e7","name":"createProjectBimModelRevision — Create revision","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/bim_models/:bim_model_id/revisions","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","bim_models",":bim_model_id","revisions"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"bim_model_id","value":""}]},"description":"Create revision"}},{"id":"d89f8896-05d1-492d-8f5e-84c33c39218f","name":"listProjectBimModelViewpoints — List viewpoints","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/bim_models/:bim_model_id/viewpoints","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","bim_models",":bim_model_id","viewpoints"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"bim_model_id","value":""}]},"description":"List viewpoints"}},{"id":"63010f52-529d-4ff5-8ed9-6dd937502139","name":"createProjectBimModelViewpoint — Create viewpoint","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/bim_models/:bim_model_id/viewpoints","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","bim_models",":bim_model_id","viewpoints"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"bim_model_id","value":""}]},"description":"Create viewpoint"}}]},{"name":"Notifications","description":"Module: notifications","item":[{"id":"c04b3395-6a52-4445-8b35-22e90ee24d93","name":"listProjectNotifications — List the caller's notification inbox","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/notifications","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","notifications"],"query":[{"key":"page","value":"1","disabled":true,"description":"One-based page number."},{"key":"per_page","value":"100","disabled":true,"description":"Maximum items in a page."},{"key":"unread","value":"","disabled":true,"description":"Set to true to show only unread items."},{"key":"filters[read]","value":"","disabled":true,"description":"Set to false to show only unread items. True leaves results unfiltered."}],"variable":[{"key":"project_id","value":"{{projectId}}","description":"Project id in the caller's company. Settings are scoped to this project. The inbox and preferences use the caller's identity."}]},"description":"List the caller's notification inbox\n\nRequires notifications:read. The project id must identify a project in the caller's company. Returns the caller's own currently visible inbox across projects and company-wide events, newest first, with summaries and deep links. Source record operations require their own tool scopes. The project in the path validates company access and leaves inbox results recipient-wide."}},{"id":"dfea1f23-da01-4420-86dd-18b489d89c55","name":"createProjectNotificationsMarkRead — Mark notifications in the caller's inbox read","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/notifications/mark_read","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","notifications","mark_read"],"variable":[{"key":"project_id","value":"{{projectId}}","description":"Project id in the caller's company. Settings are scoped to this project. The inbox and preferences use the caller's identity."}]},"description":"Mark notifications in the caller's inbox read\n\nRequires notifications:write. The project id must identify a project in the caller's company. Marks currently visible notifications read for the caller across projects. Supply ids or all: true. The all option takes precedence if both are supplied.","body":{"mode":"raw","raw":"{\n  \"all\": true\n}","options":{"raw":{"language":"json"}}}}},{"id":"bff22cdc-78f2-4ffa-8243-7529a19e26cd","name":"listProjectNotificationsPreferences — Get the caller's notification preferences","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/notifications/preferences","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","notifications","preferences"],"variable":[{"key":"project_id","value":"{{projectId}}","description":"Project id in the caller's company. Settings are scoped to this project. The inbox and preferences use the caller's identity."}]},"description":"Get the caller's notification preferences\n\nRequires notifications:read. The project id must identify a project in the caller's company. Returns user-wide notification channels for each displayed event and the caller's digest cadence. Unsaved channels default to on and unsaved cadence defaults to off."}},{"id":"f31eac1b-0abe-4082-8bbf-cb654153e53b","name":"updateProjectNotificationsPreferences — Update the caller's notification preferences","request":{"method":"PATCH","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/notifications/preferences","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","notifications","preferences"],"variable":[{"key":"project_id","value":"{{projectId}}","description":"Project id in the caller's company. Settings are scoped to this project. The inbox and preferences use the caller's identity."}]},"description":"Update the caller's notification preferences\n\nRequires notifications:write. The project id must identify a project in the caller's company. Saves the caller's user-wide preferences for future delivery. A supplied event row sets both channel flags, with omitted flags defaulting to true. Omitted events and cadence retain their existing values. Updating the cadence schedules or cancels the caller's future digests.","body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}}}},{"id":"7d7f9683-8607-414b-830b-8ff1915ba41e","name":"listProjectNotificationsSettings — List a project's notification recipient rules for a tool","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/notifications/settings","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","notifications","settings"],"query":[{"key":"tool","value":"","disabled":false,"description":"Tool slug whose notification recipient rules to list."}],"variable":[{"key":"project_id","value":"{{projectId}}","description":"Project id in the caller's company. Settings are scoped to this project. The inbox and preferences use the caller's identity."}]},"description":"List a project's notification recipient rules for a tool\n\nRequires notifications:read and Notifications admin permission on the specified project. Returns enabled and disabled rules for the given tool, sorted by event and then by row id."}},{"id":"efeeb36d-27eb-4b7e-8d2d-8d69579de681","name":"createProjectNotificationsSetting — Create or update a project notification recipient rule","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/notifications/settings","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","notifications","settings"],"variable":[{"key":"project_id","value":"{{projectId}}","description":"Project id in the caller's company. Settings are scoped to this project. The inbox and preferences use the caller's identity."}]},"description":"Create or update a project notification recipient rule\n\nRequires notifications:write and Notifications admin permission on the specified project. Upserts a rule keyed by project, tool slug, event, recipient type, and recipient reference. An existing rule receives the new enabled value, which defaults to true. This affects recipients added by the rule on future matching events, subject to source access and their own channel preferences. Saving the rule does not send a notification.","body":{"mode":"raw","raw":"{\n  \"notification_setting\": {\n    \"event\": \"\",\n    \"recipient_ref\": \"\",\n    \"tool_slug\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"348c6825-47d7-4be3-8810-137bcddcff5c","name":"updateProjectNotificationsSetting — Enable or disable a project notification recipient rule","request":{"method":"PATCH","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/notifications/settings/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","notifications","settings",":id"],"variable":[{"key":"project_id","value":"{{projectId}}","description":"Project id in the caller's company. Settings are scoped to this project. The inbox and preferences use the caller's identity."},{"key":"id","value":"","description":"Notification recipient rule id in the specified project."}]},"description":"Enable or disable a project notification recipient rule\n\nRequires notifications:write and Notifications admin permission on the specified project. This affects recipients added by the rule on future matching events, subject to source access and their own channel preferences. Saving the rule does not send a notification.","body":{"mode":"raw","raw":"{\n  \"notification_setting\": {\n    \"enabled\": false\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"7b8ea595-b453-4a16-89e7-402fd9be1f68","name":"deleteProjectNotificationsSetting — Delete a project notification recipient rule","request":{"method":"DELETE","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/notifications/settings/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","notifications","settings",":id"],"variable":[{"key":"project_id","value":"{{projectId}}","description":"Project id in the caller's company. Settings are scoped to this project. The inbox and preferences use the caller's identity."},{"key":"id","value":"","description":"Notification recipient rule id in the specified project."}]},"description":"Delete a project notification recipient rule\n\nRequires notifications:write and Notifications admin permission on the specified project. Removes the rule's contribution to future matching events. The response has an empty body."}}]},{"name":"Observations","description":"Module: observations","item":[{"id":"6d767ec3-557f-45ca-8449-9e8229d8b544","name":"listObservationsAssignees — List Observation Assignee options","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/observations/assignees","host":["{{baseUrl}}"],"path":["rest","v1.0","observations","assignees"],"query":[{"key":"project_id","value":"","disabled":false},{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true},{"key":"filters[category_id]","value":"","disabled":true}]},"description":"List Observation Assignee options"}},{"id":"d7bce56e-6622-41a6-8ca1-6dca2fbc1340","name":"listObservationsDefaultDistribution — List Observation Default Distribution Members","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/observations/default_distribution","host":["{{baseUrl}}"],"path":["rest","v1.0","observations","default_distribution"],"query":[{"key":"project_id","value":"","disabled":false},{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true}]},"description":"List Observation Default Distribution Members"}},{"id":"6e350dd8-4aa5-4624-8da5-5ce69b637ad1","name":"listObservationsItems — List Observation Items","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/observations/items","host":["{{baseUrl}}"],"path":["rest","v1.0","observations","items"],"query":[{"key":"filters[assignee_company_id]","value":"","disabled":true},{"key":"filters[checklist_list_id]","value":"","disabled":true},{"key":"filters[created_by_id]","value":"","disabled":true},{"key":"filters[id]","value":"","disabled":true},{"key":"filters[location_id]","value":"","disabled":true},{"key":"filters[assignee_id]","value":"","disabled":true},{"key":"filters[checklist_item_id]","value":"","disabled":true},{"key":"filters[custom_fields]","value":"","disabled":true},{"key":"filters[priority]","value":"","disabled":true},{"key":"filters[search]","value":"","disabled":true},{"key":"filters[status]","value":"","disabled":true},{"key":"filters[type_id]","value":"","disabled":true},{"key":"filters[trade_ids]","value":"","disabled":true},{"key":"filters[updated_at]","value":"","disabled":true},{"key":"project_id","value":"","disabled":false},{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true},{"key":"sort","value":"","disabled":true},{"key":"view","value":"","disabled":true}]},"description":"List Observation Items"}},{"id":"649f1398-b5a1-4a34-8731-f33bfb305a67","name":"createObservationsItem — Create Observation Item","request":{"method":"POST","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/observations/items","host":["{{baseUrl}}"],"path":["rest","v1.0","observations","items"],"query":[{"key":"run_configurable_validations","value":"","disabled":true},{"key":"view","value":"","disabled":true}]},"description":"Create Observation Item","body":{"mode":"raw","raw":"{\n  \"inspection_item_failed\": 0,\n  \"observation\": {},\n  \"project_id\": 0\n}","options":{"raw":{"language":"json"}}}}},{"id":"964e6820-3838-4e22-8e8e-c1a83975ec5b","name":"listObservationsItemsNextAvailableNumber — Show Next Available Number for Observation Items","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/observations/items/next_available_number","host":["{{baseUrl}}"],"path":["rest","v1.0","observations","items","next_available_number"],"query":[{"key":"project_id","value":"","disabled":false}]},"description":"Show Next Available Number for Observation Items"}},{"id":"1c26dde6-171b-42a2-82f5-5b563ad09da5","name":"createObservationsItemsSendUnsent — Send unsent Observation Items","request":{"method":"POST","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/observations/items/send_unsent","host":["{{baseUrl}}"],"path":["rest","v1.0","observations","items","send_unsent"]},"description":"Send unsent Observation Items","body":{"mode":"raw","raw":"{\n  \"project_id\": 0\n}","options":{"raw":{"language":"json"}}}}},{"id":"84c58503-cd77-41cc-80f5-8d1e2e21cbf8","name":"getObservationsItem — Show Observation Item","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/observations/items/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","observations","items",":id"],"query":[{"key":"project_id","value":"","disabled":false},{"key":"view","value":"","disabled":true}],"variable":[{"key":"id","value":""}]},"description":"Show Observation Item"}},{"id":"a5af32e3-a8e4-4c31-8168-64219715d465","name":"updateObservationsItem — Update Observation Item","request":{"method":"PATCH","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/observations/items/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","observations","items",":id"],"query":[{"key":"view","value":"","disabled":true}],"variable":[{"key":"id","value":""}]},"description":"Update Observation Item","body":{"mode":"raw","raw":"{\n  \"observation\": {},\n  \"project_id\": 0\n}","options":{"raw":{"language":"json"}}}}},{"id":"705ab6af-3ec2-4aef-833e-12269eb7bff0","name":"createObservationsItemAttachment — Upload observation item attachment","request":{"method":"POST","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/observations/items/:id/attachments","host":["{{baseUrl}}"],"path":["rest","v1.0","observations","items",":id","attachments"],"variable":[{"key":"id","value":""}]},"description":"Upload observation item attachment"}},{"id":"e356044a-e8db-406c-8338-996da7772ffa","name":"listObservationsItemPdf — Download Observation as PDF","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/observations/items/:id/pdf","host":["{{baseUrl}}"],"path":["rest","v1.0","observations","items",":id","pdf"],"query":[{"key":"project_id","value":"","disabled":true}],"variable":[{"key":"id","value":""}]},"description":"Download Observation as PDF\n\nThe observation as a PDF document (general information, description and response log). The project is the observation's own; a supplied project_id must match it."}},{"id":"4f9ae619-642f-4423-8cb2-453ffe6ecd05","name":"createObservationsItemResponseLogAttachment — Upload response log attachment","request":{"method":"POST","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/observations/items/:id/response_logs/:response_id/attachments","host":["{{baseUrl}}"],"path":["rest","v1.0","observations","items",":id","response_logs",":response_id","attachments"],"variable":[{"key":"id","value":""},{"key":"response_id","value":""}]},"description":"Upload response log attachment"}},{"id":"69288e6e-60e9-4368-875f-62f1192d0620","name":"sendEmailObservationsItem — Send Observation Item Email","request":{"method":"POST","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/observations/items/:id/send_email","host":["{{baseUrl}}"],"path":["rest","v1.0","observations","items",":id","send_email"],"query":[{"key":"project_id","value":"","disabled":false}],"variable":[{"key":"id","value":""}]},"description":"Send Observation Item Email","body":{"mode":"raw","raw":"{\n  \"bcc_distribution_ids\": [\n    0\n  ],\n  \"body\": \"\",\n  \"cc_distribution_ids\": [\n    0\n  ],\n  \"distribution_ids\": [\n    0\n  ],\n  \"subject\": \"\"\n}","options":{"raw":{"language":"json"}}}}},{"id":"d85576f4-4ecf-49a6-8d7f-1f84ac048bb0","name":"listObservationsItemResponseLogs — List Observation Item Response Logs","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/observations/items/:item_id/response_logs","host":["{{baseUrl}}"],"path":["rest","v1.0","observations","items",":item_id","response_logs"],"query":[{"key":"project_id","value":"","disabled":false},{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true}],"variable":[{"key":"item_id","value":""}]},"description":"List Observation Item Response Logs"}},{"id":"792ac238-8cbc-48a2-8374-e9e36912b131","name":"createObservationsItemResponseLog — Create Observation Item Response Log","request":{"method":"POST","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/observations/items/:item_id/response_logs","host":["{{baseUrl}}"],"path":["rest","v1.0","observations","items",":item_id","response_logs"],"query":[{"key":"run_configurable_validations","value":"","disabled":true}],"variable":[{"key":"item_id","value":""}]},"description":"Create Observation Item Response Log","body":{"mode":"raw","raw":"{\n  \"project_id\": 0,\n  \"response_log\": {},\n  \"status\": \"initiated\"\n}","options":{"raw":{"language":"json"}}}}},{"id":"d6102f42-e924-4c89-8c57-cbd187f1f419","name":"listObservationsPotentialDistributionMembers — List Observation Potential Distribution Members","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/observations/potential_distribution_members","host":["{{baseUrl}}"],"path":["rest","v1.0","observations","potential_distribution_members"],"query":[{"key":"project_id","value":"","disabled":false},{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true},{"key":"filters[search]","value":"","disabled":true},{"key":"filters[category_id]","value":"","disabled":true}]},"description":"List Observation Potential Distribution Members"}},{"id":"15f5fb79-9587-4655-8b37-0177c7e93546","name":"listObservationsTypes — List Observation Types","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/observations/types","host":["{{baseUrl}}"],"path":["rest","v1.0","observations","types"],"query":[{"key":"project_id","value":"","disabled":false},{"key":"company_id","value":"","disabled":false},{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true}]},"description":"List Observation Types"}},{"id":"32bdbfe8-0d4e-4066-893f-d7ab91727488","name":"listProjectChecklistListItemObservations — List Checklist Item Observations","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/checklist/list_item_observations","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","checklist","list_item_observations"],"query":[{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true},{"key":"filters[id]","value":"","disabled":true},{"key":"filters[item_id]","value":"","disabled":true},{"key":"filters[created_at]","value":"","disabled":true},{"key":"filters[updated_at]","value":"","disabled":true},{"key":"sort","value":"","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"List Checklist Item Observations\n\nObservations created from inspection (checklist) items. filters[item_id] are inspection item ids; filters[created_at] / filters[updated_at] take a YYYY-MM-DD day; sort=created_at or -created_at. Needs observations and inspections view permission; private observations and inspections the caller cannot see are left out."}},{"id":"01f1b173-bdaf-4c4e-8def-f05c293c941d","name":"listProjectObservationTemplates — GET /rest/v1.0/projects/{project_id}/observation_templates","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/observation_templates","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","observation_templates"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"GET /rest/v1.0/projects/{project_id}/observation_templates"}},{"id":"71c1f157-8bbc-4bcf-826b-b5d71c28e889","name":"createProjectObservationTemplate — POST /rest/v1.0/projects/{project_id}/observation_templates","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/observation_templates","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","observation_templates"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"POST /rest/v1.0/projects/{project_id}/observation_templates"}},{"id":"c65ae23c-4fc3-4935-8a01-068c718f379c","name":"getProjectObservationTemplate — GET /rest/v1.0/projects/{project_id}/observation_templates/{id}","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/observation_templates/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","observation_templates",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"GET /rest/v1.0/projects/{project_id}/observation_templates/{id}"}},{"id":"b52ed54f-9804-4c71-84c6-00f8b0875122","name":"updateProjectObservationTemplate — PATCH /rest/v1.0/projects/{project_id}/observation_templates/{id}","request":{"method":"PATCH","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/observation_templates/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","observation_templates",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"PATCH /rest/v1.0/projects/{project_id}/observation_templates/{id}"}},{"id":"05e0a4a2-ae7f-48a0-8bb7-ce38a011ea96","name":"deleteProjectObservationTemplate — DELETE /rest/v1.0/projects/{project_id}/observation_templates/{id}","request":{"method":"DELETE","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/observation_templates/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","observation_templates",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"DELETE /rest/v1.0/projects/{project_id}/observation_templates/{id}"}},{"id":"ff08de40-de73-4db5-8e27-df012364d435","name":"createObservationProjectObservationTemplate — POST /rest/v1.0/projects/{project_id}/observation_templates/{id}/create_observation","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/observation_templates/:id/create_observation","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","observation_templates",":id","create_observation"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"POST /rest/v1.0/projects/{project_id}/observation_templates/{id}/create_observation"}},{"id":"d230188d-1a52-4212-86ca-9c159aded007","name":"listProjectObservationsItemsStatuses — List available Observation Item statuses with localized labels","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/observations/items/statuses","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","observations","items","statuses"],"query":[{"key":"id","value":"","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"List available Observation Item statuses with localized labels"}},{"id":"43cea39a-a27a-4ec7-82a9-9b2b5af0b9ad","name":"deleteProjectObservationsItem — Delete Observation Item","request":{"method":"DELETE","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/observations/items/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","observations","items",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Delete Observation Item"}},{"id":"c912312a-d2b4-4a3b-8ff5-eb4fbec23e73","name":"listProjectObservationsResponseLogs — List Observations Response Logs","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/observations/response_logs","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","observations","response_logs"],"query":[{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true},{"key":"filters[id]","value":"","disabled":true},{"key":"filters[updated_at]","value":"","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"List Observations Response Logs"}},{"id":"bb43d08b-82ab-4bea-820b-5b81bef5a3d1","name":"listProjectRecycleBinObservationsItems — List Recycled Observation Items","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/recycle_bin/observations/items","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","recycle_bin","observations","items"],"query":[{"key":"filters[type_id]","value":"","disabled":true},{"key":"filters[trade_ids]","value":"","disabled":true},{"key":"filters[assignee_id]","value":"","disabled":true},{"key":"filters[status]","value":"","disabled":true},{"key":"filters[priority]","value":"","disabled":true},{"key":"filters[location_id]","value":"","disabled":true},{"key":"filters[created_by_id]","value":"","disabled":true},{"key":"filters[assignee_company_id]","value":"","disabled":true},{"key":"filters[updated_at]","value":"","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"List Recycled Observation Items"}},{"id":"e506b16e-320c-4b93-8aa8-b43e8214f618","name":"getProjectRecycleBinObservationsItem — Show Recycled Observation","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/recycle_bin/observations/items/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","recycle_bin","observations","items",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Show Recycled Observation"}},{"id":"0910ed1a-7c0d-42b2-897a-7519a7de0c28","name":"restoreProjectRecycleBinObservationsItem — Retrieve Recycled Observation","request":{"method":"PATCH","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/recycle_bin/observations/items/:id/restore","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","recycle_bin","observations","items",":id","restore"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Retrieve Recycled Observation"}}]},{"name":"Owner Reports","description":"Module: owner_reports","item":[{"id":"0a1a9430-094c-498d-8f4e-63f388e6bf25","name":"listCompanyOwnerReports — List portfolio owner reports","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/owner_reports","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","owner_reports"],"variable":[{"key":"company_id","value":"{{companyId}}"}]},"description":"List portfolio owner reports\n\nPortfolio reports belong to their creator and company administrators; each project inside is read with your access in that project."}},{"id":"6ddb86f2-87f8-4bdf-8df4-25a0dc187031","name":"createCompanyOwnerReport — Create a portfolio owner report","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/owner_reports","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","owner_reports"],"variable":[{"key":"company_id","value":"{{companyId}}"}]},"description":"Create a portfolio owner report\n\nDefault period: the previous calendar month. Token scope: owner_reports:write.","body":{"mode":"raw","raw":"{\n  \"owner_report\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"6b1ec0e6-2ca0-4356-821e-255adb6cd636","name":"listCompanyOwnerReportsOwners — List owners for portfolio reports","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/owner_reports/owners","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","owner_reports","owners"],"variable":[{"key":"company_id","value":"{{companyId}}"}]},"description":"List owners for portfolio reports\n\nOwners (vendors on prime contracts) with the projects where you can view Owner Reports."}},{"id":"a840597f-a9cb-4067-83d9-68d507d43c4a","name":"getCompanyOwnerReport — Show an owner report","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/owner_reports/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","owner_reports",":id"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Show an owner report"}},{"id":"c294f8ee-a42b-4ef8-8719-cf75b7b44b3d","name":"updateCompanyOwnerReport — Update an owner report","request":{"method":"PATCH","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/owner_reports/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","owner_reports",":id"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Update an owner report\n\nEdit the narrative, section commentary, risks, sections, period and photo selection. Published versions are never changed.","body":{"mode":"raw","raw":"{\n  \"owner_report\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"fed6d717-c0e1-4cc4-8089-3879f210c42c","name":"deleteCompanyOwnerReport — Delete an owner report","request":{"method":"DELETE","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/owner_reports/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","owner_reports",":id"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Delete an owner report\n\nSoft-deletes the report and revokes its share links. Versions are kept."}},{"id":"de01ca03-bad0-4128-8a84-28637e92bef8","name":"listCompanyOwnerReportPdf — Download a draft PDF","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/owner_reports/:id/pdf","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","owner_reports",":id","pdf"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Download a draft PDF\n\nRenders the live report as a branded PDF without publishing."}},{"id":"33da2e6d-b862-43ec-8291-80b37802394d","name":"listCompanyOwnerReportPreview — Preview the live report","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/owner_reports/:id/preview","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","owner_reports",":id","preview"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Preview the live report\n\nAssembles the report now from live project data with your access. Nothing is stored."}},{"id":"2eaa3526-4260-405c-8065-455fb55c514d","name":"listCompanyOwnerReportShareLinks — List share links","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/owner_reports/:id/share_links","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","owner_reports",":id","share_links"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"List share links"}},{"id":"35953885-ef60-4103-87db-fc2f2accf1f6","name":"createCompanyOwnerReportShareLink — Create an owner share link","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/owner_reports/:id/share_links","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","owner_reports",":id","share_links"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Create an owner share link\n\nA read-only, expiring (max 90 days), revocable link to one published version, opened without a sign-in at /owner-report/{token}. Every open is logged. The token is returned once. Optionally emails the link.","body":{"mode":"raw","raw":"{\n  \"share_link\": {\n    \"version_id\": 0\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"1ac4e8e5-2682-4496-8a0e-0e13ddd6f599","name":"deleteCompanyOwnerReportShareLink — Revoke a share link","request":{"method":"DELETE","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/owner_reports/:id/share_links/:link_id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","owner_reports",":id","share_links",":link_id"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""},{"key":"link_id","value":""}]},"description":"Revoke a share link\n\nThe link answers 410 from now on. Optional JSON body with a reason string."}},{"id":"9efd145b-7342-4194-898e-83fbff8f0300","name":"listCompanyOwnerReportShareLinkViews — Share link access log","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/owner_reports/:id/share_links/:link_id/views","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","owner_reports",":id","share_links",":link_id","views"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""},{"key":"link_id","value":""}]},"description":"Share link access log"}},{"id":"a6873caf-b499-4bfe-8514-c463bf359085","name":"listCompanyOwnerReportVersions — List versions","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/owner_reports/:id/versions","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","owner_reports",":id","versions"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"List versions\n\nPublished versions and scheduled deliveries, newest first."}},{"id":"001537e5-3db3-48b2-8d5d-e6dd23fd2d3d","name":"createCompanyOwnerReportVersion — Publish a version","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/owner_reports/:id/versions","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","owner_reports",":id","versions"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Publish a version\n\nAssembles the report with your access and freezes it (JSON, branded PDF and photo bytes, PDF SHA-256). Versions are immutable."}},{"id":"0f17e3fd-5a76-447d-8ca3-030a4e56df32","name":"getCompanyOwnerReportVersion — Show a frozen version","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/owner_reports/:id/versions/:version_id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","owner_reports",":id","versions",":version_id"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""},{"key":"version_id","value":""}]},"description":"Show a frozen version\n\nRequires view on Owner Reports and on every source tool the version contains."}},{"id":"452d804b-12f4-40d2-8af2-caac5ff353ab","name":"listCompanyOwnerReportVersionPdf — Download a frozen version's PDF","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/owner_reports/:id/versions/:version_id/pdf","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","owner_reports",":id","versions",":version_id","pdf"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""},{"key":"version_id","value":""}]},"description":"Download a frozen version's PDF\n\nServed only when its SHA-256 still matches (409 otherwise)."}},{"id":"df1887fd-c6b8-4508-80d6-5a0c70954f5c","name":"listProjectOwnerReports — List owner reports","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/owner_reports","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","owner_reports"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"List owner reports\n\nOwner Reports tool permission (view to read; create, edit or delete to change). Data sections are assembled with your access in each source tool."}},{"id":"cef6e19f-7f07-4508-8ab4-a35712e29065","name":"createProjectOwnerReport — Create an owner report","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/owner_reports","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","owner_reports"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Create an owner report\n\nDefault period: the previous calendar month. Templates: monthly_aia (AIA-style monthly report), gmp_cost (cost-plus backup summary), executive (one-pager).","body":{"mode":"raw","raw":"{\n  \"owner_report\": {\n    \"template\": \"monthly_aia\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"0ce59b09-d36d-43c5-89b5-37547034fce5","name":"getProjectOwnerReport — Show an owner report","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/owner_reports/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","owner_reports",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Show an owner report"}},{"id":"53cafac6-3211-46f6-8d63-dd9d964df77c","name":"updateProjectOwnerReport — Update an owner report","request":{"method":"PATCH","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/owner_reports/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","owner_reports",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Update an owner report\n\nEdit the narrative, section commentary, risks, sections, period and photo selection. Published versions are never changed.","body":{"mode":"raw","raw":"{\n  \"owner_report\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"a9c807d8-06b8-4cbd-8243-7da4a82fdc50","name":"deleteProjectOwnerReport — Delete an owner report","request":{"method":"DELETE","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/owner_reports/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","owner_reports",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Delete an owner report\n\nSoft-deletes the report and revokes its share links. Versions are kept."}},{"id":"8d352f0f-004d-4fcc-88b9-ddc5a23f4275","name":"listProjectOwnerReportPdf — Download a draft PDF","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/owner_reports/:id/pdf","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","owner_reports",":id","pdf"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Download a draft PDF\n\nRenders the live report as a branded PDF without publishing."}},{"id":"dea55ebb-4149-4ae7-8da2-f1b1c4d64d58","name":"listProjectOwnerReportPreview — Preview the live report","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/owner_reports/:id/preview","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","owner_reports",":id","preview"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Preview the live report\n\nAssembles the report now from live project data with your access. Nothing is stored."}},{"id":"b079f465-687f-442e-8546-5a73d43ec6a2","name":"listProjectOwnerReportShareLinks — List share links","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/owner_reports/:id/share_links","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","owner_reports",":id","share_links"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"List share links"}},{"id":"092b5cb8-ba63-4251-82df-8e1dcb900b1c","name":"createProjectOwnerReportShareLink — Create an owner share link","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/owner_reports/:id/share_links","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","owner_reports",":id","share_links"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Create an owner share link\n\nA read-only, expiring (max 90 days), revocable link to one published version, opened without a sign-in at /owner-report/{token}. Every open is logged. The token is returned once. Optionally emails the link.","body":{"mode":"raw","raw":"{\n  \"share_link\": {\n    \"version_id\": 0\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"3b2f7f00-9681-418a-8cff-df16c0f2916e","name":"deleteProjectOwnerReportShareLink — Revoke a share link","request":{"method":"DELETE","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/owner_reports/:id/share_links/:link_id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","owner_reports",":id","share_links",":link_id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""},{"key":"link_id","value":""}]},"description":"Revoke a share link\n\nThe link answers 410 from now on. Optional JSON body with a reason string."}},{"id":"6e8414c9-69b7-4204-83f9-6f187e079efd","name":"listProjectOwnerReportShareLinkViews — Share link access log","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/owner_reports/:id/share_links/:link_id/views","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","owner_reports",":id","share_links",":link_id","views"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""},{"key":"link_id","value":""}]},"description":"Share link access log"}},{"id":"74a34a44-0b39-46ad-8537-7f78e1e8d16d","name":"listProjectOwnerReportVersions — List versions","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/owner_reports/:id/versions","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","owner_reports",":id","versions"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"List versions\n\nPublished versions and scheduled deliveries, newest first."}},{"id":"82cb3aa1-3b6c-428c-8225-ceb6fdae251e","name":"createProjectOwnerReportVersion — Publish a version","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/owner_reports/:id/versions","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","owner_reports",":id","versions"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Publish a version\n\nAssembles the report with your access and freezes it (JSON, branded PDF and photo bytes, PDF SHA-256). Versions are immutable."}},{"id":"6e4ee6ef-c70b-4346-837c-14086d1a7aaf","name":"getProjectOwnerReportVersion — Show a frozen version","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/owner_reports/:id/versions/:version_id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","owner_reports",":id","versions",":version_id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""},{"key":"version_id","value":""}]},"description":"Show a frozen version\n\nRequires view on Owner Reports and on every source tool the version contains."}},{"id":"cc9008a8-12ec-4ffe-8507-b66f0b76cbe4","name":"listProjectOwnerReportVersionPdf — Download a frozen version's PDF","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/owner_reports/:id/versions/:version_id/pdf","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","owner_reports",":id","versions",":version_id","pdf"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""},{"key":"version_id","value":""}]},"description":"Download a frozen version's PDF\n\nServed only when its SHA-256 still matches (409 otherwise)."}}]},{"name":"Payment Applications","description":"Module: payment_applications","item":[{"id":"c8476c7f-b9cc-4bbf-83ed-2cf1e88ccde3","name":"listProjectPaymentApplications — List payment applications","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/payment_applications","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","payment_applications"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"List payment applications"}},{"id":"1b414414-7a84-40a9-8202-993c8836e47b","name":"createProjectPaymentApplication — Create payment application","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/payment_applications","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","payment_applications"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Create payment application","body":{"mode":"raw","raw":"{\n  \"payment_application\": {\n    \"contract_id\": 0\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"cb93ac95-b6c2-4716-8c06-89a3b463c228","name":"listProjectPaymentApplicationsFilterOptionsContracts — List payment applications filter options for contracts","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/payment_applications/filter_options/contracts","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","payment_applications","filter_options","contracts"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"List payment applications filter options for contracts\n\nRequires the `view` permission on the project's payment applications tool. A scoped API token needs `payment_applications:read`."}},{"id":"327903f0-6e00-4159-8757-e2a90157c95a","name":"listProjectPaymentApplicationsFilterOptionsStatuses — Status filter options","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/payment_applications/filter_options/statuses","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","payment_applications","filter_options","statuses"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Status filter options"}},{"id":"8409cfde-4a18-4ee0-88bf-ae8e64f9c2f7","name":"getProjectPaymentApplication — Show payment application","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/payment_applications/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","payment_applications",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Show payment application"}},{"id":"2de327b1-ac5c-44b7-88cc-53907ec59f42","name":"updateProjectPaymentApplication — Update payment application","request":{"method":"PATCH","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/payment_applications/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","payment_applications",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Update payment application"}},{"id":"b243a165-3f40-4e45-8eaf-d7f2227dcfe8","name":"deleteProjectPaymentApplication — Delete payment application","request":{"method":"DELETE","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/payment_applications/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","payment_applications",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Delete payment application"}},{"id":"dc44d739-706e-41f5-8505-eb1d14482c6d","name":"approveProjectPaymentApplication — Approve","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/payment_applications/:id/approve","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","payment_applications",":id","approve"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Approve"}},{"id":"34d1bde9-d48d-4204-8183-c360ae6b1814","name":"listProjectPaymentApplicationLines — List continuation-sheet (G703) line items","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/payment_applications/:id/lines","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","payment_applications",":id","lines"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"List continuation-sheet (G703) line items"}},{"id":"bcfb14ba-0340-417c-8041-50afdb1a4444","name":"updateProjectPaymentApplicationLine — Update a line (this-period entry)","request":{"method":"PATCH","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/payment_applications/:id/lines/:line_id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","payment_applications",":id","lines",":line_id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""},{"key":"line_id","value":""}]},"description":"Update a line (this-period entry)"}},{"id":"e35ae84c-8b4f-42f2-872d-6dc4f0c27e55","name":"markPaidProjectPaymentApplication — Mark payment application paid","request":{"method":"POST","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/payment_applications/:id/mark_paid","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","payment_applications",":id","mark_paid"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Mark payment application paid"}},{"id":"a2347058-e17a-437c-8f8e-1365190acdb9","name":"rejectProjectPaymentApplication — Reject","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/payment_applications/:id/reject","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","payment_applications",":id","reject"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Reject"}},{"id":"38e39c41-14a4-4d52-8fa8-9653995c1897","name":"revertApprovalProjectPaymentApplication — Revert payment application approval","request":{"method":"POST","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/payment_applications/:id/revert_approval","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","payment_applications",":id","revert_approval"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Revert payment application approval"}},{"id":"fa60e972-ab8d-4c65-8c62-c356467fc471","name":"reviseProjectPaymentApplication — Revise payment application","request":{"method":"POST","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/payment_applications/:id/revise","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","payment_applications",":id","revise"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Revise payment application"}},{"id":"ca1e06e5-d35d-4c80-87ce-47d896590cbc","name":"submitProjectPaymentApplication — Submit for review","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/payment_applications/:id/submit","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","payment_applications",":id","submit"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Submit for review"}},{"id":"1570563c-a710-428f-8c2d-debfa2ed1ae9","name":"voidProjectPaymentApplication — Void","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/payment_applications/:id/void","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","payment_applications",":id","void"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Void"}}]},{"name":"Permits","description":"Module: permits","item":[{"id":"778046b5-4187-442e-861d-842589a41e10","name":"listCompanyPermitsWorkQueue — GET /rest/v1.0/companies/{company_id}/permits/work_queue","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/permits/work_queue","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","permits","work_queue"],"query":[{"key":"project_id","value":"","disabled":true},{"key":"owner","value":"","disabled":true},{"key":"due","value":"","disabled":true},{"key":"search","value":"","disabled":true},{"key":"take","value":"","disabled":true}],"variable":[{"key":"company_id","value":"{{companyId}}"}]},"description":"GET /rest/v1.0/companies/{company_id}/permits/work_queue\n\nRead-only company permit queue. Requires current active company identity and exact permits:read token scope. Each project's current permit view permission and tool enablement are checked before gathering and again before publishing rows, totals or project options. Denied projects are omitted without hidden counts. Unexpected source errors fail the request. Includes open conditions on active permits and issued-permit expirations. Owner and UTC date semantics match the project queue. Returns only the first take tasks ordered by date (null last), condition before expiration, item ID, then project ID. Total is the sum of complete matching counts for currently authorized sources, not the number of returned tasks. No offset or next-page cursor; narrow filters to reach other work."}},{"id":"cfca15db-d799-4cd8-8e28-5cf258449fe7","name":"listProjectPermits — GET /rest/v1.0/projects/{project_id}/permits","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/permits","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","permits"],"query":[{"key":"filters[status]","value":"","disabled":true},{"key":"search","value":"","disabled":true},{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"GET /rest/v1.0/projects/{project_id}/permits"}},{"id":"096975e7-b517-4b35-8246-e709ec0954d6","name":"createProjectPermit — POST /rest/v1.0/projects/{project_id}/permits","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/permits","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","permits"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"POST /rest/v1.0/projects/{project_id}/permits","body":{"mode":"raw","raw":"{\n  \"permit\": {\n    \"authority_name\": \"\",\n    \"jurisdiction_code\": \"\",\n    \"permit_type\": \"\",\n    \"title\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"1f4d10ce-9009-4726-8fd5-9c59c6140cd3","name":"getProjectPermit — GET /rest/v1.0/projects/{project_id}/permits/{id}","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/permits/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","permits",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"GET /rest/v1.0/projects/{project_id}/permits/{id}"}},{"id":"0975eeb1-f156-4507-87c4-2b6aa02e07d7","name":"updateProjectPermit — PATCH /rest/v1.0/projects/{project_id}/permits/{id}","request":{"method":"PATCH","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/permits/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","permits",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"PATCH /rest/v1.0/projects/{project_id}/permits/{id}","body":{"mode":"raw","raw":"{\n  \"permit\": {\n    \"version\": 0\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"9637dc45-b787-4379-85d1-3309ca33eda5","name":"listProjectPermitConditions — GET /rest/v1.0/projects/{project_id}/permits/{id}/conditions","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/permits/:id/conditions","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","permits",":id","conditions"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"GET /rest/v1.0/projects/{project_id}/permits/{id}/conditions"}},{"id":"75a0fadf-2f9e-4814-821d-cc6c555989c1","name":"createProjectPermitCondition — POST /rest/v1.0/projects/{project_id}/permits/{id}/conditions","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/permits/:id/conditions","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","permits",":id","conditions"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"POST /rest/v1.0/projects/{project_id}/permits/{id}/conditions","body":{"mode":"raw","raw":"{\n  \"condition\": {\n    \"description\": \"\",\n    \"expected_version\": 0,\n    \"required_before\": \"issue\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"ccaf526c-8b29-4566-8339-0d20d14ea283","name":"updateProjectPermitCondition — PATCH /rest/v1.0/projects/{project_id}/permits/{id}/conditions/{condition_id}","request":{"method":"PATCH","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/permits/:id/conditions/:condition_id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","permits",":id","conditions",":condition_id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""},{"key":"condition_id","value":""}]},"description":"PATCH /rest/v1.0/projects/{project_id}/permits/{id}/conditions/{condition_id}","body":{"mode":"raw","raw":"{\n  \"condition\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"ae14702f-64c3-4530-8733-ee0168f15e05","name":"followUpProjectPermitCondition — PATCH /rest/v1.0/projects/{project_id}/permits/{id}/conditions/{condition_id}/follow_up","request":{"method":"PATCH","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/permits/:id/conditions/:condition_id/follow_up","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","permits",":id","conditions",":condition_id","follow_up"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""},{"key":"condition_id","value":""}]},"description":"PATCH /rest/v1.0/projects/{project_id}/permits/{id}/conditions/{condition_id}/follow_up\n\nPermit edit access required. Correct an open condition's recorded due date and assignee on a permit that is neither closed nor withdrawn. The assignee must be an active same-company project member. Null assignee restores permit-responsible-person fallback. Both versions must match. A material change increments both versions and appends history; an unchanged request does neither and does not reserve its request key. Identical material retries by the same actor replay without further changes, including after completion; reuse with changed payload returns 409. No completion, prerequisite, evidence or authority status changes are accepted.","body":{"mode":"raw","raw":"{\n  \"condition\": {\n    \"assignee_user_id\": 0,\n    \"due_on\": \"2026-01-31\",\n    \"expected_version\": 0,\n    \"reason\": \"\",\n    \"request_key\": \"\",\n    \"version\": 0\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"f27dcb4c-3974-4ab4-8784-3211eb29748c","name":"createProjectPermitEvent — POST /rest/v1.0/projects/{project_id}/permits/{id}/events","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/permits/:id/events","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","permits",":id","events"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"POST /rest/v1.0/projects/{project_id}/permits/{id}/events","body":{"mode":"raw","raw":"{\n  \"event\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"69c6dd44-4508-4e7f-88e4-50f4b849002e","name":"listProjectPermitEvidenceOptions — GET /rest/v1.0/projects/{project_id}/permits/{id}/evidence_options","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/permits/:id/evidence_options","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","permits",":id","evidence_options"],"query":[{"key":"search","value":"","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"GET /rest/v1.0/projects/{project_id}/permits/{id}/evidence_options\n\nSearch existing real uploaded Documents versions for this permit. Requires permit view and independent Documents view. Token callers also need documents:read. Results are bounded; refine search when has_more is true."}}]},{"name":"Photos","description":"Module: photos","item":[{"id":"227e7e41-5546-4434-88d9-e7a17680c125","name":"listImageCategories — List image categories","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/image_categories","host":["{{baseUrl}}"],"path":["rest","v1.0","image_categories"],"query":[{"key":"project_id","value":"","disabled":false},{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true}]},"description":"List image categories"}},{"id":"927a362d-8f85-433e-8cf5-49115749b1bb","name":"createImageCategory — Create image category","request":{"method":"POST","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/image_categories","host":["{{baseUrl}}"],"path":["rest","v1.0","image_categories"],"query":[{"key":"project_id","value":"","disabled":false}]},"description":"Create image category","body":{"mode":"raw","raw":"{\n  \"image_category\": {\n    \"name\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"3ce5648b-262c-4b8a-8983-bc46af599284","name":"listImageCategoriesIdsWithImages — List Image Category IDs That Contain Images","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/image_categories/ids_with_images","host":["{{baseUrl}}"],"path":["rest","v1.0","image_categories","ids_with_images"],"query":[{"key":"project_id","value":"","disabled":false},{"key":"filters[updated_at]","value":"","disabled":true}]},"description":"List Image Category IDs That Contain Images"}},{"id":"83bddfe1-3c1e-4e42-84a1-af96bd51b7b1","name":"getImageCategory — Show image category","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/image_categories/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","image_categories",":id"],"query":[{"key":"project_id","value":"","disabled":false}],"variable":[{"key":"id","value":""}]},"description":"Show image category"}},{"id":"bcedff01-d7cf-41ec-8bb3-e0dd8f6fcdcd","name":"updateImageCategory — Update image category","request":{"method":"PATCH","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/image_categories/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","image_categories",":id"],"query":[{"key":"project_id","value":"","disabled":false}],"variable":[{"key":"id","value":""}]},"description":"Update image category","body":{"mode":"raw","raw":"{\n  \"image_category\": {\n    \"name\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"ff025093-f84d-4c6a-8564-1a7c1f6aff25","name":"deleteImageCategory — Delete image category","request":{"method":"DELETE","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/image_categories/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","image_categories",":id"],"query":[{"key":"project_id","value":"","disabled":false}],"variable":[{"key":"id","value":""}]},"description":"Delete image category\n\nDelete an empty album (project_id query parameter required). An album that still holds photos returns 409; move or delete them first. Needs photos delete permission."}},{"id":"c5b372a3-9e76-4ba3-86c9-e3914e3e6720","name":"listImageTags — List catalog tags for a project","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/image_tags","host":["{{baseUrl}}"],"path":["rest","v1.0","image_tags"],"query":[{"key":"project_id","value":"","disabled":false,"description":"Project id in the authenticated company."},{"key":"in_use","value":"","disabled":true,"description":"Include only tags assigned to a currently visible photo."}]},"description":"List catalog tags for a project\n\nRequires photos:read and Photos view permission in the specified project. Returns the project's live tag catalog. Usage counts include photos visible to the caller. Set in_use=true to limit results to tags with visible assignments."}},{"id":"b7ee760f-67b1-4461-879b-437f8e357df9","name":"createImageTag — Create or find a project photo tag","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/image_tags","host":["{{baseUrl}}"],"path":["rest","v1.0","image_tags"],"query":[{"key":"project_id","value":"","disabled":false,"description":"Project id in the authenticated company."}]},"description":"Create or find a project photo tag\n\nRequires photos:write and Photos create permission in the specified project. Finds or creates a project catalog tag using a case-insensitive name match. An existing tag retains its color.","body":{"mode":"raw","raw":"{\n  \"image_tag\": {\n    \"name\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"313527b7-d332-4eec-8eb0-605151b3b039","name":"listImageTagsAvailableTags — List project photo tags with visible assignments","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/image_tags/available_tags","host":["{{baseUrl}}"],"path":["rest","v1.0","image_tags","available_tags"],"query":[{"key":"project_id","value":"","disabled":false,"description":"Project id in the authenticated company."}]},"description":"List project photo tags with visible assignments\n\nRequires photos:read and Photos view permission in the specified project. Includes a live catalog tag when at least one photo currently visible to the caller uses it."}},{"id":"2fbff073-d644-4011-8450-fa09e76fcaa5","name":"deleteImageTag — Delete a project photo tag","request":{"method":"DELETE","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/image_tags/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","image_tags",":id"],"query":[{"key":"project_id","value":"","disabled":false,"description":"Project id in the authenticated company."}],"variable":[{"key":"id","value":"","description":"Live photo tag id in the specified project."}]},"description":"Delete a project photo tag\n\nRequires photos:write and Photos delete permission in the specified project. Soft-deletes a live catalog tag in the project and removes its assignments across project photos, including private or deleted photos."}},{"id":"a03c27bf-031d-4a72-8a1a-f4f6dcaf5be0","name":"listImages — List images","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/images","host":["{{baseUrl}}"],"path":["rest","v1.0","images"],"query":[{"key":"project_id","value":"","disabled":false},{"key":"image_category_id","value":"","disabled":true},{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true},{"key":"filters[daily_log_segment_id]","value":"","disabled":true},{"key":"filters[log_date]","value":"","disabled":true},{"key":"filters[private]","value":"","disabled":true},{"key":"filters[starred]","value":"","disabled":true},{"key":"filters[location_id]","value":"","disabled":true},{"key":"filters[include_sublocations]","value":"","disabled":true},{"key":"filters[trade_ids]","value":"","disabled":true},{"key":"filters[projection]","value":"","disabled":true},{"key":"filters[query]","value":"","disabled":true},{"key":"filters[created_at]","value":"","disabled":true},{"key":"filters[updated_at]","value":"","disabled":true},{"key":"filters[uploader_id]","value":"","disabled":true},{"key":"filters[id]","value":"","disabled":true},{"key":"sort","value":"","disabled":true},{"key":"serializer_view","value":"","disabled":true}]},"description":"List images"}},{"id":"0cea8ca8-350a-4d55-81d8-d828623e7684","name":"createImage — Create image","request":{"method":"POST","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/images","host":["{{baseUrl}}"],"path":["rest","v1.0","images"],"query":[{"key":"project_id","value":"","disabled":false}]},"description":"Create image","body":{"mode":"raw","raw":"{\n  \"image\": {},\n  \"image_name\": \"\",\n  \"source_image_id\": 0,\n  \"upload_uuid\": \"\"\n}","options":{"raw":{"language":"json"}}}}},{"id":"5c40fdd9-1a91-45f3-896f-4d373a8ec81d","name":"getImage — Show image","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/images/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","images",":id"],"query":[{"key":"project_id","value":"","disabled":false}],"variable":[{"key":"id","value":""}]},"description":"Show image"}},{"id":"d215f40c-2f8f-42fd-8444-b9121dbf3b02","name":"updateImage — Update image","request":{"method":"PATCH","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/images/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","images",":id"],"query":[{"key":"project_id","value":"","disabled":false}],"variable":[{"key":"id","value":""}]},"description":"Update image","body":{"mode":"raw","raw":"{\n  \"image\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"4ac736d0-a66e-47e2-83fc-938d796ba773","name":"deleteImage — Delete image","request":{"method":"DELETE","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/images/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","images",":id"],"query":[{"key":"project_id","value":"","disabled":false},{"key":"permanent","value":"","disabled":true}],"variable":[{"key":"id","value":""}]},"description":"Delete image"}},{"id":"4e8f835b-46af-43d4-8770-3c59a0e0c17a","name":"listImageAnnotations — List photo annotations (markup)","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/images/:id/annotations","host":["{{baseUrl}}"],"path":["rest","v1.0","images",":id","annotations"],"query":[{"key":"project_id","value":"","disabled":false}],"variable":[{"key":"id","value":""}]},"description":"List photo annotations (markup)"}},{"id":"8227a21f-dc33-4489-8903-7059ae016862","name":"createImageAnnotation — Create a photo annotation (markup)","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/images/:id/annotations","host":["{{baseUrl}}"],"path":["rest","v1.0","images",":id","annotations"],"query":[{"key":"project_id","value":"","disabled":false}],"variable":[{"key":"id","value":""}]},"description":"Create a photo annotation (markup)","body":{"mode":"raw","raw":"{\n  \"annotation\": {\n    \"note\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"1e535753-d8c9-41b8-8e3d-0697288ad21d","name":"deleteImageAnnotation — Delete a photo annotation","request":{"method":"DELETE","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/images/:id/annotations/:annotation_id","host":["{{baseUrl}}"],"path":["rest","v1.0","images",":id","annotations",":annotation_id"],"query":[{"key":"project_id","value":"","disabled":false}],"variable":[{"key":"id","value":""},{"key":"annotation_id","value":""}]},"description":"Delete a photo annotation"}},{"id":"058789f8-48a2-46c8-89a7-7761d6e519f7","name":"listImageComments — List comments on a photo","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/images/:id/comments","host":["{{baseUrl}}"],"path":["rest","v1.0","images",":id","comments"],"query":[{"key":"project_id","value":"","disabled":false,"description":"Project id in the authenticated company."},{"key":"page","value":"1","disabled":true,"description":"One-based comment page number."},{"key":"per_page","value":"100","disabled":true,"description":"Requested comment page size."}],"variable":[{"key":"id","value":"","description":"Photo id in the project."}]},"description":"List comments on a photo\n\nRequires photos:read and Photos view permission in the specified project. The photo and its album must be visible to the caller. Private photos or albums require Photos admin access. Returns live comments in chronological order, with ascending id breaking timestamp ties."}},{"id":"60e08ca1-f964-4658-8575-930dd7dda756","name":"createImageComment — Add a comment to a photo","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/images/:id/comments","host":["{{baseUrl}}"],"path":["rest","v1.0","images",":id","comments"],"query":[{"key":"project_id","value":"","disabled":false,"description":"Project id in the authenticated company."}],"variable":[{"key":"id","value":"","description":"Photo id in the project."}]},"description":"Add a comment to a photo\n\nRequires photos:write and Photos edit permission in the specified project. The photo and its album must be visible to the caller. Private photos or albums require Photos admin access. Creates a comment authored by the authenticated caller.","body":{"mode":"raw","raw":"{\n  \"comment\": {\n    \"body\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"663a9433-0bb9-4e9b-840c-6acce21d79f5","name":"deleteImageComment — Delete a photo comment","request":{"method":"DELETE","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/images/:id/comments/:comment_id","host":["{{baseUrl}}"],"path":["rest","v1.0","images",":id","comments",":comment_id"],"query":[{"key":"project_id","value":"","disabled":false,"description":"Project id in the authenticated company."}],"variable":[{"key":"id","value":"","description":"Photo id in the project."},{"key":"comment_id","value":"","description":"Live comment id on the specified photo."}]},"description":"Delete a photo comment\n\nRequires photos:write and Photos delete permission in the specified project. The photo and its album must be visible to the caller. Private photos or albums require Photos admin access. Soft-deletes a live comment on the specified photo."}},{"id":"7439182d-90ac-417b-8db7-4b3b2018e844","name":"listImageTagsGet — List tags assigned to a photo","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/images/:id/tags","host":["{{baseUrl}}"],"path":["rest","v1.0","images",":id","tags"],"query":[{"key":"project_id","value":"","disabled":false,"description":"Project id in the authenticated company."}],"variable":[{"key":"id","value":"","description":"Photo id in the project."}]},"description":"List tags assigned to a photo\n\nRequires photos:read and Photos view permission in the specified project. The photo and its album must be visible to the caller. Private photos or albums require Photos admin access."}},{"id":"b30aa3e5-9231-4713-8cb0-2c2a4bd9adcc","name":"createImageTagPost — Assign a tag to a photo","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/images/:id/tags","host":["{{baseUrl}}"],"path":["rest","v1.0","images",":id","tags"],"query":[{"key":"project_id","value":"","disabled":false,"description":"Project id in the authenticated company."}],"variable":[{"key":"id","value":"","description":"Photo id in the project."}]},"description":"Assign a tag to a photo\n\nRequires photos:write and Photos edit permission in the specified project. The photo and its album must be visible to the caller. Private photos or albums require Photos admin access. Specify a live tag id in the project or provide a name to find or create the tag. A supplied id takes precedence. Repeating an assignment preserves a single link.","body":{"mode":"raw","raw":"{\n  \"tag_id\": 0\n}","options":{"raw":{"language":"json"}}}}},{"id":"09988126-8053-49df-802e-0e153576efbf","name":"deleteImageTagDelete — Remove a tag assignment from a photo","request":{"method":"DELETE","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/images/:id/tags/:tag_id","host":["{{baseUrl}}"],"path":["rest","v1.0","images",":id","tags",":tag_id"],"query":[{"key":"project_id","value":"","disabled":false,"description":"Project id in the authenticated company."}],"variable":[{"key":"id","value":"","description":"Photo id in the project."},{"key":"tag_id","value":"","description":"Catalog tag id to detach from the photo."}]},"description":"Remove a tag assignment from a photo\n\nRequires photos:write and Photos edit permission in the specified project. The photo and its album must be visible to the caller. Private photos or albums require Photos admin access. Removes the tag from this photo and preserves the catalog tag. An already absent assignment leaves the current tag list intact."}}]},{"name":"Portfolio","description":"Module: portfolio","item":[{"id":"167045df-89f0-4788-86a7-336d06f8b4b1","name":"listCompanyPortfolio — Company portfolio roll-up","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/portfolio","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","portfolio"],"variable":[{"key":"company_id","value":"{{companyId}}"}]},"description":"Company portfolio roll-up"}},{"id":"f9029ef8-3856-41ee-87db-adf7c368f8ae","name":"listCompanyPrograms — List programs","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/programs","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","programs"],"variable":[{"key":"company_id","value":"{{companyId}}"}]},"description":"List programs"}},{"id":"a8dcb62d-bd85-4fec-8d38-66f24e1326a3","name":"createCompanyProgram — Create a program","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/programs","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","programs"],"variable":[{"key":"company_id","value":"{{companyId}}"}]},"description":"Create a program"}},{"id":"4e25529d-0f60-49f3-81fc-f8a4b05c5660","name":"getCompanyProgram — Show a program","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/programs/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","programs",":id"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Show a program"}},{"id":"6879ba1c-831b-4f5e-8b74-f87da2687310","name":"updateCompanyProgram — Update a program","request":{"method":"PATCH","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/programs/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","programs",":id"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Update a program"}},{"id":"9b0a52ff-430b-4d12-8234-96c9616575fe","name":"deleteCompanyProgram — Delete a program","request":{"method":"DELETE","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/programs/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","programs",":id"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Delete a program"}}]},{"name":"Prequalification","description":"Module: prequalification","item":[{"id":"b3fd0c60-47e9-4c52-8444-5ff817011b3f","name":"listProjectPrequalificationQuestionnaires — List prequalification questionnaires available to a project","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/prequalification/questionnaires","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","prequalification","questionnaires"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"List prequalification questionnaires available to a project"}},{"id":"879a68f6-dead-451c-858b-d3d826d12807","name":"createProjectPrequalificationQuestionnaire — Create a prequalification questionnaire","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/prequalification/questionnaires","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","prequalification","questionnaires"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Create a prequalification questionnaire"}},{"id":"c5d363af-41ae-41ed-8bd7-3b7677d0e0e4","name":"getProjectPrequalificationQuestionnaire — Show a prequalification questionnaire","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/prequalification/questionnaires/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","prequalification","questionnaires",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Show a prequalification questionnaire"}},{"id":"e25f72d6-53b2-4c1b-821c-e17aa77a8c8d","name":"updateProjectPrequalificationQuestionnaire — Update a prequalification questionnaire","request":{"method":"PATCH","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/prequalification/questionnaires/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","prequalification","questionnaires",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Update a prequalification questionnaire"}},{"id":"ba75ea40-ef33-49c0-8238-65a0e0f229d0","name":"deleteProjectPrequalificationQuestionnaire — Delete questionnaire","request":{"method":"DELETE","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/prequalification/questionnaires/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","prequalification","questionnaires",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Delete questionnaire"}},{"id":"b75ae79a-715b-4b5a-82ec-3e08612fb562","name":"listProjectPrequalificationSubmissions — List prequalification submissions on a project","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/prequalification/submissions","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","prequalification","submissions"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"List prequalification submissions on a project"}},{"id":"100cdf76-1c77-4a4a-8193-8c2ffdea44c5","name":"createProjectPrequalificationSubmission — Invite a vendor to prequalify (create submission)","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/prequalification/submissions","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","prequalification","submissions"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Invite a vendor to prequalify (create submission)"}},{"id":"be4a19dd-03a4-4eb1-8044-d8553c4c40f4","name":"getProjectPrequalificationSubmission — Show a prequalification submission","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/prequalification/submissions/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","prequalification","submissions",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Show a prequalification submission"}},{"id":"b8bb1e18-e364-40f4-8cd9-a81fc77efe8b","name":"updateProjectPrequalificationSubmission — Update a prequalification submission","request":{"method":"PATCH","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/prequalification/submissions/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","prequalification","submissions",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Update a prequalification submission"}},{"id":"af150f08-ba40-47cb-8443-b59368473cdf","name":"deleteProjectPrequalificationSubmission — Delete submission","request":{"method":"DELETE","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/prequalification/submissions/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","prequalification","submissions",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Delete submission"}},{"id":"ec2192fa-a6ca-4298-89d2-619fb0be8fd2","name":"recordProjectPrequalificationSubmission — Record received answers (staff action; local extension)","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/prequalification/submissions/:id/record","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","prequalification","submissions",":id","record"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Record received answers (staff action; local extension)","body":{"mode":"raw","raw":"{\n  \"prequal_submission\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"ee86c39f-7811-4fec-804f-6b3b595bda2d","name":"reviewProjectPrequalificationSubmission — Review a submission (approve/reject with score)","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/prequalification/submissions/:id/review","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","prequalification","submissions",":id","review"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Review a submission (approve/reject with score)"}}]},{"name":"Prime Contracts","description":"Module: prime_contracts","item":[{"id":"48dc69ab-f1cd-4669-8ea9-a7ffbbe4d1b7","name":"listPrimeContract — Show First Prime Contract","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/prime_contract","host":["{{baseUrl}}"],"path":["rest","v1.0","prime_contract"],"query":[{"key":"project_id","value":"","disabled":false}]},"description":"Show First Prime Contract"}},{"id":"9c5fcb35-ee95-4436-8109-136401eb18cd","name":"createPrimeContract — Create Prime Contract","request":{"method":"POST","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/prime_contract","host":["{{baseUrl}}"],"path":["rest","v1.0","prime_contract"],"query":[{"key":"run_configurable_validations","value":"","disabled":true}]},"description":"Create Prime Contract","body":{"mode":"raw","raw":"{\n  \"attachments\": [\n    \"\"\n  ],\n  \"prime_contract\": {},\n  \"project_id\": 0\n}","options":{"raw":{"language":"json"}}}}},{"id":"22d9557e-1f79-4b50-89e2-15f80d544e1f","name":"getPrimeContract — Show Prime Contract","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/prime_contract/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","prime_contract",":id"],"query":[{"key":"project_id","value":"","disabled":false}],"variable":[{"key":"id","value":""}]},"description":"Show Prime Contract"}},{"id":"08cbcf39-fb8d-468e-8508-97767a6ebfb1","name":"updatePrimeContract — Update Prime Contract","request":{"method":"PATCH","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/prime_contract/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","prime_contract",":id"],"query":[{"key":"run_configurable_validations","value":"","disabled":true}],"variable":[{"key":"id","value":""}]},"description":"Update Prime Contract","body":{"mode":"raw","raw":"{\n  \"attachments\": [\n    \"\"\n  ],\n  \"prime_contract\": {},\n  \"project_id\": 0\n}","options":{"raw":{"language":"json"}}}}},{"id":"30971121-70a0-46f1-8cf2-41a96f6f861d","name":"deletePrimeContract — Delete Prime Contract","request":{"method":"DELETE","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/prime_contract/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","prime_contract",":id"],"query":[{"key":"project_id","value":"","disabled":false}],"variable":[{"key":"id","value":""}]},"description":"Delete Prime Contract"}},{"id":"c5d14cee-bd8a-4716-8c6c-6d728c5fdb51","name":"listPrimeContracts — List all Prime Contracts","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/prime_contracts","host":["{{baseUrl}}"],"path":["rest","v1.0","prime_contracts"],"query":[{"key":"project_id","value":"","disabled":false},{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true},{"key":"filters[id]","value":"","disabled":true},{"key":"filters[updated_at]","value":"","disabled":true}]},"description":"List all Prime Contracts"}},{"id":"286c9bc6-dc84-463f-8796-5a6c62a60f92","name":"listPrimeContractLineItems — List Prime Contract line items","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/prime_contracts/:prime_contract_id/line_items","host":["{{baseUrl}}"],"path":["rest","v1.0","prime_contracts",":prime_contract_id","line_items"],"query":[{"key":"project_id","value":"","disabled":false},{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true},{"key":"filters[id]","value":"","disabled":true},{"key":"filters[created_at]","value":"","disabled":true},{"key":"filters[updated_at]","value":"","disabled":true},{"key":"filters[cost_code_id]","value":"","disabled":true},{"key":"filters[line_item_type_id]","value":"","disabled":true}],"variable":[{"key":"prime_contract_id","value":""}]},"description":"List Prime Contract line items"}},{"id":"36fe1d07-ac02-449b-893f-a467df3cc6e9","name":"createPrimeContractLineItem — Create Prime Contract line item","request":{"method":"POST","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/prime_contracts/:prime_contract_id/line_items","host":["{{baseUrl}}"],"path":["rest","v1.0","prime_contracts",":prime_contract_id","line_items"],"query":[{"key":"project_id","value":"","disabled":false}],"variable":[{"key":"prime_contract_id","value":""}]},"description":"Create Prime Contract line item","body":{"mode":"raw","raw":"{\n  \"line_item\": {},\n  \"project_id\": 0\n}","options":{"raw":{"language":"json"}}}}},{"id":"b8ce0413-ab27-4cfb-8666-96a4f9deef33","name":"updatePrimeContractLineItemsSync — Sync Prime Contract Line Items","request":{"method":"PATCH","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/prime_contracts/:prime_contract_id/line_items/sync","host":["{{baseUrl}}"],"path":["rest","v1.0","prime_contracts",":prime_contract_id","line_items","sync"],"query":[{"key":"project_id","value":"","disabled":false}],"variable":[{"key":"prime_contract_id","value":""}]},"description":"Sync Prime Contract Line Items","body":{"mode":"raw","raw":"{\n  \"updates\": [\n    {}\n  ]\n}","options":{"raw":{"language":"json"}}}}},{"id":"db9222b1-cb15-48bb-80bb-09d61f6610d0","name":"getPrimeContractLineItem — Show Prime Contract line item","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/prime_contracts/:prime_contract_id/line_items/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","prime_contracts",":prime_contract_id","line_items",":id"],"query":[{"key":"project_id","value":"","disabled":false}],"variable":[{"key":"prime_contract_id","value":""},{"key":"id","value":""}]},"description":"Show Prime Contract line item"}},{"id":"d7104012-b9ef-47c9-82e5-080a0466299b","name":"updatePrimeContractLineItem — Update Prime Contract line item","request":{"method":"PATCH","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/prime_contracts/:prime_contract_id/line_items/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","prime_contracts",":prime_contract_id","line_items",":id"],"query":[{"key":"project_id","value":"","disabled":false}],"variable":[{"key":"prime_contract_id","value":""},{"key":"id","value":""}]},"description":"Update Prime Contract line item","body":{"mode":"raw","raw":"{\n  \"line_item\": {},\n  \"project_id\": 0\n}","options":{"raw":{"language":"json"}}}}},{"id":"ab0bd1c6-5931-4a4d-8043-d227755c2267","name":"deletePrimeContractLineItem — Delete a Prime Contract line item","request":{"method":"DELETE","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/prime_contracts/:prime_contract_id/line_items/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","prime_contracts",":prime_contract_id","line_items",":id"],"query":[{"key":"project_id","value":"","disabled":false}],"variable":[{"key":"prime_contract_id","value":""},{"key":"id","value":""}]},"description":"Delete a Prime Contract line item"}},{"id":"9ac48f09-68b9-4f50-821f-072a916e0968","name":"updatePrimeContractPaymentApplicationLineItem — Update Payment Application (Owner Invoice) Line Item for Prime Contract","request":{"method":"PATCH","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/prime_contracts/:prime_contract_id/payment_application_line_items/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","prime_contracts",":prime_contract_id","payment_application_line_items",":id"],"variable":[{"key":"prime_contract_id","value":""},{"key":"id","value":""}]},"description":"Update Payment Application (Owner Invoice) Line Item for Prime Contract","body":{"mode":"raw","raw":"{\n  \"payment_application_line_item\": {},\n  \"project_id\": 0\n}","options":{"raw":{"language":"json"}}}}},{"id":"9f3520b4-3fc7-46ea-8690-a6458190936e","name":"listPrimeContractPaymentApplications — List Payment Applications (Owner Invoices) for Prime Contract","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/prime_contracts/:prime_contract_id/payment_applications","host":["{{baseUrl}}"],"path":["rest","v1.0","prime_contracts",":prime_contract_id","payment_applications"],"query":[{"key":"project_id","value":"","disabled":false},{"key":"filters[id]","value":"","disabled":true},{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true},{"key":"filters[is_last]","value":"","disabled":true}],"variable":[{"key":"prime_contract_id","value":""}]},"description":"List Payment Applications (Owner Invoices) for Prime Contract"}},{"id":"0794aa3d-b59d-42ec-85dd-29a2f29c76e4","name":"createPrimeContractPaymentApplication — Create Payment Application (Owner Invoice) for Prime Contract","request":{"method":"POST","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/prime_contracts/:prime_contract_id/payment_applications","host":["{{baseUrl}}"],"path":["rest","v1.0","prime_contracts",":prime_contract_id","payment_applications"],"variable":[{"key":"prime_contract_id","value":""}]},"description":"Create Payment Application (Owner Invoice) for Prime Contract","body":{"mode":"raw","raw":"{\n  \"attachments\": [\n    \"\"\n  ],\n  \"payment_application\": {},\n  \"project_id\": 0\n}","options":{"raw":{"language":"json"}}}}},{"id":"60981f29-94f0-4f48-8406-a73bb369c402","name":"getPrimeContractPaymentApplication — Get prime contract payment application","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/prime_contracts/:prime_contract_id/payment_applications/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","prime_contracts",":prime_contract_id","payment_applications",":id"],"variable":[{"key":"prime_contract_id","value":""},{"key":"id","value":""}]},"description":"Get prime contract payment application\n\nRequires the `view` permission on the project's prime contracts tool. A scoped API token needs `prime_contracts:read`.","body":{"mode":"raw","raw":"{\n  \"payment_application\": {},\n  \"project_id\": 0\n}","options":{"raw":{"language":"json"}}}}},{"id":"261796c9-ea66-4a63-809d-57a590d2f6b3","name":"updatePrimeContractPaymentApplication — Update Payment Application (Owner Invoice) for Prime Contract","request":{"method":"PATCH","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/prime_contracts/:prime_contract_id/payment_applications/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","prime_contracts",":prime_contract_id","payment_applications",":id"],"variable":[{"key":"prime_contract_id","value":""},{"key":"id","value":""}]},"description":"Update Payment Application (Owner Invoice) for Prime Contract","body":{"mode":"raw","raw":"{\n  \"attachments\": [\n    \"\"\n  ],\n  \"payment_application\": {},\n  \"project_id\": 0\n}","options":{"raw":{"language":"json"}}}}},{"id":"a104332e-7dac-41a0-8c24-6832c827a9b3","name":"deletePrimeContractPaymentApplication — Delete prime contract payment application","request":{"method":"DELETE","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/prime_contracts/:prime_contract_id/payment_applications/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","prime_contracts",":prime_contract_id","payment_applications",":id"],"variable":[{"key":"prime_contract_id","value":""},{"key":"id","value":""}]},"description":"Delete prime contract payment application"}},{"id":"7a98e171-b8db-486d-8783-279001d8e5e3","name":"listProjectContractPayments — List contract payments","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/contract_payments","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","contract_payments"],"query":[{"key":"page","value":"1","disabled":true,"description":"Page number, starting at 1."},{"key":"per_page","value":"100","disabled":true,"description":"Records per page."}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"List contract payments\n\nRequires the `view` permission on the project's payment applications tool. A scoped API token needs `payment_applications:read`.","body":{"mode":"raw","raw":"{\n  \"contract_payment\": {\n    \"amount\": \"\",\n    \"contract_id\": 0,\n    \"contract_type\": \"PrimeContract\",\n    \"paid_at\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"ba0cd4e7-c5f1-4819-8e2f-625d8b5da845","name":"createProjectContractPayment — Create contract payment","request":{"method":"POST","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/contract_payments","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","contract_payments"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Create contract payment"}},{"id":"41cedb26-beea-47cc-8ebf-e8c7ab0316d4","name":"listProjectContractPaymentsReconciliation — Get reconciliation","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/contract_payments/reconciliation","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","contract_payments","reconciliation"],"query":[{"key":"invoice_type","value":"","disabled":true},{"key":"page","value":"1","disabled":true,"description":"Page number, starting at 1."},{"key":"per_page","value":"100","disabled":true,"description":"Records per page."}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Get reconciliation\n\nRequires the `view` permission on the project's payment applications tool. A scoped API token needs `payment_applications:read`."}},{"id":"176cd52a-578d-4506-8148-a22a888308e0","name":"getProjectContractPayment — Get contract payment","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/contract_payments/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","contract_payments",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Get contract payment\n\nRequires the `view` permission on the project's payment applications tool. A scoped API token needs `payment_applications:read`."}},{"id":"75d8cccd-ca5d-4116-8262-4ccfef0bab56","name":"listProjectContractPaymentAllocations — List contract payment allocations","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/contract_payments/:id/allocations","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","contract_payments",":id","allocations"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"List contract payment allocations\n\nRequires the `view` permission on the project's payment applications tool. A scoped API token needs `payment_applications:read`.","body":{"mode":"raw","raw":"{\n  \"allocation\": {\n    \"allocated_at\": \"\",\n    \"amount\": \"\",\n    \"invoice_id\": 0,\n    \"invoice_type\": \"PaymentApplication\",\n    \"request_key\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"dee7a278-daaf-4428-89bb-6980d9b491c5","name":"createProjectContractPaymentAllocation — Create contract payment allocation","request":{"method":"POST","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/contract_payments/:id/allocations","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","contract_payments",":id","allocations"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Create contract payment allocation"}},{"id":"3cf2ffd7-c112-4775-8e34-2f9288f3db52","name":"releaseProjectContractPaymentAllocation — Release allocation","request":{"method":"POST","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/contract_payments/:id/allocations/:allocation_id/release","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","contract_payments",":id","allocations",":allocation_id","release"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""},{"key":"allocation_id","value":""}]},"description":"Release allocation"}},{"id":"37b650c0-8b5c-4499-8b61-844b0a6eddff","name":"refundProjectContractPayment — Refund contract payment","request":{"method":"POST","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/contract_payments/:id/refund","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","contract_payments",":id","refund"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Refund contract payment"}},{"id":"bffe3574-4a36-47e6-81de-82f5a1796cb6","name":"reverseProjectContractPayment — Reverse contract payment","request":{"method":"POST","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/contract_payments/:id/reverse","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","contract_payments",":id","reverse"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Reverse contract payment"}},{"id":"bb4882fe-f60b-4cdd-8dda-fffd5e408467","name":"listCompanyProjectPrimeContractsV20 — List Prime Contracts","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v2.0/companies/:company_id/projects/:project_id/prime_contracts","host":["{{baseUrl}}"],"path":["rest","v2.0","companies",":company_id","projects",":project_id","prime_contracts"],"query":[{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true},{"key":"filters[contractor_id]","value":"","disabled":true},{"key":"filters[id]","value":"","disabled":true},{"key":"filters[status]","value":"","disabled":true},{"key":"filters[updated_at]","value":"","disabled":true},{"key":"filters[vendor_id]","value":"","disabled":true},{"key":"filters[executed]","value":"","disabled":true}],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"project_id","value":"{{projectId}}"}]},"description":"List Prime Contracts\n\nList the project's prime contracts the caller can see. Same resource, service and checks as the v1.0 prime contract routes (contract privacy, SOV visibility, billing locks, capabilities), with company and project in the path and a `{ data }` envelope."}},{"id":"ea67fb3a-c9b5-4b74-806d-7c5929550f39","name":"createCompanyProjectPrimeContractV20 — Create Prime Contract","request":{"method":"POST","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v2.0/companies/:company_id/projects/:project_id/prime_contracts","host":["{{baseUrl}}"],"path":["rest","v2.0","companies",":company_id","projects",":project_id","prime_contracts"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"project_id","value":"{{projectId}}"}]},"description":"Create Prime Contract\n\nCreate a prime contract. Same resource, service and checks as the v1.0 prime contract routes (contract privacy, SOV visibility, billing locks, capabilities), with company and project in the path and a `{ data }` envelope.","body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}}}},{"id":"4712d527-c2f4-4b35-83d7-61e16ebcfb8f","name":"listCompanyProjectPrimeContractSummaryV20 — Show Prime Contract Summary","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v2.0/companies/:company_id/projects/:project_id/prime_contracts/:contract_id/summary","host":["{{baseUrl}}"],"path":["rest","v2.0","companies",":company_id","projects",":project_id","prime_contracts",":contract_id","summary"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"project_id","value":"{{projectId}}"},{"key":"contract_id","value":""}]},"description":"Show Prime Contract Summary\n\nFinancial summary of a prime contract the caller can see. Amounts are decimal strings with two places. Tax amounts and currency configuration are not tracked separately and are not returned."}},{"id":"c10cc7d3-00b1-4fbb-8116-38f014522baf","name":"getCompanyProjectPrimeContractV20 — Show Prime Contract","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v2.0/companies/:company_id/projects/:project_id/prime_contracts/:prime_contract_id","host":["{{baseUrl}}"],"path":["rest","v2.0","companies",":company_id","projects",":project_id","prime_contracts",":prime_contract_id"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"project_id","value":"{{projectId}}"},{"key":"prime_contract_id","value":""}]},"description":"Show Prime Contract\n\nShow a prime contract. Same resource, service and checks as the v1.0 prime contract routes (contract privacy, SOV visibility, billing locks, capabilities), with company and project in the path and a `{ data }` envelope."}},{"id":"887a97b3-753b-45e3-8cd3-8f977a7894cc","name":"updateCompanyProjectPrimeContractV20 — Update Prime Contract","request":{"method":"PATCH","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v2.0/companies/:company_id/projects/:project_id/prime_contracts/:prime_contract_id","host":["{{baseUrl}}"],"path":["rest","v2.0","companies",":company_id","projects",":project_id","prime_contracts",":prime_contract_id"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"project_id","value":"{{projectId}}"},{"key":"prime_contract_id","value":""}]},"description":"Update Prime Contract\n\nUpdate a prime contract (only the fields sent change). Same resource, service and checks as the v1.0 prime contract routes (contract privacy, SOV visibility, billing locks, capabilities), with company and project in the path and a `{ data }` envelope.","body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}}}},{"id":"b8be67d8-4d11-41e5-8afc-50698e6aeaad","name":"deleteCompanyProjectPrimeContractV20 — Delete Prime Contract","request":{"method":"DELETE","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v2.0/companies/:company_id/projects/:project_id/prime_contracts/:prime_contract_id","host":["{{baseUrl}}"],"path":["rest","v2.0","companies",":company_id","projects",":project_id","prime_contracts",":prime_contract_id"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"project_id","value":"{{projectId}}"},{"key":"prime_contract_id","value":""}]},"description":"Delete Prime Contract\n\nSoft-delete a prime contract. Refused (409) while billing is allocated against it. Same resource, service and checks as the v1.0 prime contract routes (contract privacy, SOV visibility, billing locks, capabilities), with company and project in the path and a `{ data }` envelope."}},{"id":"9e30c065-25f7-417e-80d9-4fb27b228cbf","name":"listCompanyProjectPrimeContractAttachmentsV20 — List Prime Contract Attachments","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v2.0/companies/:company_id/projects/:project_id/prime_contracts/:prime_contract_id/attachments","host":["{{baseUrl}}"],"path":["rest","v2.0","companies",":company_id","projects",":project_id","prime_contracts",":prime_contract_id","attachments"],"query":[{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true}],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"project_id","value":"{{projectId}}"},{"key":"prime_contract_id","value":""}]},"description":"List Prime Contract Attachments\n\nAttachments of a prime contract the caller can see (paginated)."}},{"id":"f994e93e-1b98-4d66-8ebe-e344ab07cb26","name":"listCompanyProjectPrimeContractLineItemsV20 — List Prime Contract Line Items","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v2.0/companies/:company_id/projects/:project_id/prime_contracts/:prime_contract_id/line_items","host":["{{baseUrl}}"],"path":["rest","v2.0","companies",":company_id","projects",":project_id","prime_contracts",":prime_contract_id","line_items"],"query":[{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true}],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"project_id","value":"{{projectId}}"},{"key":"prime_contract_id","value":""}]},"description":"List Prime Contract Line Items\n\nSchedule of values lines of a prime contract (needs SOV visibility). Same resource, service and checks as the v1.0 prime contract routes (contract privacy, SOV visibility, billing locks, capabilities), with company and project in the path and a `{ data }` envelope."}},{"id":"206d7681-1e24-47e8-8bf5-7acbf5857ca6","name":"createCompanyProjectPrimeContractLineItemV20 — Create Prime Contract Line Item","request":{"method":"POST","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v2.0/companies/:company_id/projects/:project_id/prime_contracts/:prime_contract_id/line_items","host":["{{baseUrl}}"],"path":["rest","v2.0","companies",":company_id","projects",":project_id","prime_contracts",":prime_contract_id","line_items"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"project_id","value":"{{projectId}}"},{"key":"prime_contract_id","value":""}]},"description":"Create Prime Contract Line Item\n\nAdd a schedule of values line. Same resource, service and checks as the v1.0 prime contract routes (contract privacy, SOV visibility, billing locks, capabilities), with company and project in the path and a `{ data }` envelope.","body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}}}},{"id":"71c4718c-28ae-4571-8179-186a1831699f","name":"getCompanyProjectPrimeContractLineItemV20 — Show Prime Contract Line Item","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v2.0/companies/:company_id/projects/:project_id/prime_contracts/:prime_contract_id/line_items/:id","host":["{{baseUrl}}"],"path":["rest","v2.0","companies",":company_id","projects",":project_id","prime_contracts",":prime_contract_id","line_items",":id"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"project_id","value":"{{projectId}}"},{"key":"prime_contract_id","value":""},{"key":"id","value":""}]},"description":"Show Prime Contract Line Item"}},{"id":"15fe5e4a-1252-4761-8886-9dc9f95274e6","name":"updateCompanyProjectPrimeContractLineItemV20 — Update Prime Contract Line Item","request":{"method":"PATCH","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v2.0/companies/:company_id/projects/:project_id/prime_contracts/:prime_contract_id/line_items/:id","host":["{{baseUrl}}"],"path":["rest","v2.0","companies",":company_id","projects",":project_id","prime_contracts",":prime_contract_id","line_items",":id"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"project_id","value":"{{projectId}}"},{"key":"prime_contract_id","value":""},{"key":"id","value":""}]},"description":"Update Prime Contract Line Item","body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}}}},{"id":"1492e09f-83f7-4e24-87c5-12f6c83b0c6e","name":"deleteCompanyProjectPrimeContractLineItemV20 — Delete Prime Contract Line Item","request":{"method":"DELETE","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v2.0/companies/:company_id/projects/:project_id/prime_contracts/:prime_contract_id/line_items/:id","host":["{{baseUrl}}"],"path":["rest","v2.0","companies",":company_id","projects",":project_id","prime_contracts",":prime_contract_id","line_items",":id"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"project_id","value":"{{projectId}}"},{"key":"prime_contract_id","value":""},{"key":"id","value":""}]},"description":"Delete Prime Contract Line Item"}},{"id":"57fb4fed-2ea0-4bed-8ff6-9de9d2811756","name":"listCompanyProjectPrimeContractPdfV20 — Download prime contract PDF","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v2.0/companies/:company_id/projects/:project_id/prime_contracts/:prime_contract_id/pdf","host":["{{baseUrl}}"],"path":["rest","v2.0","companies",":company_id","projects",":project_id","prime_contracts",":prime_contract_id","pdf"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"project_id","value":"{{projectId}}"},{"key":"prime_contract_id","value":""}]},"description":"Download prime contract PDF\n\nThe prime contract as a PDF (general information, parties, dates, schedule of values), generated synchronously."}}]},{"name":"Project Archive","description":"Module: project_archive","item":[{"id":"4ad78c8b-3363-41a6-86de-a3b007f93e79","name":"listProjectDataExports — List project data exports","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/data_exports","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","data_exports"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"List project data exports"}},{"id":"73c6d83d-0425-4967-8d0b-2944549abec0","name":"createProjectDataExport — Create (generate) a data export","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/data_exports","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","data_exports"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Create (generate) a data export"}},{"id":"d58f4a65-20d5-4f54-8eb6-7c5c94e4744b","name":"getProjectDataExport — Show a data export","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/data_exports/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","data_exports",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Show a data export"}},{"id":"c11fa679-c8b2-45f2-8992-b0e487aef55c","name":"createProjectDataExportPost — Create data export","request":{"method":"POST","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/data_exports/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","data_exports",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Create data export"}},{"id":"aad6487f-8d37-44e5-8d9c-d9e40b89b241","name":"deleteProjectDataExport — Delete data export","request":{"method":"DELETE","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/data_exports/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","data_exports",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Delete data export"}},{"id":"5888e6a8-3ccb-41db-88a9-e6539643cb4b","name":"listProjectDataExportDownload — Download data export","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/data_exports/:id/download","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","data_exports",":id","download"],"query":[{"key":"format","value":"","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Download data export"}}]},{"name":"Punch List","description":"Module: punch_list","item":[{"id":"c68372d9-7e0b-4b6c-8c85-8b2be9f45d90","name":"listProjectAvailablePunchItemManagers — List Punch List Manager options","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/available_punch_item_managers","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","available_punch_item_managers"],"query":[{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true},{"key":"query","value":"","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"List Punch List Manager options"}},{"id":"4d86d6cb-84a3-45c0-8568-357b8eec1913","name":"getProjectPunchItemAssignment — Show Punch Assignment","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/punch_item_assignments/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","punch_item_assignments",":id"],"variable":[{"key":"id","value":""},{"key":"project_id","value":"{{projectId}}"}]},"description":"Show Punch Assignment"}},{"id":"d706caa2-8ec3-4abb-86af-d58f67aa253c","name":"updateProjectPunchItemAssignment — Update Punch Item Assignment","request":{"method":"PATCH","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/punch_item_assignments/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","punch_item_assignments",":id"],"variable":[{"key":"id","value":""},{"key":"project_id","value":"{{projectId}}"}]},"description":"Update Punch Item Assignment\n\nRecord an assignee's response: status (unresolved, ready_for_review, resolved) and comment. Only the assignee (or a same-company peer with the respond grant, or a punch list admin) may respond, while the punch item is in a responding state. When every assignee has responded the item moves to ready_for_review. Manager acceptance (approved) and reassignment (login_information_id) are item-level: PATCH /rest/v1.0/punch_items/{id}; sending them here returns 422.","body":{"mode":"raw","raw":"{\n  \"punch_item_assignment\": {},\n  \"send_emails\": \"\"\n}","options":{"raw":{"language":"json"}}}}},{"id":"5271da34-aca2-42cd-8e9e-7e3571d8fdae","name":"listProjectPunchItemTemplates — List Project Punch Item Templates","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/punch_item_templates","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","punch_item_templates"],"query":[{"key":"filters[id]","value":"","disabled":true},{"key":"filters[active]","value":"","disabled":true},{"key":"filters[updated_at]","value":"","disabled":true},{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"List Project Punch Item Templates"}},{"id":"5717770d-bc93-4b98-8a86-dfdf96f5e11a","name":"createProjectPunchItemTemplate — Create a Project Punch Item Template","request":{"method":"POST","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/punch_item_templates","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","punch_item_templates"],"query":[{"key":"filters[id]","value":"","disabled":true},{"key":"filters[active]","value":"","disabled":true},{"key":"filters[updated_at]","value":"","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Create a Project Punch Item Template","body":{"mode":"raw","raw":"{\n  \"project_id\": 0,\n  \"punch_item_template\": {\n    \"name\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"3dbbfd8e-01a5-4f14-81e2-38094238c454","name":"getProjectPunchItemTemplate — Show a Project Punch Item Template","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/punch_item_templates/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","punch_item_templates",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Show a Project Punch Item Template"}},{"id":"35d82b24-8ef9-4b08-8dee-9284a9ca4c4b","name":"updateProjectPunchItemTemplate — Update a Project Punch Item Template","request":{"method":"PATCH","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/punch_item_templates/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","punch_item_templates",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Update a Project Punch Item Template","body":{"mode":"raw","raw":"{\n  \"project_id\": 0,\n  \"punch_item_template\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"9b0d847e-520d-4841-83f4-a1ae59cd28d2","name":"deleteProjectPunchItemTemplate — Delete a Project Punch Item Template","request":{"method":"DELETE","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/punch_item_templates/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","punch_item_templates",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Delete a Project Punch Item Template"}},{"id":"29a33257-a3e1-44aa-8380-9e4669d1d40b","name":"createPunchItemProjectPunchItemTemplate — Create a Punch Item from a Template","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/punch_item_templates/:id/create_punch_item","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","punch_item_templates",":id","create_punch_item"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Create a Punch Item from a Template","body":{"mode":"raw","raw":"{\n  \"project_id\": 0,\n  \"punch_item\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"3bab429b-d0a5-4f70-85e8-c9957daec2cf","name":"createProjectPunchItemAttachment — Upload punch item attachment","request":{"method":"POST","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/punch_items/:id/attachments","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","punch_items",":id","attachments"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Upload punch item attachment"}},{"id":"a1301ad0-4fc7-4064-835b-eeb111edd627","name":"listProjectPunchListAssignees — List of Punch List Assignee Filter Options","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/punch_list/assignees","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","punch_list","assignees"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"List of Punch List Assignee Filter Options"}},{"id":"23c388a9-71dc-4aa7-80a2-8380be82c04e","name":"listProjectPunchListAvailableFinalApprovers — Punch List Available Final Approvers","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/punch_list/available_final_approvers","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","punch_list","available_final_approvers"],"query":[{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true},{"key":"query","value":"","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Punch List Available Final Approvers"}},{"id":"c4ece8df-1b82-4bc1-880a-23ead9634232","name":"listProjectPunchListVendors — List of Punch List Vendor Filter Options","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/punch_list/vendors","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","punch_list","vendors"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"List of Punch List Vendor Filter Options\n\nCompanies of the assignees on punch items the caller can see, sorted by name."}},{"id":"2ae7e619-3e5e-44aa-85b8-dc51cbf95eff","name":"listProjectPunchListAssigneeOptions — List Punch List Assignee options","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/punch_list_assignee_options","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","punch_list_assignee_options"],"query":[{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true},{"key":"query","value":"","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"List Punch List Assignee options\n\nActive project members who can be assigned punch items. query filters by name or login."}},{"id":"f00d8ab3-60f9-40a1-87d9-0b01f4a9c43b","name":"listProjectPunchListReadUserOptions — List Punch List Read User options","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/punch_list_read_user_options","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","punch_list_read_user_options"],"query":[{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true},{"key":"filters[search]","value":"","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"List Punch List Read User options\n\nActive project members who can read the punch list. filters[search] matches name or login."}},{"id":"c4134379-20ee-429c-89a3-8f4931d3461e","name":"listPunchItemTypes — List punch item types","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/punch_item_types","host":["{{baseUrl}}"],"path":["rest","v1.0","punch_item_types"],"query":[{"key":"project_id","value":"","disabled":false},{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true},{"key":"sort","value":"","disabled":true},{"key":"filters[name]","value":"","disabled":true}]},"description":"List punch item types"}},{"id":"b6902e19-d580-44cf-85b0-a1a5ade68a7a","name":"createPunchItemType — Create Punch Item Type","request":{"method":"POST","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/punch_item_types","host":["{{baseUrl}}"],"path":["rest","v1.0","punch_item_types"]},"description":"Create Punch Item Type\n\nPunch item types are shared by every project of the company: needs punch list admin on project_id and company admin. Names are unique per company (case-insensitive).","body":{"mode":"raw","raw":"{\n  \"project_id\": 0,\n  \"punch_item_type\": {\n    \"name\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"7478d615-268d-4dc4-81d3-f30f602ff2b2","name":"getPunchItemType — Show Punch Item Type","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/punch_item_types/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","punch_item_types",":id"],"query":[{"key":"project_id","value":"","disabled":false}],"variable":[{"key":"id","value":""}]},"description":"Show Punch Item Type"}},{"id":"7626f634-2b95-4072-8150-520427f220bd","name":"updatePunchItemType — Update Punch Item type","request":{"method":"PATCH","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/punch_item_types/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","punch_item_types",":id"],"variable":[{"key":"id","value":""}]},"description":"Update Punch Item type\n\nPunch item types are shared by every project of the company: needs punch list admin on project_id and company admin. Names are unique per company (case-insensitive).","body":{"mode":"raw","raw":"{\n  \"project_id\": 0,\n  \"punch_item_type\": {\n    \"name\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"e073a2fc-64a9-42fd-8d60-7505512a1f91","name":"deletePunchItemType — Delete Punch Item Type","request":{"method":"DELETE","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/punch_item_types/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","punch_item_types",":id"],"query":[{"key":"project_id","value":"","disabled":false}],"variable":[{"key":"id","value":""}]},"description":"Delete Punch Item Type\n\nPunch item types are shared by every project of the company: needs punch list admin on project_id and company admin. A type still used by a punch item (live or recycled) or a template returns 409."}},{"id":"ae25a83f-b7d3-4efd-8e29-aa8b5dcfb004","name":"listPunchItems — List Punch Items","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/punch_items","host":["{{baseUrl}}"],"path":["rest","v1.0","punch_items"],"query":[{"key":"project_id","value":"","disabled":false},{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true},{"key":"filters[status]","value":"","disabled":true},{"key":"filters[priority]","value":"","disabled":true},{"key":"filters[punch_item_type_id]","value":"","disabled":true},{"key":"filters[location_id]","value":"","disabled":true},{"key":"filters[include_sublocations]","value":"","disabled":true},{"key":"filters[approver_login_information_id]","value":"","disabled":true},{"key":"filters[vendor_id]","value":"","disabled":true},{"key":"filters[assignee_response]","value":"","disabled":true},{"key":"filters[trade_id]","value":"","disabled":true},{"key":"filters[category_id]","value":"","disabled":true},{"key":"sort","value":"","disabled":true},{"key":"filters[id]","value":"","disabled":true},{"key":"filters[query]","value":"","disabled":true},{"key":"filters[view]","value":"","disabled":true},{"key":"filters[updated_at]","value":"","disabled":true},{"key":"filters[closed_at][]","value":"","disabled":true},{"key":"filters[created_at][]","value":"","disabled":true},{"key":"filters[date_notified][]","value":"","disabled":true},{"key":"filters[due_date][]","value":"","disabled":true},{"key":"filters[failed_items_by_operation_id]","value":"","disabled":true},{"key":"filters[error_category]","value":"","disabled":true}]},"description":"List Punch Items"}},{"id":"39a3016c-cbed-4aa6-8be1-5e0a0c4f647a","name":"createPunchItem — Create Punch Item","request":{"method":"POST","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/punch_items","host":["{{baseUrl}}"],"path":["rest","v1.0","punch_items"],"query":[{"key":"run_configurable_validations","value":"","disabled":true}]},"description":"Create Punch Item","body":{"mode":"raw","raw":"{\n  \"project_id\": 0,\n  \"punch_item\": {\n    \"name\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"94a0d077-ece1-4e7b-840b-c381c3c91e0a","name":"createPunchItemsBulkCreate — Bulk create punch items","request":{"method":"POST","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/punch_items/bulk_create","host":["{{baseUrl}}"],"path":["rest","v1.0","punch_items","bulk_create"]},"description":"Bulk create punch items\n\nCreate up to 100 punch items in one project. Each item is the `punch_item` body of POST /punch_items and runs through the same checks. Items run in order; a failing item does not roll back the others. Successful items have status 201. With Idempotency-Key, a retried batch replays the first response; retry only the failed items with a new key.","body":{"mode":"raw","raw":"{\n  \"project_id\": 0,\n  \"punch_items\": [\n    {\n      \"name\": \"\"\n    }\n  ]\n}","options":{"raw":{"language":"json"}}}}},{"id":"b46a452c-06d7-4449-8789-c8440244706e","name":"updatePunchItemsBulkUpdate — Bulk update punch items","request":{"method":"PATCH","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/punch_items/bulk_update","host":["{{baseUrl}}"],"path":["rest","v1.0","punch_items","bulk_update"]},"description":"Bulk update punch items\n\nUpdate up to 100 punch items. Each item carries the record `id` and the fields to change, and runs through the same checks as PATCH /punch_items/{id}. Items run in order; a failing item does not roll back the others. With Idempotency-Key, a retried batch replays the first response; retry only the failed items with a new key.","body":{"mode":"raw","raw":"{\n  \"project_id\": 0,\n  \"punch_items\": [\n    {\n      \"id\": 0\n    }\n  ]\n}","options":{"raw":{"language":"json"}}}}},{"id":"08251c8f-61b9-48c6-80b2-05897068393c","name":"listPunchItemsRecycleBin — List Deleted Punch Items","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/punch_items/recycle_bin","host":["{{baseUrl}}"],"path":["rest","v1.0","punch_items","recycle_bin"],"query":[{"key":"project_id","value":"","disabled":false},{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true},{"key":"filters[status]","value":"","disabled":true},{"key":"filters[priority]","value":"","disabled":true},{"key":"filters[punch_item_type_id]","value":"","disabled":true},{"key":"filters[location_id]","value":"","disabled":true},{"key":"filters[include_sublocations]","value":"","disabled":true},{"key":"filters[approver_login_information_id]","value":"","disabled":true},{"key":"filters[vendor_id]","value":"","disabled":true},{"key":"filters[assignee_response]","value":"","disabled":true},{"key":"filters[trade_id]","value":"","disabled":true},{"key":"filters[category_id]","value":"","disabled":true},{"key":"sort","value":"","disabled":true},{"key":"filters[id]","value":"","disabled":true},{"key":"filters[query]","value":"","disabled":true}]},"description":"List Deleted Punch Items"}},{"id":"adf3a65a-515e-41a0-86c6-1da939badbfa","name":"createPunchItemsSendAllUnsent — Send All Unsent Punch Item Emails","request":{"method":"POST","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/punch_items/send_all_unsent","host":["{{baseUrl}}"],"path":["rest","v1.0","punch_items","send_all_unsent"],"query":[{"key":"project_id","value":"","disabled":false}]},"description":"Send All Unsent Punch Item Emails","body":{"mode":"raw","raw":"{\n  \"punch_ids\": [\n    0\n  ],\n  \"recipient\": \"assignee\"\n}","options":{"raw":{"language":"json"}}}}},{"id":"e3f5fafd-2720-48ff-81a2-a286efde7346","name":"createPunchItemsSendUnsent — Send unsent Punch Items","request":{"method":"POST","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/punch_items/send_unsent","host":["{{baseUrl}}"],"path":["rest","v1.0","punch_items","send_unsent"]},"description":"Send unsent Punch Items","body":{"mode":"raw","raw":"{\n  \"project_id\": 0\n}","options":{"raw":{"language":"json"}}}}},{"id":"add0d747-b203-45ee-88f9-f944e86cb25c","name":"getPunchItem — Show Punch Item","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/punch_items/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","punch_items",":id"],"query":[{"key":"project_id","value":"","disabled":false},{"key":"include_deleted","value":"","disabled":true}],"variable":[{"key":"id","value":""}]},"description":"Show Punch Item"}},{"id":"c2544909-7e97-47b0-8a3b-a5820e0d896a","name":"updatePunchItem — Update Punch Item","request":{"method":"PATCH","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/punch_items/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","punch_items",":id"],"query":[{"key":"run_configurable_validations","value":"","disabled":true}],"variable":[{"key":"id","value":""}]},"description":"Update Punch Item","body":{"mode":"raw","raw":"{\n  \"project_id\": 0,\n  \"punch_item\": {\n    \"name\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"7f7e59d9-aeab-4dbf-8709-690c513ead11","name":"deletePunchItem — Delete Punch Item","request":{"method":"DELETE","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/punch_items/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","punch_items",":id"],"query":[{"key":"project_id","value":"","disabled":false}],"variable":[{"key":"id","value":""}]},"description":"Delete Punch Item"}},{"id":"50735fc3-ab97-497b-8575-bab922131646","name":"listPunchItemActivities — List Punch Item Activities","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/punch_items/:id/activities","host":["{{baseUrl}}"],"path":["rest","v1.0","punch_items",":id","activities"],"query":[{"key":"project_id","value":"","disabled":false}],"variable":[{"key":"id","value":""}]},"description":"List Punch Item Activities"}},{"id":"e4f432dc-46db-4185-86dc-438af29b762d","name":"createPunchItemComment — Create Punch Item Comment","request":{"method":"POST","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/punch_items/:id/comments","host":["{{baseUrl}}"],"path":["rest","v1.0","punch_items",":id","comments"],"query":[{"key":"project_id","value":"","disabled":false}],"variable":[{"key":"id","value":""}]},"description":"Create Punch Item Comment","body":{"mode":"raw","raw":"{\n  \"attachments\": [\n    \"\"\n  ],\n  \"comment\": {\n    \"body\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"a6f62231-1121-438d-86e4-1bb3e62e3abe","name":"sendEmailPunchItem — Send Punch Item Email","request":{"method":"POST","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/punch_items/:id/send_email","host":["{{baseUrl}}"],"path":["rest","v1.0","punch_items",":id","send_email"],"variable":[{"key":"id","value":""}]},"description":"Send Punch Item Email","body":{"mode":"raw","raw":"{\n  \"bcc_distribution_ids\": [\n    0\n  ],\n  \"body\": \"\",\n  \"cc_distribution_ids\": [\n    0\n  ],\n  \"distribution_ids\": [\n    0\n  ],\n  \"subject\": \"\"\n}","options":{"raw":{"language":"json"}}}}},{"id":"21712413-b971-46fc-8885-fe8ee3aa791d","name":"listPunchListDefaultDistribution — List Punch Item Default Distribution List","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/punch_list/default_distribution","host":["{{baseUrl}}"],"path":["rest","v1.0","punch_list","default_distribution"],"query":[{"key":"project_id","value":"","disabled":false},{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true}]},"description":"List Punch Item Default Distribution List"}},{"id":"df8acd92-1f96-45fc-8185-807750c2e060","name":"listPunchItemsV11 — List Punch Items","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.1/punch_items","host":["{{baseUrl}}"],"path":["rest","v1.1","punch_items"],"query":[{"key":"project_id","value":"","disabled":false},{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true},{"key":"filters[status]","value":"","disabled":true},{"key":"filters[priority]","value":"","disabled":true},{"key":"filters[punch_item_type_id]","value":"","disabled":true},{"key":"filters[location_id]","value":"","disabled":true},{"key":"filters[include_sublocations]","value":"","disabled":true},{"key":"filters[approver_login_information_id]","value":"","disabled":true},{"key":"filters[vendor_id]","value":"","disabled":true},{"key":"filters[assignee_response]","value":"","disabled":true},{"key":"filters[trade_id]","value":"","disabled":true},{"key":"filters[category_id]","value":"","disabled":true},{"key":"sort","value":"","disabled":true},{"key":"filters[id]","value":"","disabled":true},{"key":"filters[query]","value":"","disabled":true},{"key":"filters[updated_at]","value":"","disabled":true},{"key":"filters[failed_items_by_operation_id]","value":"","disabled":true},{"key":"filters[error_category]","value":"","disabled":true}]},"description":"List Punch Items"}},{"id":"f9fb7f6e-c6e2-4d6c-87ff-26a8017818d8","name":"createPunchItemV11 — Create Punch Item","request":{"method":"POST","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.1/punch_items","host":["{{baseUrl}}"],"path":["rest","v1.1","punch_items"],"query":[{"key":"run_configurable_validations","value":"","disabled":true}]},"description":"Create Punch Item","body":{"mode":"raw","raw":"{\n  \"project_id\": 0,\n  \"punch_item\": {\n    \"name\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"6957f8c4-1276-416c-8cb9-28072b26c47f","name":"listPunchItemsRecycleBinV11 — List Deleted Punch Items","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.1/punch_items/recycle_bin","host":["{{baseUrl}}"],"path":["rest","v1.1","punch_items","recycle_bin"],"query":[{"key":"project_id","value":"","disabled":false},{"key":"filters[category_id]","value":"","disabled":true},{"key":"sort","value":"","disabled":true}]},"description":"List Deleted Punch Items"}},{"id":"2d968f02-ca1b-4eaa-8999-dc778bd8b097","name":"createPunchItemsSendAllUnsentV11 — Send All Unsent Punch Item Emails","request":{"method":"POST","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.1/punch_items/send_all_unsent","host":["{{baseUrl}}"],"path":["rest","v1.1","punch_items","send_all_unsent"],"query":[{"key":"project_id","value":"","disabled":false}]},"description":"Send All Unsent Punch Item Emails","body":{"mode":"raw","raw":"{\n  \"punch_ids\": [\n    0\n  ],\n  \"recipient\": \"assignee\"\n}","options":{"raw":{"language":"json"}}}}},{"id":"b61931ca-217b-4a0c-8012-9b4a3fb663eb","name":"createPunchItemsSendUnsentV11 — Send unsent Punch Items","request":{"method":"POST","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.1/punch_items/send_unsent","host":["{{baseUrl}}"],"path":["rest","v1.1","punch_items","send_unsent"]},"description":"Send unsent Punch Items","body":{"mode":"raw","raw":"{\n  \"project_id\": 0\n}","options":{"raw":{"language":"json"}}}}},{"id":"641ad58f-60e7-4410-8f44-8e807fc6a951","name":"getPunchItemV11 — Show Punch Item","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.1/punch_items/:id","host":["{{baseUrl}}"],"path":["rest","v1.1","punch_items",":id"],"query":[{"key":"project_id","value":"","disabled":false},{"key":"include_deleted","value":"","disabled":true}],"variable":[{"key":"id","value":""}]},"description":"Show Punch Item"}},{"id":"4bb65ecc-2e69-4d5f-8c57-37653f5594d5","name":"updatePunchItemV11 — Update Punch Item","request":{"method":"PATCH","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.1/punch_items/:id","host":["{{baseUrl}}"],"path":["rest","v1.1","punch_items",":id"],"query":[{"key":"run_configurable_validations","value":"","disabled":true}],"variable":[{"key":"id","value":""}]},"description":"Update Punch Item","body":{"mode":"raw","raw":"{\n  \"project_id\": 0,\n  \"punch_item\": {\n    \"name\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"21acf8bf-2a39-4a24-8e9e-8c8797337b16","name":"deletePunchItemV11 — Delete Punch Item","request":{"method":"DELETE","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.1/punch_items/:id","host":["{{baseUrl}}"],"path":["rest","v1.1","punch_items",":id"],"query":[{"key":"project_id","value":"","disabled":false}],"variable":[{"key":"id","value":""}]},"description":"Delete Punch Item"}},{"id":"6328ae89-6214-4ad5-8c8a-135818ca185e","name":"sendEmailPunchItemV11 — Send Punch Item Email","request":{"method":"POST","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.1/punch_items/:id/send_email","host":["{{baseUrl}}"],"path":["rest","v1.1","punch_items",":id","send_email"],"variable":[{"key":"id","value":""}]},"description":"Send Punch Item Email","body":{"mode":"raw","raw":"{\n  \"bcc_distribution_ids\": [\n    0\n  ],\n  \"body\": \"\",\n  \"cc_distribution_ids\": [\n    0\n  ],\n  \"distribution_ids\": [\n    0\n  ],\n  \"subject\": \"\"\n}","options":{"raw":{"language":"json"}}}}},{"id":"91ed7a4f-f57e-4aae-8685-8966fbbb3eaa","name":"listCompanyProjectPunchListAssigneeCompaniesV20 — List Punch Item Assignee Company Filter Options","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v2.0/companies/:company_id/projects/:project_id/punch_list/assignee_companies","host":["{{baseUrl}}"],"path":["rest","v2.0","companies",":company_id","projects",":project_id","punch_list","assignee_companies"],"query":[{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true},{"key":"query","value":"","disabled":true},{"key":"view","value":"","disabled":true}],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"project_id","value":"{{projectId}}"}]},"description":"List Punch Item Assignee Company Filter Options\n\nBuilt from the punch items the caller can see; query filters by name. per_page defaults to 10 (max 100)."}},{"id":"d1fcb7cf-6524-4fe8-830b-7203561ee993","name":"listCompanyProjectPunchListAssigneesV20 — List Punch Item Assignee Filter Options","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v2.0/companies/:company_id/projects/:project_id/punch_list/assignees","host":["{{baseUrl}}"],"path":["rest","v2.0","companies",":company_id","projects",":project_id","punch_list","assignees"],"query":[{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true},{"key":"query","value":"","disabled":true},{"key":"view","value":"","disabled":true}],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"project_id","value":"{{projectId}}"}]},"description":"List Punch Item Assignee Filter Options\n\nBuilt from the punch items the caller can see; query filters by name. per_page defaults to 10 (max 100)."}},{"id":"2f4cd7dd-665c-4f17-834b-b798ea9d510a","name":"listCompanyProjectPunchListBallInCourtV20 — List Punch Item Ball In Court Filter Options","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v2.0/companies/:company_id/projects/:project_id/punch_list/ball_in_court","host":["{{baseUrl}}"],"path":["rest","v2.0","companies",":company_id","projects",":project_id","punch_list","ball_in_court"],"query":[{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true},{"key":"query","value":"","disabled":true}],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"project_id","value":"{{projectId}}"}]},"description":"List Punch Item Ball In Court Filter Options\n\nBuilt from the punch items the caller can see; query filters by name. per_page defaults to 10 (max 100)."}},{"id":"426909b5-c991-42aa-8da7-0e2f00345213","name":"listCompanyProjectPunchListClosedByContactsV20 — List Punch Item Closed By Contact Filter Options","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v2.0/companies/:company_id/projects/:project_id/punch_list/closed_by_contacts","host":["{{baseUrl}}"],"path":["rest","v2.0","companies",":company_id","projects",":project_id","punch_list","closed_by_contacts"],"query":[{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true},{"key":"query","value":"","disabled":true}],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"project_id","value":"{{projectId}}"}]},"description":"List Punch Item Closed By Contact Filter Options\n\nBuilt from the punch items the caller can see; query filters by name. per_page defaults to 10 (max 100)."}},{"id":"c6f4e0d1-a220-4a0d-8714-2c4b50a8b61c","name":"listCompanyProjectPunchListCreatorsV20 — List Punch Item Creator Filter Options","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v2.0/companies/:company_id/projects/:project_id/punch_list/creators","host":["{{baseUrl}}"],"path":["rest","v2.0","companies",":company_id","projects",":project_id","punch_list","creators"],"query":[{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true},{"key":"query","value":"","disabled":true}],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"project_id","value":"{{projectId}}"}]},"description":"List Punch Item Creator Filter Options\n\nBuilt from the punch items the caller can see; query filters by name. per_page defaults to 10 (max 100)."}},{"id":"9d013600-c0a4-4224-8c60-22b59ae7360f","name":"listCompanyProjectPunchListFinalApproversV20 — List Punch Item Final Approver Filter Options","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v2.0/companies/:company_id/projects/:project_id/punch_list/final_approvers","host":["{{baseUrl}}"],"path":["rest","v2.0","companies",":company_id","projects",":project_id","punch_list","final_approvers"],"query":[{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true},{"key":"query","value":"","disabled":true}],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"project_id","value":"{{projectId}}"}]},"description":"List Punch Item Final Approver Filter Options\n\nBuilt from the punch items the caller can see; query filters by name. per_page defaults to 10 (max 100)."}},{"id":"610de4d2-43d1-49b5-8ac0-591209f2b933","name":"listCompanyProjectPunchListLocationsV20 — List Punch Item Location Filter Options","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v2.0/companies/:company_id/projects/:project_id/punch_list/locations","host":["{{baseUrl}}"],"path":["rest","v2.0","companies",":company_id","projects",":project_id","punch_list","locations"],"query":[{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true},{"key":"query","value":"","disabled":true}],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"project_id","value":"{{projectId}}"}]},"description":"List Punch Item Location Filter Options\n\nBuilt from the punch items the caller can see; query filters by name. per_page defaults to 10 (max 100)."}},{"id":"b9efc324-b7d6-4f6b-8ede-8f984bc9d464","name":"listCompanyProjectPunchListPunchItemManagersV20 — List Punch Item Manager Filter Options","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v2.0/companies/:company_id/projects/:project_id/punch_list/punch_item_managers","host":["{{baseUrl}}"],"path":["rest","v2.0","companies",":company_id","projects",":project_id","punch_list","punch_item_managers"],"query":[{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true},{"key":"query","value":"","disabled":true}],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"project_id","value":"{{projectId}}"}]},"description":"List Punch Item Manager Filter Options\n\nBuilt from the punch items the caller can see; query filters by name. per_page defaults to 10 (max 100)."}},{"id":"d7bc44cb-9456-4954-8b9c-b57727210e3c","name":"listCompanyProjectPunchListTypesV20 — List Punch Item Type Filter Options","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v2.0/companies/:company_id/projects/:project_id/punch_list/types","host":["{{baseUrl}}"],"path":["rest","v2.0","companies",":company_id","projects",":project_id","punch_list","types"],"query":[{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true},{"key":"query","value":"","disabled":true}],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"project_id","value":"{{projectId}}"}]},"description":"List Punch Item Type Filter Options\n\nBuilt from the punch items the caller can see; query filters by name. per_page defaults to 10 (max 100)."}}]},{"name":"Purchase Requests","description":"Module: purchase_requests","item":[{"id":"3588cd5c-9b8e-476c-8beb-b281b577a7ba","name":"listProjectPurchaseRequests — GET /rest/v1.0/projects/{project_id}/purchase_requests","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/purchase_requests","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","purchase_requests"],"query":[{"key":"page","value":"1","disabled":true,"description":"One-based page. The computed offset must not exceed 2147483647."},{"key":"per_page","value":"100","disabled":true},{"key":"status","value":"","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"GET /rest/v1.0/projects/{project_id}/purchase_requests"}},{"id":"010e8f69-9e1d-462b-82c8-89ad6d5682a5","name":"createProjectPurchaseRequest — POST /rest/v1.0/projects/{project_id}/purchase_requests","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/purchase_requests","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","purchase_requests"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"POST /rest/v1.0/projects/{project_id}/purchase_requests","body":{"mode":"raw","raw":"{\n  \"delivery_location\": \"\",\n  \"justification\": \"\",\n  \"lines\": [\n    {\n      \"cost_code_id\": 0,\n      \"description\": \"\",\n      \"quantity\": \"\",\n      \"unit_cost\": \"\",\n      \"uom\": \"\"\n    }\n  ],\n  \"needed_by\": \"2026-01-31\",\n  \"title\": \"\",\n  \"vendor_id\": 0\n}","options":{"raw":{"language":"json"}}}}},{"id":"db075d41-4ba9-4a8c-822a-9eca1f9978ae","name":"getProjectPurchaseRequest — GET /rest/v1.0/projects/{project_id}/purchase_requests/{id}","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/purchase_requests/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","purchase_requests",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"GET /rest/v1.0/projects/{project_id}/purchase_requests/{id}"}},{"id":"d5871e55-5016-4e03-8dd8-339252c04755","name":"updateProjectPurchaseRequest — PATCH /rest/v1.0/projects/{project_id}/purchase_requests/{id}","request":{"method":"PATCH","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/purchase_requests/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","purchase_requests",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"PATCH /rest/v1.0/projects/{project_id}/purchase_requests/{id}","body":{"mode":"raw","raw":"{\n  \"expected_version\": 0,\n  \"request\": {\n    \"delivery_location\": \"\",\n    \"justification\": \"\",\n    \"lines\": [\n      {\n        \"cost_code_id\": null,\n        \"description\": null,\n        \"quantity\": null,\n        \"unit_cost\": null,\n        \"uom\": null\n      }\n    ],\n    \"needed_by\": \"2026-01-31\",\n    \"title\": \"\",\n    \"vendor_id\": 0\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"60da1274-b200-4776-84b9-1b0a1368a799","name":"listProjectPurchaseRequestBudgetContext — Read current budget facts for the request's cost codes","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/purchase_requests/:id/budget_context","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","purchase_requests",":id","budget_context"],"query":[{"key":"expected_version","value":"","disabled":false}],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Read current budget facts for the request's cost codes\n\nRequires purchase_requests:read and budget:read plus both live project view grants and tool enablement. Facts are advisory existing Budget aggregates, not reserved funds. No currency or after-request projection is inferred. Converted requests are never added again to budget exposure."}},{"id":"e939ae65-4660-460a-8429-b371f39efcfc","name":"createProjectPurchaseRequestTransition — POST /rest/v1.0/projects/{project_id}/purchase_requests/{id}/transitions","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/purchase_requests/:id/transitions","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","purchase_requests",":id","transitions"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"POST /rest/v1.0/projects/{project_id}/purchase_requests/{id}/transitions\n\nRequires purchase_requests:write scope. Conversion additionally requires commitments:write. Standard users submit their own drafts. Administrators independently approve, return or reject. Conversion requires both module admin and commitment creation authority. A conversion retry returns the original result, regardless of the old version, after rechecking authority.","body":{"mode":"raw","raw":"{\n  \"action\": \"submit\",\n  \"expected_version\": 0\n}","options":{"raw":{"language":"json"}}}}}]},{"name":"Reporting","description":"Module: reporting","item":[{"id":"28d86680-dd84-494f-8d9e-fe7a8136fcc7","name":"listProjectDashboards — List dashboards for a project","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/dashboards","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","dashboards"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"List dashboards for a project\n\nDeprecated: 360 Reporting is retired in favour of Analytics. Use the Analytics API instead: dashboards (/rest/v1.0/companies/{company_id}/analytics/dashboards and …/dashboards/{id}/data for computed tiles), ad-hoc queries (…/analytics/query) and exports (…/analytics/exports). See the Analytics API guide."}},{"id":"f1655ea9-9102-49e5-8aef-fc89def978d3","name":"createProjectDashboard — Create a dashboard","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/dashboards","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","dashboards"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Create a dashboard\n\nDeprecated: 360 Reporting is retired in favour of Analytics. Use the Analytics API instead: dashboards (/rest/v1.0/companies/{company_id}/analytics/dashboards and …/dashboards/{id}/data for computed tiles), ad-hoc queries (…/analytics/query) and exports (…/analytics/exports). See the Analytics API guide."}},{"id":"ab8a68b1-f66e-4785-8e0e-9b37e6aab52c","name":"getProjectDashboard — Get a computed dashboard (widget payloads)","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/dashboards/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","dashboards",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Get a computed dashboard (widget payloads)\n\nDeprecated: 360 Reporting is retired in favour of Analytics. Use the Analytics API instead: dashboards (/rest/v1.0/companies/{company_id}/analytics/dashboards and …/dashboards/{id}/data for computed tiles), ad-hoc queries (…/analytics/query) and exports (…/analytics/exports). See the Analytics API guide."}},{"id":"b3d65288-33c1-4efb-85a2-4f406e06c280","name":"updateProjectDashboard — Update dashboard","request":{"method":"PATCH","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/dashboards/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","dashboards",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Update dashboard"}},{"id":"335d2193-afd9-4c3e-81bf-862f36b88806","name":"deleteProjectDashboard — Delete dashboard","request":{"method":"DELETE","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/dashboards/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","dashboards",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Delete dashboard"}},{"id":"2255257f-0368-4887-8855-53deefd4835f","name":"createProjectDashboardWidget — Append a widget to a dashboard","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/dashboards/:id/widgets","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","dashboards",":id","widgets"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Append a widget to a dashboard\n\nDeprecated: 360 Reporting is retired in favour of Analytics. Use the Analytics API instead: dashboards (/rest/v1.0/companies/{company_id}/analytics/dashboards and …/dashboards/{id}/data for computed tiles), ad-hoc queries (…/analytics/query) and exports (…/analytics/exports). See the Analytics API guide."}},{"id":"91add14a-e231-4df2-8622-136181d6ed9a","name":"listProjectProjectReportTemplates — List the canned report-template catalog (Reports Library)","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/project_report_templates","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","project_report_templates"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"List the canned report-template catalog (Reports Library)\n\nDeprecated: 360 Reporting is retired in favour of Analytics. Use the Analytics API instead: dashboards (/rest/v1.0/companies/{company_id}/analytics/dashboards and …/dashboards/{id}/data for computed tiles), ad-hoc queries (…/analytics/query) and exports (…/analytics/exports). See the Analytics API guide."}},{"id":"0543a308-1662-421a-8d5f-e8f7c5f9266b","name":"getProjectProjectReportTemplate — Show one report template (by id or template key)","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/project_report_templates/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","project_report_templates",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Show one report template (by id or template key)\n\nDeprecated: 360 Reporting is retired in favour of Analytics. Use the Analytics API instead: dashboards (/rest/v1.0/companies/{company_id}/analytics/dashboards and …/dashboards/{id}/data for computed tiles), ad-hoc queries (…/analytics/query) and exports (…/analytics/exports). See the Analytics API guide."}},{"id":"66720d01-2473-4308-8cfc-e7506a20852e","name":"listProjectProjectReports — List a project's saved library reports","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/project_reports","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","project_reports"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"List a project's saved library reports\n\nDeprecated: 360 Reporting is retired in favour of Analytics. Use the Analytics API instead: dashboards (/rest/v1.0/companies/{company_id}/analytics/dashboards and …/dashboards/{id}/data for computed tiles), ad-hoc queries (…/analytics/query) and exports (…/analytics/exports). See the Analytics API guide."}},{"id":"cf59e0c7-74f3-4d63-8624-d6945616fa9b","name":"createProjectProjectReport — Create a project report (from a template or custom)","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/project_reports","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","project_reports"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Create a project report (from a template or custom)\n\nDeprecated: 360 Reporting is retired in favour of Analytics. Use the Analytics API instead: dashboards (/rest/v1.0/companies/{company_id}/analytics/dashboards and …/dashboards/{id}/data for computed tiles), ad-hoc queries (…/analytics/query) and exports (…/analytics/exports). See the Analytics API guide."}},{"id":"489fc118-70c8-4738-8f27-f5edef81f159","name":"getProjectProjectReport — Show a saved library report's configuration","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/project_reports/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","project_reports",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Show a saved library report's configuration\n\nDeprecated: 360 Reporting is retired in favour of Analytics. Use the Analytics API instead: dashboards (/rest/v1.0/companies/{company_id}/analytics/dashboards and …/dashboards/{id}/data for computed tiles), ad-hoc queries (…/analytics/query) and exports (…/analytics/exports). See the Analytics API guide."}},{"id":"b8b8a7f5-6391-4c30-8ac7-f0d44d8648b5","name":"updateProjectProjectReport — Update a saved library report","request":{"method":"PATCH","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/project_reports/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","project_reports",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Update a saved library report\n\nDeprecated: 360 Reporting is retired in favour of Analytics. Use the Analytics API instead: dashboards (/rest/v1.0/companies/{company_id}/analytics/dashboards and …/dashboards/{id}/data for computed tiles), ad-hoc queries (…/analytics/query) and exports (…/analytics/exports). See the Analytics API guide."}},{"id":"e8e49d38-1283-4097-8a6d-3ad90dacf363","name":"deleteProjectProjectReport — Delete project report","request":{"method":"DELETE","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/project_reports/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","project_reports",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Delete project report"}},{"id":"1459678e-30be-464a-862b-6c84e5dc03e3","name":"listProjectProjectReportRun — Run a saved library report, returning computed rows","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/project_reports/:id/run","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","project_reports",":id","run"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Run a saved library report, returning computed rows\n\nDeprecated: 360 Reporting is retired in favour of Analytics. Use the Analytics API instead: dashboards (/rest/v1.0/companies/{company_id}/analytics/dashboards and …/dashboards/{id}/data for computed tiles), ad-hoc queries (…/analytics/query) and exports (…/analytics/exports). See the Analytics API guide."}},{"id":"7521e216-ac11-4446-89e3-4ebdc98a9f2d","name":"listProjectReports — List built-in and saved reports for a project","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/reports","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","reports"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"List built-in and saved reports for a project\n\nDeprecated: 360 Reporting is retired in favour of Analytics. Use the Analytics API instead: dashboards (/rest/v1.0/companies/{company_id}/analytics/dashboards and …/dashboards/{id}/data for computed tiles), ad-hoc queries (…/analytics/query) and exports (…/analytics/exports). See the Analytics API guide."}},{"id":"f3b4623d-6528-4099-8e4e-aabd6bf6cd69","name":"createProjectReport — Create a saved (custom) report","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/reports","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","reports"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Create a saved (custom) report\n\nDeprecated: 360 Reporting is retired in favour of Analytics. Use the Analytics API instead: dashboards (/rest/v1.0/companies/{company_id}/analytics/dashboards and …/dashboards/{id}/data for computed tiles), ad-hoc queries (…/analytics/query) and exports (…/analytics/exports). See the Analytics API guide."}},{"id":"d12cf894-df95-4f14-8f27-677e1736e877","name":"getProjectReport — Get a computed report (built-in key or saved-<id>)","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/reports/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","reports",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Get a computed report (built-in key or saved-<id>)\n\nDeprecated: 360 Reporting is retired in favour of Analytics. Use the Analytics API instead: dashboards (/rest/v1.0/companies/{company_id}/analytics/dashboards and …/dashboards/{id}/data for computed tiles), ad-hoc queries (…/analytics/query) and exports (…/analytics/exports). See the Analytics API guide."}},{"id":"6f8aa75e-201f-47ef-8502-a7f97dead7af","name":"updateProjectReport — Update report","request":{"method":"PATCH","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/reports/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","reports",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Update report"}},{"id":"5c203781-796a-4f10-8fe9-52604e4a2438","name":"deleteProjectReport — Recycle a saved report","request":{"method":"DELETE","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/reports/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","reports",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Recycle a saved report"}},{"id":"c01f78be-7c49-4cef-8772-94d17bfead98","name":"listProjectScheduledReports — List scheduled (delivered) reports","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/scheduled_reports","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","scheduled_reports"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"List scheduled (delivered) reports\n\nDeprecated: 360 Reporting is retired in favour of Analytics. Use the Analytics API instead: dashboards (/rest/v1.0/companies/{company_id}/analytics/dashboards and …/dashboards/{id}/data for computed tiles), ad-hoc queries (…/analytics/query) and exports (…/analytics/exports). See the Analytics API guide."}},{"id":"0c0de3cd-b233-4189-8001-c82df9be884a","name":"createProjectScheduledReport — Schedule a report for recurring delivery","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/scheduled_reports","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","scheduled_reports"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Schedule a report for recurring delivery\n\nDeprecated: 360 Reporting is retired in favour of Analytics. Use the Analytics API instead: dashboards (/rest/v1.0/companies/{company_id}/analytics/dashboards and …/dashboards/{id}/data for computed tiles), ad-hoc queries (…/analytics/query) and exports (…/analytics/exports). See the Analytics API guide.","body":{"mode":"raw","raw":"{\n  \"schedule\": {\n    \"report_key\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"7feabfe8-9b9f-4209-89d9-f00394dfa4bb","name":"deleteProjectScheduledReport — Stop a schedule","request":{"method":"DELETE","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/scheduled_reports/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","scheduled_reports",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Stop a schedule\n\nStop a schedule (soft delete). Pending delivery jobs no-op once the schedule is gone."}},{"id":"346b69bb-3079-44eb-8df5-a95720ca91fa","name":"listProjectWidgetData — Compute a single widget's chart data","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/widget_data","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","widget_data"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Compute a single widget's chart data\n\nDeprecated: 360 Reporting is retired in favour of Analytics. Use the Analytics API instead: dashboards (/rest/v1.0/companies/{company_id}/analytics/dashboards and …/dashboards/{id}/data for computed tiles), ad-hoc queries (…/analytics/query) and exports (…/analytics/exports). See the Analytics API guide."}}]},{"name":"RFIs","description":"Module: rfis","item":[{"id":"533776b9-0fc2-4282-8191-09a3f78e89cb","name":"listProjectRfis — List RFIs","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/rfis","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","rfis"],"query":[{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true},{"key":"filters[id]","value":"","disabled":true},{"key":"filters[status]","value":"","disabled":true},{"key":"filters[assigned_id]","value":"","disabled":true},{"key":"filters[created_at]","value":"","disabled":true},{"key":"filters[responsible_contractor_id]","value":"","disabled":true},{"key":"filters[cost_code_id]","value":"","disabled":true},{"key":"filters[received_from_login_information_id]","value":"","disabled":true},{"key":"filters[ball_in_court_id]","value":"","disabled":true},{"key":"filters[location_id]","value":"","disabled":true},{"key":"filters[for_location_id_with_sublocations]","value":"","disabled":true},{"key":"filters[updated_at]","value":"","disabled":true},{"key":"filters[initiated_at]","value":"","disabled":true},{"key":"filters[rfi_manager_id]","value":"","disabled":true},{"key":"filters[number]","value":"","disabled":true},{"key":"filters[prefix_stage_id]","value":"","disabled":true},{"key":"filters[current_revision]","value":"","disabled":true},{"key":"filters[sub_job_id]","value":"","disabled":true},{"key":"filters[priority]","value":"","disabled":true},{"key":"filters[linked_to_connected_rfis]","value":"","disabled":true},{"key":"filters[linked_to_external_rfis]","value":"","disabled":true},{"key":"filters[overdue]","value":"","disabled":true},{"key":"serializer_view","value":"","disabled":true},{"key":"as_datetimes","value":"","disabled":true},{"key":"search","value":"","disabled":true},{"key":"q","value":"","disabled":true},{"key":"sort[attribute]","value":"","disabled":true},{"key":"sort[direction]","value":"","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"List RFIs"}},{"id":"e6b10ddc-20d1-4337-8aaf-6811cb80e8f3","name":"createProjectRfi — Create RFI","request":{"method":"POST","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/rfis","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","rfis"],"query":[{"key":"run_configurable_validations","value":"","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Create RFI","body":{"mode":"raw","raw":"{\n  \"rfi\": {\n    \"question\": {\n      \"body\": \"\"\n    },\n    \"rfi_manager_id\": 0,\n    \"subject\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"0c5b72b2-22ea-423f-8d94-bfa25fbfa840","name":"updateProjectRfis — Batch Update RFIs","request":{"method":"PATCH","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/rfis","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","rfis"],"query":[{"key":"run_configurable_validations","value":"","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Batch Update RFIs\n\nUpdate up to 100 RFIs in one request. Each item in `data` carries the RFI `id` and the fields to change; assignees and distribution change through add/remove lists. Items run in order through the same checks as PATCH …/rfis/{id}. A failing item does not roll back the others: `results` reports each item's status. With Idempotency-Key, a retried batch replays the first response.","body":{"mode":"raw","raw":"{\n  \"data\": [\n    {}\n  ]\n}","options":{"raw":{"language":"json"}}}}},{"id":"cd1a3a87-11f4-482c-86f3-1b6a88d2bfb8","name":"createProjectRfisBulkCreate — Bulk create RFIs","request":{"method":"POST","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/rfis/bulk_create","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","rfis","bulk_create"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Bulk create RFIs\n\nCreate up to 100 RFIs. Each item is the body of POST …/rfis without the `rfi` wrapper. Items run in order; a failing item does not roll back the others. Successful items have status 201.","body":{"mode":"raw","raw":"{\n  \"rfis\": [\n    {\n      \"question\": {\n        \"body\": \"\"\n      },\n      \"rfi_manager_id\": 0,\n      \"subject\": \"\"\n    }\n  ]\n}","options":{"raw":{"language":"json"}}}}},{"id":"d172fa36-74e5-4831-8345-a160d9f6619d","name":"listProjectRfisDefaultDistribution — List RFI Default Distribution","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/rfis/default_distribution","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","rfis","default_distribution"],"query":[{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"List RFI Default Distribution"}},{"id":"7a49f857-bd21-4ed3-8390-49c298e0921d","name":"listProjectRfisExport — Download RFIs List","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/rfis/export","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","rfis","export"],"query":[{"key":"filters[query]","value":"","disabled":true},{"key":"export_format","value":"","disabled":true},{"key":"table_configuration_for_export","value":"","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Download RFIs List\n\nDownload the RFIs the caller can see as CSV (default) or PDF. Accepts the list filters (filters[...]) and filters[query] search. table_configuration_for_export is a JSON string; hidden columns are left out. At most 5,000 RFIs; larger matches return 422."}},{"id":"8268ea33-cfb5-4a9e-8f7a-0fdfd8cf079a","name":"listProjectRfisFilterOptions — List available RFI filters","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/rfis/filter_options","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","rfis","filter_options"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"List available RFI filters\n\nThe filter keys the RFI list accepts (key = filters[<key>] parameter, value = label). Options per key: …/filter_options/{key}."}},{"id":"445da5e2-59b7-4f59-8b13-c86f98ce8b56","name":"listProjectRfisFilterOptionsAssignedId — List available RFI assigned_id filter options","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/rfis/filter_options/assigned_id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","rfis","filter_options","assigned_id"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"List available RFI assigned_id filter options\n\nOptions from the RFIs the caller can see, sorted by label. key is the id (or priority ordinal) to pass as the filter value."}},{"id":"7ec5c01e-b87c-495b-811b-1e9c96d9cece","name":"listProjectRfisFilterOptionsBallInCourtId — List available RFI ball in court filter options","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/rfis/filter_options/ball_in_court_id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","rfis","filter_options","ball_in_court_id"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"List available RFI ball in court filter options\n\nOptions from the RFIs the caller can see, sorted by label. key is the id (or priority ordinal) to pass as the filter value."}},{"id":"9c0846db-26e3-4b04-8059-2eea2895b6ed","name":"listProjectRfisFilterOptionsCostCodeId — List available RFI cost code options","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/rfis/filter_options/cost_code_id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","rfis","filter_options","cost_code_id"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"List available RFI cost code options\n\nOptions from the RFIs the caller can see, sorted by label. key is the id (or priority ordinal) to pass as the filter value."}},{"id":"0681dce3-5f48-4452-811b-2e5d219f44ce","name":"listProjectRfisFilterOptionsLocationId — List available RFIs locations","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/rfis/filter_options/location_id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","rfis","filter_options","location_id"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"List available RFIs locations\n\nOptions from the RFIs the caller can see, sorted by label. key is the id (or priority ordinal) to pass as the filter value."}},{"id":"dad644d1-fd95-4f50-8f04-f91db621d84c","name":"listProjectRfisFilterOptionsPrefixStageId — List available RFI Prefix Stage filter options","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/rfis/filter_options/prefix_stage_id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","rfis","filter_options","prefix_stage_id"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"List available RFI Prefix Stage filter options\n\nOptions from the RFIs the caller can see, sorted by label. key is the id (or priority ordinal) to pass as the filter value."}},{"id":"c5983db9-de7d-45b0-82af-9415d5f415f7","name":"listProjectRfisFilterOptionsPriority — List available RFI Priority filter options","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/rfis/filter_options/priority","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","rfis","filter_options","priority"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"List available RFI Priority filter options\n\nOptions from the RFIs the caller can see, sorted by label. key is the id (or priority ordinal) to pass as the filter value."}},{"id":"8e26eb5b-50fa-4136-89f2-4108ae9f2dfb","name":"listProjectRfisFilterOptionsReceivedFromLoginInformationId — List available RFI received from filter options","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/rfis/filter_options/received_from_login_information_id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","rfis","filter_options","received_from_login_information_id"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"List available RFI received from filter options\n\nOptions from the RFIs the caller can see, sorted by label. key is the id (or priority ordinal) to pass as the filter value."}},{"id":"ea07c05e-0f0a-45fd-8067-38c3e83d646e","name":"listProjectRfisFilterOptionsResponsibleContractorId — List available RFI responsible contractor filter options","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/rfis/filter_options/responsible_contractor_id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","rfis","filter_options","responsible_contractor_id"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"List available RFI responsible contractor filter options\n\nOptions from the RFIs the caller can see, sorted by label. key is the id (or priority ordinal) to pass as the filter value."}},{"id":"ba007a1f-26d0-4020-85d2-615394dd9c50","name":"listProjectRfisFilterOptionsRfiManagerId — List available RFI RFI Manager filter options","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/rfis/filter_options/rfi_manager_id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","rfis","filter_options","rfi_manager_id"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"List available RFI RFI Manager filter options\n\nOptions from the RFIs the caller can see, sorted by label. key is the id (or priority ordinal) to pass as the filter value."}},{"id":"f3393734-cf58-4ca0-8c52-0975a5fb8bfe","name":"listProjectRfisFilterOptionsStatus — List available RFI status filter options","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/rfis/filter_options/status","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","rfis","filter_options","status"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"List available RFI status filter options"}},{"id":"7c233080-a34c-4761-8658-e2c1f619055d","name":"listProjectRfisFilterOptionsSubJobId — List available RFI Sub Job filter options","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/rfis/filter_options/sub_job_id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","rfis","filter_options","sub_job_id"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"List available RFI Sub Job filter options\n\nOptions from the RFIs the caller can see, sorted by label. key is the id (or priority ordinal) to pass as the filter value."}},{"id":"705530e9-a3ac-488b-8336-08ccd0949454","name":"listProjectRfisPotentialAssignees — Get a list of possible assignees for an RFI","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/rfis/potential_assignees","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","rfis","potential_assignees"],"query":[{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Get a list of possible assignees for an RFI"}},{"id":"6cc69a3d-b97d-4271-8cde-56772f9525db","name":"listProjectRfisPotentialRfiManagers — Get a list of possible RFI Managers for an RFI","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/rfis/potential_rfi_managers","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","rfis","potential_rfi_managers"],"query":[{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Get a list of possible RFI Managers for an RFI\n\nActive project users who can act as RFI Manager: RFI admin level, or the act_as_rfi_manager granular permission."}},{"id":"e845b922-3f0f-4528-8427-2b10fd52dc49","name":"listProjectRfisRecycleBin — List Recycled RFIs","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/rfis/recycle_bin","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","rfis","recycle_bin"],"query":[{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true},{"key":"filters[updated_at]","value":"","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"List Recycled RFIs"}},{"id":"b79cbb10-e430-4cee-8566-ed36bf83d1a9","name":"getProjectRfi — Show RFI","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/rfis/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","rfis",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Show RFI"}},{"id":"c0272bb2-5245-488c-8048-90610958696d","name":"updateProjectRfi — Update RFI","request":{"method":"PATCH","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/rfis/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","rfis",":id"],"query":[{"key":"run_configurable_validations","value":"","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Update RFI","body":{"mode":"raw","raw":"{\n  \"rfi\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"a20f0670-0217-49e0-838e-d3f013bcac36","name":"advanceBallInCourtProjectRfi — Update Advance Ball in Court","request":{"method":"PATCH","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/rfis/:id/advance_ball_in_court","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","rfis",":id","advance_ball_in_court"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Update Advance Ball in Court"}},{"id":"f87aae16-f8f6-43dc-890e-ce595771e9c0","name":"forwardForReviewProjectRfi — Update Forward For Review","request":{"method":"PATCH","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/rfis/:id/forward_for_review","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","rfis",":id","forward_for_review"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Update Forward For Review","body":{"mode":"raw","raw":"{\n  \"rfi\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"42a7a420-1f1f-4740-8b12-9cdd7db47cae","name":"listProjectRfiPdf — Download RFI as PDF","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/rfis/:id/pdf","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","rfis",":id","pdf"],"query":[{"key":"only_official","value":"","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Download RFI as PDF\n\nThe RFI as a PDF: general information, each question and its responses (official responses flagged). only_official=true keeps only official responses."}},{"id":"9370c71c-7dcb-42a4-845f-8b300c9daaac","name":"recycleProjectRfi — Recycle RFI","request":{"method":"PATCH","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/rfis/:id/recycle","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","rfis",":id","recycle"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Recycle RFI"}},{"id":"00d78b18-8dd6-4b66-891e-710977d2566b","name":"deleteRecycleProjectRfi — Move RFI to the recycle bin","request":{"method":"DELETE","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/rfis/:id/recycle","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","rfis",":id","recycle"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Move RFI to the recycle bin"}},{"id":"ec482578-e0dd-479b-83ba-5c7a4143ceb4","name":"listProjectRfiRelatedItems — List RFI related items","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/rfis/:id/related_items","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","rfis",":id","related_items"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"List RFI related items\n\nRequires the `view` permission on the project's RFIs tool. A scoped API token needs `rfis:read`.","body":{"mode":"raw","raw":"{\n  \"related_item\": {\n    \"item_id\": 0,\n    \"item_type\": \"rfis\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"610bb41e-37b6-4d63-89f4-78379d2e447c","name":"createProjectRfiRelatedItem — Create RFI related item","request":{"method":"POST","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/rfis/:id/related_items","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","rfis",":id","related_items"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Create RFI related item"}},{"id":"653adf7a-d3fe-40b1-81ae-cfd7bf8ab176","name":"deleteProjectRfiRelatedItem — Delete RFI related item","request":{"method":"DELETE","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/rfis/:id/related_items/:related_item_id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","rfis",":id","related_items",":related_item_id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""},{"key":"related_item_id","value":""}]},"description":"Delete RFI related item"}},{"id":"cf0cfa95-5bd0-4676-8720-0db2732f9445","name":"retrieveProjectRfi — Retrieve Recycled RFI","request":{"method":"PATCH","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/rfis/:id/retrieve","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","rfis",":id","retrieve"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Retrieve Recycled RFI\n\nRestore an RFI from the Recycle Bin. Requires RFI delete permission."}},{"id":"dec30df1-fc35-4e77-8dca-532b48b1dbe9","name":"listProjectRfiReplies — List RFI Replies","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/rfis/:rfi_id/replies","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","rfis",":rfi_id","replies"],"query":[{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"rfi_id","value":""}]},"description":"List RFI Replies"}},{"id":"d0cd4460-4fd3-413c-8cca-ab7d3fb39c1e","name":"createProjectRfiReply — Create RFI Reply","request":{"method":"POST","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/rfis/:rfi_id/replies","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","rfis",":rfi_id","replies"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"rfi_id","value":""}]},"description":"Create RFI Reply","body":{"mode":"raw","raw":"{\n  \"attachments\": [\n    \"\"\n  ],\n  \"reply\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"58f41883-8ad4-4894-8647-46016043d101","name":"getProjectRfiReply — Show RFI Reply","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/rfis/:rfi_id/replies/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","rfis",":rfi_id","replies",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"rfi_id","value":""},{"key":"id","value":""}]},"description":"Show RFI Reply"}},{"id":"7b060750-3069-44b7-86e6-b42b1c2883a0","name":"updateProjectRfiReply — Update RFI Reply","request":{"method":"PATCH","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/rfis/:rfi_id/replies/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","rfis",":rfi_id","replies",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"rfi_id","value":""},{"key":"id","value":""}]},"description":"Update RFI Reply","body":{"mode":"raw","raw":"{\n  \"reply\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"3f2a474c-e76c-4327-8320-d7b26ae12155","name":"deleteProjectRfiReply — Delete an RFI Response","request":{"method":"DELETE","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/rfis/:rfi_id/replies/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","rfis",":rfi_id","replies",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"rfi_id","value":""},{"key":"id","value":""}]},"description":"Delete an RFI Response\n\nDelete a response on an open RFI. RFI admins may delete any response; others only their own response that is not official."}},{"id":"a3c07a67-bdc0-492a-89a9-71ccccfef91b","name":"listProjectRfisExportV11 — Download RFIs List","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.1/projects/:project_id/rfis/export","host":["{{baseUrl}}"],"path":["rest","v1.1","projects",":project_id","rfis","export"],"query":[{"key":"filters[query]","value":"","disabled":true},{"key":"export_format","value":"","disabled":true},{"key":"table_configuration_for_export","value":"","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Download RFIs List\n\nDownload the RFIs the caller can see as CSV (default) or PDF. Accepts the list filters (filters[...]) and filters[query] search. table_configuration_for_export is a JSON string; hidden columns are left out. At most 5,000 RFIs; larger matches return 422."}},{"id":"5f2427ae-10d2-4e39-882e-90c616463286","name":"advanceBallInCourtProjectRfiV11 — Update Advance Ball in Court","request":{"method":"PATCH","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.1/projects/:project_id/rfis/:id/advance_ball_in_court","host":["{{baseUrl}}"],"path":["rest","v1.1","projects",":project_id","rfis",":id","advance_ball_in_court"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Update Advance Ball in Court"}},{"id":"f5fe4ab1-69d7-45c0-8835-bdb66d25d5da","name":"forwardForReviewProjectRfiV11 — Update Forward For Review","request":{"method":"PATCH","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.1/projects/:project_id/rfis/:id/forward_for_review","host":["{{baseUrl}}"],"path":["rest","v1.1","projects",":project_id","rfis",":id","forward_for_review"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Update Forward For Review","body":{"mode":"raw","raw":"{\n  \"rfi\": {}\n}","options":{"raw":{"language":"json"}}}}}]},{"name":"RFQs","description":"Module: rfqs","item":[{"id":"1d200bf8-d9ba-4577-8f6f-57dc392e0038","name":"listRfqs — List RFQs","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/rfqs","host":["{{baseUrl}}"],"path":["rest","v1.0","rfqs"],"query":[{"key":"project_id","value":"","disabled":false},{"key":"contract_id","value":"","disabled":false},{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true},{"key":"filters[status]","value":"","disabled":true},{"key":"filters[created_at]","value":"","disabled":true},{"key":"filters[updated_at]","value":"","disabled":true},{"key":"filters[commitment_contract_id]","value":"","disabled":true}]},"description":"List RFQs"}},{"id":"24762797-9f5f-4729-8f5e-e6e1c896d396","name":"createRfq — Create RFQ","request":{"method":"POST","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/rfqs","host":["{{baseUrl}}"],"path":["rest","v1.0","rfqs"]},"description":"Create RFQ","body":{"mode":"raw","raw":"{\n  \"contract_id\": 0,\n  \"project_id\": 0,\n  \"rfq\": {\n    \"title\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"c43e95ec-7aca-4a06-88bf-7c1cd626f3a6","name":"listRfqsFilterOptionsStatus — List RFQs filter options for status","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/rfqs/filter_options/status","host":["{{baseUrl}}"],"path":["rest","v1.0","rfqs","filter_options","status"],"query":[{"key":"project_id","value":"","disabled":false}]},"description":"List RFQs filter options for status\n\nRequires the `view` permission on the project's RFQs tool. A scoped API token needs `rfqs:read`."}},{"id":"b06e6064-05cd-43bf-8b4d-d2929118f3ce","name":"getRfq — Show RFQ","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/rfqs/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","rfqs",":id"],"query":[{"key":"project_id","value":"","disabled":false},{"key":"contract_id","value":"","disabled":false}],"variable":[{"key":"id","value":""}]},"description":"Show RFQ"}},{"id":"633e33ab-4f54-4bfb-84b7-fc252f0c3033","name":"updateRfq — Update RFQ","request":{"method":"PATCH","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/rfqs/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","rfqs",":id"],"variable":[{"key":"id","value":""}]},"description":"Update RFQ","body":{"mode":"raw","raw":"{\n  \"contract_id\": 0,\n  \"project_id\": 0,\n  \"rfq\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"877fad62-3266-4b38-8fd9-06b3f3c8e094","name":"deleteRfq — Delete RFQ","request":{"method":"DELETE","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/rfqs/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","rfqs",":id"],"query":[{"key":"project_id","value":"","disabled":false},{"key":"contract_id","value":"","disabled":false}],"variable":[{"key":"id","value":""}]},"description":"Delete RFQ"}},{"id":"99b8039c-1ad5-4cea-86b3-0c7aa8779c58","name":"awardRfq — Award RFQ","request":{"method":"PATCH","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/rfqs/:id/award","host":["{{baseUrl}}"],"path":["rest","v1.0","rfqs",":id","award"],"variable":[{"key":"id","value":""}]},"description":"Award RFQ"}},{"id":"c69eb481-034b-4640-872d-50d4e7ab381e","name":"changeEventRfq — Create change event from RFQ","request":{"method":"POST","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/rfqs/:id/change_event","host":["{{baseUrl}}"],"path":["rest","v1.0","rfqs",":id","change_event"],"variable":[{"key":"id","value":""}]},"description":"Create change event from RFQ"}},{"id":"0ae5eaad-04d7-4662-8766-75fa13ff0a9b","name":"listRfqQuoters — List RFQ quoters","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/rfqs/:id/quoters","host":["{{baseUrl}}"],"path":["rest","v1.0","rfqs",":id","quoters"],"variable":[{"key":"id","value":""}]},"description":"List RFQ quoters\n\nRequires the `view` permission on the project's RFQs tool. A scoped API token needs `rfqs:read`.","body":{"mode":"raw","raw":"{\n  \"vendor_ids\": [\n    0\n  ]\n}","options":{"raw":{"language":"json"}}}}},{"id":"ef910edf-45ce-4fba-8ed9-4b14d0e8b471","name":"createRfqQuoter — Create RFQ quoter","request":{"method":"POST","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/rfqs/:id/quoters","host":["{{baseUrl}}"],"path":["rest","v1.0","rfqs",":id","quoters"],"variable":[{"key":"id","value":""}]},"description":"Create RFQ quoter"}},{"id":"5d8a3999-caed-4ef1-8e00-3545fc01941f","name":"listRfqQuotes — List RFQ Quotes","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/rfqs/:rfq_id/quotes","host":["{{baseUrl}}"],"path":["rest","v1.0","rfqs",":rfq_id","quotes"],"query":[{"key":"project_id","value":"","disabled":false},{"key":"contract_id","value":"","disabled":false},{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true}],"variable":[{"key":"rfq_id","value":""}]},"description":"List RFQ Quotes"}},{"id":"35a4b874-b348-43ca-8e14-7af23348a786","name":"createRfqQuote — Create RFQ Quote","request":{"method":"POST","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/rfqs/:rfq_id/quotes","host":["{{baseUrl}}"],"path":["rest","v1.0","rfqs",":rfq_id","quotes"],"variable":[{"key":"rfq_id","value":""}]},"description":"Create RFQ Quote","body":{"mode":"raw","raw":"{\n  \"contract_id\": 0,\n  \"project_id\": 0,\n  \"rfq_quote\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"bdf740a7-fa22-4af5-850e-a48d5403109e","name":"getRfqQuote — Show RFQ Quote","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/rfqs/:rfq_id/quotes/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","rfqs",":rfq_id","quotes",":id"],"query":[{"key":"project_id","value":"","disabled":false},{"key":"contract_id","value":"","disabled":false}],"variable":[{"key":"rfq_id","value":""},{"key":"id","value":""}]},"description":"Show RFQ Quote"}},{"id":"bc1c1a50-5686-4280-8bab-67c728ea7397","name":"updateRfqQuote — Update RFQ Quote","request":{"method":"PATCH","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/rfqs/:rfq_id/quotes/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","rfqs",":rfq_id","quotes",":id"],"variable":[{"key":"rfq_id","value":""},{"key":"id","value":""}]},"description":"Update RFQ Quote\n\nCorrect a submitted quote before the RFQ is awarded (awarded pricing is frozen: 409). Needs RFQ edit permission and RFQ visibility. `cost` cannot change on a quote with line items (422): its total is the sum of the lines. project_id is optional (resolved from the RFQ when omitted); contract_id is accepted and ignored.","body":{"mode":"raw","raw":"{\n  \"contract_id\": 0,\n  \"project_id\": 0,\n  \"rfq_quote\": {}\n}","options":{"raw":{"language":"json"}}}}}]},{"name":"Schedule","description":"Module: schedule","item":[{"id":"904b2c40-b7ac-4e94-8e78-f18a7207dda7","name":"listCompanySchedules — Portfolio of project schedules","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/schedules","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","schedules"],"query":[{"key":"region","value":"","disabled":true},{"key":"stage","value":"","disabled":true},{"key":"project_type","value":"","disabled":true},{"key":"q","value":"","disabled":true},{"key":"pm","value":"","disabled":true,"description":"Project Manager user id (project team role)"},{"key":"status","value":"","disabled":true},{"key":"program_id","value":"","disabled":true,"description":"Portfolio program membership"}],"variable":[{"key":"company_id","value":"{{companyId}}"}]},"description":"Portfolio of project schedules\n\nCompany-scoped. Strict per-project RBAC: only active projects of the caller's company with the Schedule tool enabled and Schedule access are listed; calculated dates, float, health, links and program results require live Schedule admin on every project involved. All responses are private, no-store. Requires schedule:read. One row per visible project with current version, data date, start/finish, baseline finish variance, critical and negative-float counts, DCMA health grade, last update, schedule status, Project Managers and up to 12 key milestones, plus summary Gantt axis, filter choices (from visible rows only), totals and inter-project links where both ends are administered. Stored engine results only; nothing is recalculated."}},{"id":"8254e08d-fff8-4cf4-80f8-7ebacb342a1f","name":"listCompanySchedulesAnalysisJobs — List company-scoped background schedule analysis jobs","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/schedules/analysis-jobs","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","schedules","analysis-jobs"],"query":[{"key":"active","value":"","disabled":true},{"key":"before_id","value":"","disabled":true},{"key":"page_size","value":"","disabled":true}],"variable":[{"key":"company_id","value":"{{companyId}}"}]},"description":"List company-scoped background schedule analysis jobs\n\nProgram calculations queued as background jobs, newest first. Lists only jobs whose every covered project is one where the caller is Schedule admin; a page can therefore hold fewer than `page_size` jobs (follow `next_before_id`). Requires schedule:read token scope. Filters: `active=true|false` (queued or running only), `before_id`, `page_size` (1-100, default 25). Private, no-store."}},{"id":"303e9bd4-a9b6-466e-885f-40b744ad82a6","name":"getCompanySchedulesAnalysisJob — Read a company-scoped background schedule analysis job","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/schedules/analysis-jobs/:job_id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","schedules","analysis-jobs",":job_id"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"job_id","value":""}]},"description":"Read a company-scoped background schedule analysis job\n\nStatus, progress and, once completed, the retained program run (`resource.type` = `schedule_program_run`, read it at /program-runs/{run_id}). Requires live Schedule admin on every project the job covers and schedule:read token scope. Active jobs carry `Retry-After: 2`. No query parameters."}},{"id":"63b3b892-b6bf-499c-8415-9617c7f8d428","name":"cancelCompanySchedulesAnalysisJob — Cancel a company-scoped background schedule analysis job","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/schedules/analysis-jobs/:job_id/cancel","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","schedules","analysis-jobs",":job_id","cancel"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"job_id","value":""}]},"description":"Cancel a company-scoped background schedule analysis job\n\nCancels a queued program calculation, or stops a running one and kills its engine child. Finished jobs are returned unchanged. A run whose result was being persisted at the moment of cancellation may still be retained. Requires live Schedule admin on every project the job covers and schedule:write token scope. No body or query parameters."}},{"id":"f11c489f-ef6d-45c0-82e8-b8acddb5f5df","name":"listCompanySchedulesProgramLinks — List inter-project schedule links","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/schedules/program-links","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","schedules","program-links"],"query":[{"key":"project_id","value":"","disabled":true,"description":"Links touching this project"}],"variable":[{"key":"company_id","value":"{{companyId}}"}]},"description":"List inter-project schedule links\n\nCompany-scoped. Strict per-project RBAC: only active projects of the caller's company with the Schedule tool enabled and Schedule access are listed; calculated dates, float, health, links and program results require live Schedule admin on every project involved. All responses are private, no-store. Requires schedule:read. Only links whose both projects the caller administers. Endpoints report stale when the activity is no longer in that project's current saved version."}},{"id":"acacd71b-78a5-487e-8d46-125738419d2d","name":"createCompanySchedulesProgramLink — Link activities in two different projects","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/schedules/program-links","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","schedules","program-links"],"variable":[{"key":"company_id","value":"{{companyId}}"}]},"description":"Link activities in two different projects\n\nCompany-scoped. Strict per-project RBAC: only active projects of the caller's company with the Schedule tool enabled and Schedule access are listed; calculated dates, float, health, links and program results require live Schedule admin on every project involved. All responses are private, no-store. Requires schedule:write. Both activities must exist in their project's current saved version. Stored per company (tenant-checked by a database guard), never written into either schedule. Audited in both projects. No query parameters.","body":{"mode":"raw","raw":"{\n  \"predecessor_activity_id\": \"\",\n  \"predecessor_project_id\": 0,\n  \"successor_activity_id\": \"\",\n  \"successor_project_id\": 0\n}","options":{"raw":{"language":"json"}}}}},{"id":"4863f132-ebbb-4878-8266-2f7f9955f150","name":"updateCompanySchedulesProgramLink — Change a link's type, lag, category or note","request":{"method":"PATCH","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/schedules/program-links/:link_id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","schedules","program-links",":link_id"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"link_id","value":""}]},"description":"Change a link's type, lag, category or note\n\nCompany-scoped. Strict per-project RBAC: only active projects of the caller's company with the Schedule tool enabled and Schedule access are listed; calculated dates, float, health, links and program results require live Schedule admin on every project involved. All responses are private, no-store. Requires schedule:write. Endpoints are immutable; re-point by deleting and creating. Audited in both projects. No query parameters.","body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}}}},{"id":"9ad83bd9-a63c-4fbb-86b3-201393ec0526","name":"deleteCompanySchedulesProgramLink — Remove an inter-project link","request":{"method":"DELETE","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/schedules/program-links/:link_id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","schedules","program-links",":link_id"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"link_id","value":""}]},"description":"Remove an inter-project link\n\nCompany-scoped. Strict per-project RBAC: only active projects of the caller's company with the Schedule tool enabled and Schedule access are listed; calculated dates, float, health, links and program results require live Schedule admin on every project involved. All responses are private, no-store. Requires schedule:write. Audited in both projects. No query parameters."}},{"id":"cf8713c7-c863-44a7-8d97-2909e1ca5125","name":"listCompanySchedulesProgramRuns — List program calculations","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/schedules/program-runs","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","schedules","program-runs"],"query":[{"key":"before_id","value":"","disabled":true},{"key":"page_size","value":"","disabled":true}],"variable":[{"key":"company_id","value":"{{companyId}}"}]},"description":"List program calculations\n\nCompany-scoped. Strict per-project RBAC: only active projects of the caller's company with the Schedule tool enabled and Schedule access are listed; calculated dates, float, health, links and program results require live Schedule admin on every project involved. All responses are private, no-store. Requires schedule:read. Only runs whose every project the caller administers. Newest first."}},{"id":"732a682b-e486-4b6f-8725-ee34fc3c1312","name":"createCompanySchedulesProgramRun — Calculate the program (joint multi-project network)","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/schedules/program-runs","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","schedules","program-runs"],"query":[{"key":"async","value":"","disabled":true,"description":"`1` always queues a background schedule analysis job (202); `0` forces the inline path (30 s engine limit). Omitted: programs above the size threshold (estimated engine time over 10 s: (2 + slip scenarios) × total member activities) are queued automatically."}],"variable":[{"key":"company_id","value":"{{companyId}}"}]},"description":"Calculate the program (joint multi-project network)\n\nCompany-scoped. Strict per-project RBAC: only active projects of the caller's company with the Schedule tool enabled and Schedule access are listed; calculated dates, float, health, links and program results require live Schedule admin on every project involved. All responses are private, no-store. Requires schedule:write. Calculates the selected projects' current saved versions as one network with the inter-project links between them (each project keeps its data date, planned start and deadline; float is per project). Default selection is every administered project connected by links; or project_ids, or a portfolio program (administered members only). Returns per-project joint vs standalone dates, cross-project driving paths, link-by-link driving and delay with the external constraint each implies, and slip impacts (each project's outgoing links slip_days late, plus an optional selected slip). Retained as immutable evidence pinned to the versions; never writes into any schedule. Only the `async` query parameter. Large programs run as a durable background schedule analysis job (company-scoped, kind `program`): the job re-checks the selection and every member's pinned version before calculating and retains the same program run the inline path would.","body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}}}},{"id":"960bd7c7-0978-424d-83b9-3542fc213585","name":"getCompanySchedulesProgramRun — Read a program calculation","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/schedules/program-runs/:run_id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","schedules","program-runs",":run_id"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"run_id","value":""}]},"description":"Read a program calculation\n\nCompany-scoped. Strict per-project RBAC: only active projects of the caller's company with the Schedule tool enabled and Schedule access are listed; calculated dates, float, health, links and program results require live Schedule admin on every project involved. All responses are private, no-store. Requires schedule:read. stale_project_ids lists projects whose current version differs from the pinned one. No query parameters."}},{"id":"54673c61-b5b2-430a-8d9f-373e083007e8","name":"proposeConstraintCompanySchedulesProgramRun — Propose an external constraint as a what-if scenario in the affected project","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/schedules/program-runs/:run_id/propose-constraint","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","schedules","program-runs",":run_id","propose-constraint"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"run_id","value":""}]},"description":"Propose an external constraint as a what-if scenario in the affected project\n\nCompany-scoped. Strict per-project RBAC: only active projects of the caller's company with the Schedule tool enabled and Schedule access are listed; calculated dates, float, health, links and program results require live Schedule admin on every project involved. All responses are private, no-store. Requires schedule:write. Creates an open scenario in the link's successor project (base: the run's pinned version, which must still be current) with one set_constraint edit: start on or after (FS/SS) or finish on or after (FF/SF) the date the joint network gives that activity. Idempotent by request_id. Nothing is adopted; review and adopt through the project's scenarios. No query parameters.","body":{"mode":"raw","raw":"{\n  \"link_id\": 0,\n  \"request_id\": \"\"\n}","options":{"raw":{"language":"json"}}}}},{"id":"7e79ea17-cd37-4435-849b-306e61f54e67","name":"proposeLevelingCompanySchedulesProgramRun — Propose one project's levelling moves as a what-if scenario","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/schedules/program-runs/:run_id/propose-leveling","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","schedules","program-runs",":run_id","propose-leveling"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"run_id","value":""}]},"description":"Propose one project's levelling moves as a what-if scenario\n\nCreates an open scenario in the named project (base: the run's pinned version, which must still be current) with one set_constraint start_on_or_after edit per levelling move. Idempotent by request_id. Nothing is adopted. No query parameters.","body":{"mode":"raw","raw":"{\n  \"project_id\": 0,\n  \"request_id\": \"\"\n}","options":{"raw":{"language":"json"}}}}},{"id":"05177d12-af86-4f15-847f-dc65ba3b50f9","name":"createCompanySchedulesResourceLeveling — Level resources shared across projects (advisory)","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/schedules/resource-leveling","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","schedules","resource-leveling"],"query":[{"key":"async","value":"","disabled":true,"description":"`1` always queues a background schedule analysis job (202); `0` forces the inline path (30 s engine limit). Omitted: programs above the size threshold (estimated engine time over 10 s: (2 + slip scenarios) × total member activities) are queued automatically."}],"variable":[{"key":"company_id","value":"{{companyId}}"}]},"description":"Level resources shared across projects (advisory)\n\nCompany-scoped. Resources whose retained identity mappings name the same person, crew or equipment record in two or more administered projects are levelled over the joint network of those projects (cpmcore.portfolio.shared_resource_demand, then cpmcore.levelling in advisory mode). A shared identity's capacity is the lowest any member project states. Retains a program run (parameters.kind resource_leveling) whose result carries resource_levelling; per-project scenario proposals are created through propose-leveling. Nothing is written to any schedule. Same async negotiation as program-runs; the background job kind is program_leveling. 400 when no resource is shared.","body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}}}},{"id":"f1e47262-7b4a-4c3e-8849-2fbc8cdf8d76","name":"listCompanySchedulesResources — Portfolio resource demand against capacity","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/schedules/resources","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","schedules","resources"],"query":[{"key":"program_id","value":"","disabled":true},{"key":"project_ids","value":"","disabled":true,"description":"Comma-separated, at most 25"}],"variable":[{"key":"company_id","value":"{{companyId}}"}]},"description":"Portfolio resource demand against capacity\n\nCompany-scoped. Strict per-project RBAC: only active projects of the caller's company with the Schedule tool enabled and Schedule access are listed; calculated dates, float, health, links and program results require live Schedule admin on every project involved. All responses are private, no-store. Requires schedule:read; mapping and workforce reports additionally follow owning-tool permissions and workforce:read / equipment:read / materials:read token scopes (unreadable reports are listed as not_visible). From retained evidence of current versions only: per-person workforce demand summed across projects against recorded availability, shared person/crew/equipment identities (explicit retained mappings in two or more projects) with periods of concurrent demand, and unverified same-name candidates. Nothing is calculated, reserved or levelled."}},{"id":"ee2946c7-8e7e-4739-8e82-a59054b0d758","name":"listProjectSchedule — Get Schedule Metadata","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Get Schedule Metadata"}},{"id":"2c51324d-dedb-4e54-875d-926d2aea4452","name":"scheduleProject — Update Schedule Metadata","request":{"method":"PATCH","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Update Schedule Metadata","body":{"mode":"raw","raw":"{\n  \"project_id\": 0,\n  \"type\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"ca31d09c-8bc3-4ac8-83be-dc2f40ade2a5","name":"listProjectScheduleActivityComments — List activity discussion","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/activity-comments","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","activity-comments"],"query":[{"key":"activity_id","value":"","disabled":true},{"key":"status","value":"","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"List activity discussion\n\nRequires schedule:read and live Schedule view access on the project. Non-admins only see discussion on activities bound to a field task they can see; private threads are visible to their author only. Threads (root comments with their replies) in order, with open/resolved/total counts."}},{"id":"dca3c985-cefd-423c-8d09-edb83b7eabad","name":"createProjectScheduleActivityComment — Comment on an activity or reply","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/activity-comments","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","activity-comments"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Comment on an activity or reply\n\nRequires schedule:write and live Schedule edit access on the project. Mentions notify (in-app and by preference email) only people who currently have Schedule access to the activity; a reply also notifies the thread's earlier participants. Audited without the text.","body":{"mode":"raw","raw":"{\n  \"body\": \"\"\n}","options":{"raw":{"language":"json"}}}}},{"id":"1d176fc4-0fc8-43cc-8dab-f307e1311556","name":"listProjectScheduleActivityCommentsCounts — Comment counts per activity","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/activity-comments/counts","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","activity-comments","counts"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Comment counts per activity\n\nRequires schedule:read and live Schedule view access on the project. Non-admins only see discussion on activities bound to a field task they can see; private threads are visible to their author only. Open threads, resolved threads and live comments per canonical activity id (the planner's Open Comments / Comments columns)."}},{"id":"133a6286-8197-4a97-8467-c9441f044452","name":"listProjectScheduleActivityCommentsMentionable — People a mention can reach","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/activity-comments/mentionable","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","activity-comments","mentionable"],"query":[{"key":"activity_id","value":"","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"People a mention can reach\n\nRequires schedule:read and live Schedule view access on the project. Active project users (and company admins) with Schedule access; with `activity_id`, only those who can see that activity."}},{"id":"ae3c11a8-a402-4935-8aa5-1cbbde97dfbe","name":"updateProjectScheduleActivityComment — Edit or resolve a comment","request":{"method":"PATCH","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/activity-comments/:comment_id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","activity-comments",":comment_id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"comment_id","value":""}]},"description":"Edit or resolve a comment\n\nRequires schedule:write and live Schedule edit access on the project. Edit your own comment's text (newly mentioned people are notified) or resolve / reopen a thread root. Audited.","body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}}}},{"id":"8beddcf1-bb08-45c2-8170-1e608e656d42","name":"deleteProjectScheduleActivityComment — Delete a comment","request":{"method":"DELETE","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/activity-comments/:comment_id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","activity-comments",":comment_id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"comment_id","value":""}]},"description":"Delete a comment\n\nRequires schedule:write and live Schedule edit access on the project. Your own comments (Schedule admins: any). The comment keeps its place in the thread with no text. Audited."}},{"id":"542b78ba-cf7e-429a-80d7-fa4c417db937","name":"listProjectScheduleAnalysisJobs — List background schedule analysis jobs","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/analysis-jobs","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","analysis-jobs"],"query":[{"key":"kind","value":"","disabled":true},{"key":"active","value":"","disabled":true},{"key":"scenario_id","value":"","disabled":true},{"key":"before_id","value":"","disabled":true},{"key":"page_size","value":"","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"List background schedule analysis jobs\n\nNewest first. Requires live Schedule admin access and schedule:read token scope. Filters: `kind`, `active=true|false` (queued or running only), `scenario_id`, `before_id`, `page_size` (1-100, default 25). Private, no-store."}},{"id":"2389aa1a-8d6b-40ce-8e46-b800581dd6a2","name":"getProjectScheduleAnalysisJob — Read a background schedule analysis job","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/analysis-jobs/:job_id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","analysis-jobs",":job_id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"job_id","value":""}]},"description":"Read a background schedule analysis job\n\nStatus, progress and, once completed, the retained resource. Requires live Schedule admin access and schedule:read token scope. Active jobs carry `Retry-After: 2`. No query parameters."}},{"id":"b66db799-1d3c-407d-8ed7-a1c7e7ee0c9a","name":"cancelProjectScheduleAnalysisJob — Cancel a background schedule analysis job","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/analysis-jobs/:job_id/cancel","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","analysis-jobs",":job_id","cancel"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"job_id","value":""}]},"description":"Cancel a background schedule analysis job\n\nCancels a queued job, or stops a running one and kills its engine child. Finished jobs are returned unchanged. A run whose result was being persisted at the moment of cancellation may still be retained. Requires live Schedule admin access and schedule:write token scope. No body or query parameters."}},{"id":"4963d7ba-f820-48fe-852c-2aa8410ab900","name":"listProjectScheduleAssistant — Schedule assistant availability","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/assistant","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","assistant"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Schedule assistant availability\n\nRequires Schedule admin and the schedule:read token scope. enabled is true only when an AI provider key is configured, SCHEDULE_ASSISTANT_ENABLED=1, and the company has not turned AI off (ask_llm_enabled). No query parameters. Private, no-store."}},{"id":"e099e176-5107-45f9-89a4-5a68f3d380b5","name":"createProjectScheduleAssistant — Ask a grounded question about the schedule, or draft an update narrative","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/assistant","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","assistant"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Ask a grounded question about the schedule, or draft an update narrative\n\nRequires live Schedule admin access (complete-network dates and float can disclose private activities) and the schedule:read token scope. Reads only retained evidence: the saved head version, its own retained schedule calculation (exact input, no data-date override), a named baseline's original calculation, and the latest retained health, resource histogram and cost dashboard. Never runs the engine and never writes. All responses are private, no-store. Builds a bounded list of numbered facts from persisted evidence (versions, version diff, retained schedule, compare, health and risk calculations, retained date traces, open scenarios, and cost-loaded EVM only with budget:read and live Budget view) and asks the configured Claude model to answer only from them. Citations that do not match a fact are removed; an answer that cites nothing is retried once and then returned with grounded=false. The assistant never edits the schedule: a suggested change is returned as a scenario proposal validated against the base version, which the user may save as an open what-if scenario (POST /schedule/scenarios) and adopt explicitly. Counts against a per-user hourly cap (SCHEDULE_ASSISTANT_HOURLY_LIMIT, default 30). No query parameters.","body":{"mode":"raw","raw":"{\n  \"question\": \"\"\n}","options":{"raw":{"language":"json"}}}}},{"id":"e93bdbba-eb8a-4e55-8d26-f80ddd57fdd8","name":"listProjectScheduleBaselineAssignments — Get the project baseline and my baseline slots","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/baseline-assignments","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","baseline-assignments"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Get the project baseline and my baseline slots\n\nAssign Baselines (P6). Requires live Schedule admin access on the project. The project baseline is shared by everyone on the project and every change to it is recorded in the project audit log. Primary, secondary and tertiary baselines are the caller's own and never affect other users; the primary slot falls back to the project baseline when the caller has not chosen one. Assignments are view choices: they never change a schedule or a baseline. All responses are private, no-store. No query parameters. Requires schedule:read."}},{"id":"3b48fb4a-6eaa-44f7-858b-41c182caf461","name":"replaceProjectScheduleBaselineAssignments — Assign the project baseline or my primary, secondary and tertiary baselines","request":{"method":"PUT","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/baseline-assignments","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","baseline-assignments"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Assign the project baseline or my primary, secondary and tertiary baselines\n\nAssign Baselines (P6). Requires live Schedule admin access on the project. The project baseline is shared by everyone on the project and every change to it is recorded in the project audit log. Primary, secondary and tertiary baselines are the caller's own and never affect other users; the primary slot falls back to the project baseline when the caller has not chosen one. Assignments are view choices: they never change a schedule or a baseline. All responses are private, no-store. No query parameters. Requires schedule:write. Send only the fields to change; null clears a slot. Every baseline id must be a named baseline of this project.","body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}}}},{"id":"2cd44791-ec20-4b93-880a-ae10f7add1ad","name":"listProjectScheduleBaselines — List named schedule baselines","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/baselines","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","baselines"],"query":[{"key":"before_id","value":"","disabled":true},{"key":"page_size","value":"","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"List named schedule baselines\n\nSchedule admin and schedule:read required. Newest first, cursor pagination, private/no-store. Baselines remain fixed to their selected versions as the head changes."}},{"id":"0b68cf48-1acc-475c-8fef-e216231322f3","name":"createProjectScheduleBaseline — Create an immutable named schedule baseline","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/baselines","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","baselines"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Create an immutable named schedule baseline\n\nSchedule admin and schedule:write required. Select an explicit saved version. Does not approve a version, calculate or publish field tasks. Persist a UUID request_id across retries: identical actor and normalized input replay the original record with 200; changed selection conflicts. New records and audit events commit atomically. All responses are private/no-store.","body":{"mode":"raw","raw":"{\n  \"kind\": \"\",\n  \"name\": \"\",\n  \"request_id\": \"\",\n  \"version_id\": 0\n}","options":{"raw":{"language":"json"}}}}},{"id":"c7d0304e-d419-46f5-8d93-83b6f6ef2d48","name":"listProjectScheduleBaselineTimeline — Read original saved baseline timeline","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/baselines/:baseline_id/timeline","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","baselines",":baseline_id","timeline"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"baseline_id","value":""}]},"description":"Read original saved baseline timeline\n\nReturns the earliest exact-input schedule calculation retained no later than named baseline creation. Requires live project Schedule admin permission and schedule:read token scope. Responses are private, no-store. Does not recalculate, approve, publish or mutate a schedule. Activity dates are original engine wall-clock strings, or null when unavailable; do not reinterpret them as UTC instants. Includes calculation, engine and definition provenance. Rates, resources and unrelated result fields are excluded. No query parameters are accepted. Missing or inconsistent original evidence returns 409; responses exceeding 8 MiB return 413."}},{"id":"b702e5f4-2118-4f46-8f52-f5d0bdadd09d","name":"listProjectScheduleBudgetReports — List retained Budget reconciliation history","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/budget-reports","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","budget-reports"],"query":[{"key":"before_id","value":"","disabled":true},{"key":"version_id","value":"","disabled":true},{"key":"page_size","value":"","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"List retained Budget reconciliation history\n\nRequires schedule:read plus budget:read token scopes, live Schedule admin and Budget view permissions, and both tools enabled. Retains explicit activity/budget-line allocations and a point-in-time snapshot from the owning Budget service. Mapped plus unmapped totals reconcile exactly in cents. Currency is undeclared; these are not ledger actuals or an approved cost baseline. No budgets, forecasts, plan heads or field tasks are changed. Historical reports never refresh on read. Private, no-store. Metadata only, descending IDs; pass next_before_id as before_id. Optional version_id filter."}},{"id":"501fa54a-e735-460b-8036-3919e865cc45","name":"createProjectScheduleBudgetReport — Retain schedule Budget reconciliation","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/budget-reports","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","budget-reports"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Retain schedule Budget reconciliation\n\nRequires schedule:write plus budget:read token scopes, live Schedule admin and Budget view permissions, and both tools enabled. Retains explicit activity/budget-line allocations and a point-in-time snapshot from the owning Budget service. Mapped plus unmapped totals reconcile exactly in cents. Currency is undeclared; these are not ledger actuals or an approved cost baseline. No budgets, forecasts, plan heads or field tasks are changed. Historical reports never refresh on read. Private, no-store.","body":{"mode":"raw","raw":"{\n  \"expected_source_digest\": \"\",\n  \"mappings\": [\n    {\n      \"activity_id\": \"\",\n      \"allocation_basis_points\": 0,\n      \"budget_line_id\": 0\n    }\n  ],\n  \"version_id\": 0\n}","options":{"raw":{"language":"json"}}}}},{"id":"01df20bf-0cad-4829-8ca7-271b6d769c0e","name":"getProjectScheduleBudgetReport — Read retained Budget reconciliation","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/budget-reports/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","budget-reports",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Read retained Budget reconciliation\n\nRequires schedule:read plus budget:read token scopes, live Schedule admin and Budget view permissions, and both tools enabled. Retains explicit activity/budget-line allocations and a point-in-time snapshot from the owning Budget service. Mapped plus unmapped totals reconcile exactly in cents. Currency is undeclared; these are not ledger actuals or an approved cost baseline. No budgets, forecasts, plan heads or field tasks are changed. Historical reports never refresh on read. Private, no-store."}},{"id":"74a1f3bd-ccba-4c75-8496-b12fd51569df","name":"createProjectScheduleCalculation — Calculate the current canonical schedule","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/calculations","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","calculations"],"query":[{"key":"async","value":"","disabled":true,"description":"`1` always queues a background schedule analysis job (202); `0` forces the inline path (30 s engine limit). Omitted: inputs above the size threshold are queued automatically."}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Calculate the current canonical schedule\n\nRuns the P6-validated CPM engine against the project's current canonical schedule version and retains the result as an immutable calculation. Requires authenticated project schedule admin; scoped tokens need schedule:write. Full-network results may expose private activities. All responses use Cache-Control: private, no-store.\n\nOperations:\n• schedule: forward and backward pass. Early and late dates, total and free float, criticality, longest path, driving predecessors and per-activity date explanations.\n• health: DCMA 14-point assessment with a letter grade, per-check thresholds and their sources, and up to 20 offenders per check. The checks are screening indicators, not compliance criteria.\n• risk: Monte Carlo simulation (100 to 20,000 iterations, PERT or triangular, seeded by default) giving the P10 to P95 finish dates, an S-curve, a bounded histogram, the criticality index and sensitivity of each activity, and the activities that drive the finish. Durations come from the definition's `risk_model` three-point estimates where stated (the result's `estimates_source` says how many used the engine default instead); open risk events are simulated as duration impacts or fragnets, ranked by contribution, and compared pre- and post-mitigation; correlation groups are honoured; `provenance` records the estimates digest, iteration count and seed used.\n• earned: Earned Schedule of the current version measured against a baseline version: ES, AT, SPI(t) = ES / AT, SV(t) = ES - AT and IEAC(t) = PD / SPI(t).\n• compare: activity-by-activity changes between a baseline version and the current version, with criticality gained or lost and an explanation of the finish movement.\n\nRules: expected_version_id must equal the current head version, or the request fails with 409. compare and earned require baseline_version_id, a schedule definition version in this project; the other operations reject it. data_date overrides the stored data date and is rejected for compare. risk options are accepted only for the risk operation. The authority and head version are rechecked before the result is persisted. No client-supplied baseline definition is accepted.\n\nThe `result` shape depends on `operation`; see the schemas below. The Schedule Analysis workspace in the app reads the latest result of each analysis operation for the current version.","body":{"mode":"raw","raw":"{\n  \"baseline_version_id\": 17,\n  \"expected_version_id\": 42,\n  \"operation\": \"compare\"\n}","options":{"raw":{"language":"json"}}}}},{"id":"79ef2534-5f12-46e6-82a7-8003d878da5f","name":"listProjectScheduleCalculationLog — Read the schedule log of a schedule calculation","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/calculations/:id/log","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","calculations",":id","log"],"query":[{"key":"format","value":"","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Read the schedule log of a schedule calculation\n\nRequires schedule:read and live Schedule admin access (the log discloses the full network). Every Save and calculate stores its schedule log with the calculation: data date, options used, critical path definition, counts, open ends, constraints, out-of-sequence progress, started activities missing an actual start and actual dates after the data date. Entries agree with the DCMA Health checks 1, 5 and 9. format=text or format=csv downloads the log with planner deep links (?activity=)."}},{"id":"978c00ee-4ee7-4ed6-8842-90c0ad2eb3c0","name":"listProjectScheduleCalendarItems — List Calendar Items","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/calendar_items","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","calendar_items"],"query":[{"key":"view","value":"","disabled":true},{"key":"start_date","value":"","disabled":true},{"key":"finish_date","value":"","disabled":true},{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true},{"key":"filters[query]","value":"","disabled":true},{"key":"filters[updated_at]","value":"","disabled":true},{"key":"filters[assigned_id]","value":"","disabled":true},{"key":"filters[date]","value":"","disabled":true},{"key":"sort","value":"","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"List Calendar Items"}},{"id":"3eb7c602-7b3e-4c18-8f55-4044b824eb23","name":"createProjectScheduleCalendarItem — Create Calendar Item","request":{"method":"POST","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/calendar_items","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","calendar_items"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Create Calendar Item","body":{"mode":"raw","raw":"{\n  \"calendar_item\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"789cf172-9349-424e-805b-5f5369bd68d8","name":"getProjectScheduleCalendarItem — Show Calendar Item","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/calendar_items/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","calendar_items",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Show Calendar Item"}},{"id":"2eb7da50-69f1-40d0-84bf-44baff45fd0d","name":"updateProjectScheduleCalendarItem — Update Calendar Item","request":{"method":"PATCH","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/calendar_items/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","calendar_items",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Update Calendar Item","body":{"mode":"raw","raw":"{\n  \"calendar_item\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"70cd3abd-1ff4-44f4-89dd-da054a0ed37a","name":"deleteProjectScheduleCalendarItem — Delete Calendar Item","request":{"method":"DELETE","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/calendar_items/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","calendar_items",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Delete Calendar Item"}},{"id":"b6c179ac-031a-4de2-8a87-1f32ceb21db3","name":"listProjectScheduleCalendarItemDependencies — List Calendar Item Dependencies","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/calendar_items/:id/dependencies","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","calendar_items",":id","dependencies"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"List Calendar Item Dependencies"}},{"id":"efd5f223-264c-458e-8146-cc447eb54882","name":"createProjectScheduleCalendarItemDependency — Create Calendar Item Dependency","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/calendar_items/:id/dependencies","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","calendar_items",":id","dependencies"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Create Calendar Item Dependency","body":{"mode":"raw","raw":"{\n  \"dependency\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"10693475-2e9c-4a75-87ea-2047acff5509","name":"deleteProjectScheduleCalendarItemDependency — Delete Calendar Item Dependency","request":{"method":"DELETE","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/calendar_items/:id/dependencies/:dependency_id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","calendar_items",":id","dependencies",":dependency_id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""},{"key":"dependency_id","value":""}]},"description":"Delete Calendar Item Dependency"}},{"id":"e1aa304b-7022-44dd-8791-dfe7f72d53c2","name":"listProjectScheduleChangeImpacts — Time impacts modelled for a change event","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/change-impacts","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","change-impacts"],"query":[{"key":"change_event_id","value":"","disabled":false}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Time impacts modelled for a change event\n\nAuthorization is two-sided and live: Schedule access (non-admins only see activities bound to a field task they can see) and the source tool's own visibility for the linked record. All responses are private, no-store. Requires schedule:read token scope. Calculated results (from the retained, digest-checked scenario comparison) are returned to Schedule admins only."}},{"id":"8a2d3227-a31d-40a8-8393-46a8f5f83533","name":"createProjectScheduleChangeImpact — Model a change event's time impact as a delay-fragnet scenario","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/change-impacts","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","change-impacts"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Model a change event's time impact as a delay-fragnet scenario\n\nAuthorization is two-sided and live: Schedule access (non-admins only see activities bound to a field task they can see) and the source tool's own visibility for the linked record. All responses are private, no-store. Requires schedule:write token scope, Change Events edit and Schedule admin. Creates a what-if scenario on the current schedule version with one delay-fragnet activity after predecessor_id (driving successor_id when given), pins it to the change event as retained forensic evidence, and calculates the comparison. Never changes the saved schedule. Idempotent by request_id (replays return 200). A calculation failure keeps the scenario and link and is reported in calculation_error. No query parameters.","body":{"mode":"raw","raw":"{\n  \"change_event_id\": 0,\n  \"duration_days\": 0,\n  \"predecessor_id\": \"\",\n  \"request_id\": \"\"\n}","options":{"raw":{"language":"json"}}}}},{"id":"994483db-37a4-4f94-85a7-2f513b1afa92","name":"listProjectScheduleConformance — List retained conformance assessment history","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/conformance","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","conformance"],"query":[{"key":"before_id","value":"","disabled":true},{"key":"version_id","value":"","disabled":true},{"key":"page_size","value":"","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"List retained conformance assessment history\n\nRequires schedule:read and live Schedule admin permission. Returns metadata only, newest ID first. Pass next_before_id as before_id for the next page. Optionally filter by version_id. Each page is independently authorized; no report or governing terms are loaded. Private, no-store."}},{"id":"eabf1b90-8f6c-4462-8259-926b7bd03d07","name":"createProjectScheduleConformance — Create a retained conformance assessment for a saved version","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/conformance","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","conformance"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Create a retained conformance assessment for a saved version\n\nRequires live Schedule admin permission because complete-network findings may disclose private activities. Uses the original conformance and forensic rule services. Missing evidence remains explicit: read coverage and inputs_required alongside the verdict. Contract terms and baseline designation are caller declarations, not proof of contract approval. All responses are private, no-store. Requires schedule:write token scope. The explicit version may be historical. Saves an immutable assessment after rechecking authorization; does not advance the plan or publish tasks. Repeated requests create separate assessments.","body":{"mode":"raw","raw":"{\n  \"conformance\": {},\n  \"data_date\": \"2026-01-31\",\n  \"version_id\": 0\n}","options":{"raw":{"language":"json"}}}}},{"id":"a1907ff3-ef0a-4d42-8743-c3e131c515ea","name":"getProjectScheduleConformance — Read a retained conformance assessment","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/conformance/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","conformance",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Read a retained conformance assessment\n\nRequires live Schedule admin permission because complete-network findings may disclose private activities. Uses the original conformance and forensic rule services. Missing evidence remains explicit: read coverage and inputs_required alongside the verdict. Contract terms and baseline designation are caller declarations, not proof of contract approval. All responses are private, no-store. Requires schedule:read token scope. Returns the retained report without recalculation."}},{"id":"679cb6e5-a184-42b1-8122-e4155724fa49","name":"listProjectScheduleCostAccountMappings — Read cost account to cost code mappings","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/cost-account-mappings","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","cost-account-mappings"],"query":[{"key":"revision","value":"","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Read cost account to cost code mappings\n\nRequires schedule:read and budget:read, plus live Schedule admin and Budget view access. Returns the current mapping revision (or a retained one with `revision`), the P6 cost accounts the head version's expenses and resource assignments use with their schedule amounts, the project's cost codes and the revision history. Mappings classify schedule costs for Budget reconciliation; nothing is posted to the ledger."}},{"id":"de7d71ef-c983-430c-8d8d-215bd531cde1","name":"replaceProjectScheduleCostAccountMappings — Save cost account to cost code mappings","request":{"method":"PUT","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/cost-account-mappings","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","cost-account-mappings"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Save cost account to cost code mappings\n\nRequires schedule:write and budget:read, plus live Schedule admin and Budget view access. Saves the complete set at `expected_revision` as the next revision; earlier revisions are retained and rows are immutable. Each save is audited with an added/removed/changed diff. An account without its own mapping inherits its nearest mapped parent account. Never writes Budget or the ledger.","body":{"mode":"raw","raw":"{\n  \"expected_revision\": 0,\n  \"mappings\": [\n    {\n      \"account_id\": \"\",\n      \"account_name\": \"\",\n      \"cost_code_id\": 0\n    }\n  ]\n}","options":{"raw":{"language":"json"}}}}},{"id":"758db951-1ed6-4074-80b9-3db21422f0e5","name":"listProjectScheduleCostDashboard — Cost-loaded earned value, S-curves, cash-flow forecast and mapping exceptions","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/cost-dashboard","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","cost-dashboard"],"query":[{"key":"baseline_id","value":"","disabled":true,"description":"Named baseline whose retained calculation phases planned value. Omit to phase PV on the current calculated schedule."},{"key":"bucket","value":"","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Cost-loaded earned value, S-curves, cash-flow forecast and mapping exceptions\n\nRequires live Schedule admin access (full-network dates and float) and Budget view with the Budget tool enabled. All responses are private, no-store. Requires schedule:read and budget:read token scopes. Maps the Budget view's revised budget (BAC) onto activities through the saved cost mappings, phases it over the calculated (or baseline) working days, earns it by engine fraction complete, and allocates posted job cost (kind = actual) by commitment and cost-code mappings. Returns PV/EV/AC totals, CPI, SPI, CV, SV, EAC, ETC, VAC and TCPI, period series, a monthly or weekly cash-flow forecast of remaining mapped budget, and unmapped activity, budget, commitment and actual-cost exception lists. Optional sources follow live access and token scope: without commitments:read or Commitments visibility, commitments are reported unavailable; without accounting:read or an Accounting ledger-view grant (project/entity scoped), actual cost is an explicitly labelled earned-value proxy and CPI-based indices are withheld. Never posts, approves or writes any financial record."}},{"id":"bce5c365-1c94-4e0c-83e9-7b384363113a","name":"listProjectScheduleCostDashboardCsv — Export the cost dashboard as CSV","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/cost-dashboard/csv","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","cost-dashboard","csv"],"query":[{"key":"baseline_id","value":"","disabled":true,"description":"Named baseline whose retained calculation phases planned value. Omit to phase PV on the current calculated schedule."},{"key":"bucket","value":"","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Export the cost dashboard as CSV\n\nRequires live Schedule admin access (full-network dates and float) and Budget view with the Budget tool enabled. All responses are private, no-store. Requires schedule:read and budget:read token scopes. Same calculation and query as the JSON dashboard; sections for periods, activities, metrics (including withheld reasons) and basis. Cells beginning with formula characters are neutralized. Optional sources follow live access and token scope: without commitments:read or Commitments visibility, commitments are reported unavailable; without accounting:read or an Accounting ledger-view grant (project/entity scoped), actual cost is an explicitly labelled earned-value proxy and CPI-based indices are withheld. Never posts, approves or writes any financial record."}},{"id":"bb7d4988-efe1-480f-85e5-76ae52f24ab8","name":"listProjectScheduleCostMappings — Read the project's cost-loading mapping set","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/cost-mappings","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","cost-mappings"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Read the project's cost-loading mapping set\n\nRequires live Schedule admin access (full-network dates and float) and Budget view with the Budget tool enabled. All responses are private, no-store. Requires schedule:read and budget:read token scopes. Revision 0 means no mappings were saved yet. No query parameters."}},{"id":"d32e96e4-3147-434f-8363-ad4250233283","name":"replaceProjectScheduleCostMappings — Replace the cost-loading mapping set at the expected revision","request":{"method":"PUT","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/cost-mappings","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","cost-mappings"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Replace the cost-loading mapping set at the expected revision\n\nRequires live Schedule admin access (full-network dates and float) and Budget view with the Budget tool enabled. All responses are private, no-store. Requires schedule:write and budget:read token scopes, plus commitments:read when any commitment is mapped. Activities must exist in the current saved version, budget lines on this project, commitments visible under Commitments privacy. Shares of one source may not exceed 10000 basis points; duplicates are rejected. The revision advances by one and an audit event records every added, removed and changed share. Mappings never write Budget, Commitments or the ledger. No query parameters.","body":{"mode":"raw","raw":"{\n  \"expected_revision\": 0,\n  \"mappings\": [\n    {\n      \"activity_id\": \"\",\n      \"allocation_basis_points\": 0,\n      \"budget_line_id\": 0,\n      \"source_type\": \"budget_line\"\n    }\n  ]\n}","options":{"raw":{"language":"json"}}}}},{"id":"5e29464d-8044-4128-89bd-13882b3d6deb","name":"listProjectScheduleCostReports — List saved cost report history","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/cost-reports","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","cost-reports"],"query":[{"key":"before_id","value":"","disabled":true},{"key":"version_id","value":"","disabled":true},{"key":"page_size","value":"","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"List saved cost report history\n\nRequires schedule:read and live Schedule admin permission. Uses an explicit immutable schedule version. Results describe schedule inputs, not reconciled Accounting actuals or an approved cost baseline. Retains the original engine qualifications and provenance. No budgets, postings, definition heads or field tasks are changed. Private, no-store. Metadata only, newest ID first; pass next_before_id as before_id. Optional version_id filter."}},{"id":"0dd60d35-671a-4583-8c49-ec7019803d9f","name":"createProjectScheduleCostReport — Create saved-version cost report","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/cost-reports","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","cost-reports"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Create saved-version cost report\n\nRequires schedule:write and live Schedule admin permission. Uses an explicit immutable schedule version. Results describe schedule inputs, not reconciled Accounting actuals or an approved cost baseline. Retains the original engine qualifications and provenance. No budgets, postings, definition heads or field tasks are changed. Private, no-store.","body":{"mode":"raw","raw":"{\n  \"costs\": {},\n  \"data_date\": \"2026-01-31\",\n  \"version_id\": 0\n}","options":{"raw":{"language":"json"}}}}},{"id":"386902b8-20bd-4ce2-84cb-eaf5c7034e30","name":"getProjectScheduleCostReport — Read saved cost report","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/cost-reports/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","cost-reports",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Read saved cost report\n\nRequires schedule:read and live Schedule admin permission. Uses an explicit immutable schedule version. Results describe schedule inputs, not reconciled Accounting actuals or an approved cost baseline. Retains the original engine qualifications and provenance. No budgets, postings, definition heads or field tasks are changed. Private, no-store."}},{"id":"f10ff509-5cf4-4ad7-89d4-911871ca3e9a","name":"listProjectScheduleDateTraces — List retained activity date traces","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/date-traces","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","date-traces"],"query":[{"key":"before_id","value":"","disabled":true},{"key":"version_id","value":"","disabled":true},{"key":"page_size","value":"","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"List retained activity date traces\n\nRequires schedule:read and live Schedule admin. Newest first; metadata only."}},{"id":"722da033-da50-4305-85ad-00d987c5adb6","name":"createProjectScheduleDateTrace — Retain an activity date explanation","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/date-traces","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","date-traces"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Retain an activity date explanation\n\nRequires schedule:write and live Schedule admin access to the full network. Uses an explicit immutable version and optional data-date override. Preserves original engine driver ties, calendars, constraints and actual-date qualifications. Does not change dates or approve delay claims. Each successful request creates a retained trace; check history after an uncertain response. No query parameters.","body":{"mode":"raw","raw":"{\n  \"activity_id\": \"\",\n  \"version_id\": 0\n}","options":{"raw":{"language":"json"}}}}},{"id":"772e2c9e-84ab-4038-825f-137475ec3086","name":"getProjectScheduleDateTrace — Read original retained date trace evidence","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/date-traces/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","date-traces",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Read original retained date trace evidence\n\nRequires schedule:read and live Schedule admin. Returns the saved evidence without recalculation. No query parameters."}},{"id":"aaad845d-9e18-4085-8686-6177a941ef1a","name":"listProjectScheduleDefinition — Get current canonical schedule definition","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/definition","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","definition"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Get current canonical schedule definition\n\nRequires authenticated project schedule admin; scoped tokens need schedule:read for GET and schedule:write for POST. Full-network definitions and results may expose private activities. All responses use Cache-Control: private, no-store."}},{"id":"af39f43e-37f4-4701-862e-04200c4c1c7f","name":"createProjectScheduleDefinition — Save and calculate a canonical schedule version","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/definition","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","definition"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Save and calculate a canonical schedule version\n\nRequires authenticated project schedule admin; scoped tokens need schedule:read for GET and schedule:write for POST. Full-network definitions and results may expose private activities. All responses use Cache-Control: private, no-store. Creates an immutable version and schedule calculation atomically after successful validation and calculation. expected_version_id is the current version record ID, or null for first creation. This endpoint does not project canonical activities into legacy task rows.","body":{"mode":"raw","raw":"{\n  \"definition\": {},\n  \"expected_version_id\": 0\n}","options":{"raw":{"language":"json"}}}}},{"id":"dc9cf623-bba1-4224-81d6-3f4f157a2f2e","name":"listProjectScheduleEarnedValue — Per-activity earned value","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/earned-value","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","earned-value"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Per-activity earned value\n\nRequires schedule:read (GET) or schedule:write and live Schedule admin access on the project. BAC, BCWS, BCWP, ACWP, CV, SV, CPI, SPI and EAC per activity of the saved head version from resource assignment costs, with the project baseline (Assign Baselines) as the planned value basis (the current schedule when none is assigned), plus the latest stored period's actual this period. These feed the planner's Earned Value columns."}},{"id":"fea3d3d2-cd89-479c-8464-1c328b3f99ea","name":"getProjectScheduleExport — Export exact retained schedule source","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/exports/:import_id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","exports",":import_id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"import_id","value":""}]},"description":"Export exact retained schedule source\n\nRequires Schedule admin permission and an enabled Schedule tool. Scoped tokens require schedule:read. Returns the retained source bytes after integrity verification, not an export of subsequent Planner or field edits. Download responses are private, no-store."}},{"id":"9f10eb9a-4360-460b-8efc-1af22556271c","name":"listProjectScheduleFeed — Schedule change feed","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/feed","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","feed"],"query":[{"key":"before","value":"","disabled":true},{"key":"limit","value":"","disabled":true},{"key":"kinds","value":"","disabled":true,"description":"Comma-separated kinds"},{"key":"activity_id","value":"","disabled":true,"description":"Discussion of one activity"}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Schedule change feed\n\nRequires schedule:read and live Schedule view access on the project. Newest first: saved versions (who, with a change summary against the previous version, stored when the version is saved; older versions fill in on later reads), recalculations, baselines, update-cycle events, adopted scenarios, imports and discussion. Schedule admins see every kind; other viewers only discussion they may read. Page with `before` = the previous `next_cursor`."}},{"id":"05138555-5c26-48fa-8dd0-1e89204956dc","name":"listProjectScheduleFeedChanges — Version change details, paged","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/feed/changes","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","feed","changes"],"query":[{"key":"version_id","value":"","disabled":false},{"key":"against_version_id","value":"","disabled":true},{"key":"offset","value":"","disabled":true},{"key":"limit","value":"","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Version change details, paged\n\nRequires schedule:read and live Schedule admin access on the project (it discloses the full network). Every activity entry of one version's change (feed and banner summaries name only the first 25): against its previous version, or against `against_version_id` (for example the version you last looked at). Added, then removed, then changed activities, with every changed field."}},{"id":"47ce68a1-1661-4671-8c2e-bc88a4aa79c2","name":"createProjectScheduleFeedSeen — Acknowledge a version","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/feed/seen","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","feed","seen"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Acknowledge a version\n\nRequires schedule:read and live Schedule admin access on the project Sets your 'last looked' mark to a saved version of the project.","body":{"mode":"raw","raw":"{\n  \"version_id\": 0\n}","options":{"raw":{"language":"json"}}}}},{"id":"62ac7b25-84cd-4df2-81e7-87414efc7e33","name":"listProjectScheduleFeedSince — What changed since I last looked","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/feed/since","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","feed","since"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"What changed since I last looked\n\nRequires schedule:read and live Schedule admin access on the project (it discloses the full network). Versions saved since the version you last acknowledged, a change summary from it to the head, and new comments by others. The first call sets your mark to the head and reports nothing."}},{"id":"88b36734-08b9-49a3-8d46-74cc50eedd5f","name":"createProjectScheduleFieldProgressApply — Record accepted progress suggestions as a new schedule version","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/field-progress/apply","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","field-progress","apply"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Record accepted progress suggestions as a new schedule version\n\nAuthorization is two-sided and live: Schedule access (non-admins only see activities bound to a field task they can see) and the source tool's own visibility for the linked record. All responses are private, no-store. Requires schedule:write token scope, Schedule admin and Daily Log view. Saves through the versioned definition path (expected-version check, calculation, history); the preview digest must still match. Field tasks are not written: publish progress afterwards with the progress preview/apply operations. Re-evaluates link alerts. No query parameters.","body":{"mode":"raw","raw":"{\n  \"activity_ids\": [\n    \"\"\n  ],\n  \"expected_version_id\": 0,\n  \"preview_digest\": \"\",\n  \"status_date\": \"\"\n}","options":{"raw":{"language":"json"}}}}},{"id":"45715200-c4d1-4f4d-8a91-6d521f0ab5ad","name":"createProjectScheduleFieldProgressPreview — Preview progress suggested by linked daily-log entries","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/field-progress/preview","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","field-progress","preview"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Preview progress suggested by linked daily-log entries\n\nAuthorization is two-sided and live: Schedule access (non-admins only see activities bound to a field task they can see) and the source tool's own visibility for the linked record. All responses are private, no-store. Requires schedule:write token scope, Schedule admin and Daily Log view. Approved entries on or before the status date (and the data date unless advance_data_date) suggest actual start, actual finish and physical percent complete. Recorded actuals are never cleared or moved and progress is never lowered. Returns a preview_digest that binds apply to this exact review. No query parameters.","body":{"mode":"raw","raw":"{\n  \"status_date\": \"\"\n}","options":{"raw":{"language":"json"}}}}},{"id":"d35b4aa7-dfed-4daf-81d0-f39a9a2b89c9","name":"listProjectScheduleFinancialPeriods — List financial periods","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/financial-periods","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","financial-periods"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"List financial periods\n\nRequires schedule:read (GET) or schedule:write and live Schedule admin access on the project. Returns company-wide periods and this project's periods in date order, each with this project's effective stored period performance run."}},{"id":"056d3a68-df2a-41d0-808b-676338c6f1fc","name":"createProjectScheduleFinancialPeriod — Create financial periods","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/financial-periods","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","financial-periods"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Create financial periods\n\nRequires schedule:read (GET) or schedule:write and live Schedule admin access on the project. Creates one period, a batch (`periods`), or copies an Accounting fiscal year's periods as company-wide periods (`{source: \"accounting\", fiscal_year}`; adjusting period 13 is skipped; Accounting is read only and never posted to). Company-wide periods require a company admin. Periods of one scope cannot overlap and span at most a year. Every period created is audited.","body":{"mode":"raw","raw":"{\n  \"end_date\": \"2026-01-31\",\n  \"name\": \"\",\n  \"start_date\": \"2026-01-31\"\n}","options":{"raw":{"language":"json"}}}}},{"id":"7120762e-06c5-431b-87e7-3035e4a3cff9","name":"updateProjectScheduleFinancialPeriod — Rename a financial period","request":{"method":"PATCH","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/financial-periods/:period_id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","financial-periods",":period_id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"period_id","value":""}]},"description":"Rename a financial period\n\nRequires schedule:read (GET) or schedule:write and live Schedule admin access on the project. Only the name can change; dates and scope are immutable (database trigger). Audited.","body":{"mode":"raw","raw":"{\n  \"name\": \"\"\n}","options":{"raw":{"language":"json"}}}}},{"id":"4c5e019d-1c82-42eb-8fed-6e4aaba60594","name":"deleteProjectScheduleFinancialPeriod — Delete a financial period","request":{"method":"DELETE","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/financial-periods/:period_id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","financial-periods",":period_id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"period_id","value":""}]},"description":"Delete a financial period\n\nRequires schedule:read (GET) or schedule:write and live Schedule admin access on the project. A period with stored period performance (in any project) is retained. Audited."}},{"id":"9d1564c3-a1cf-4da0-85c6-5f0845238bb0","name":"storePerformanceProjectScheduleFinancialPeriod — Store period performance","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/financial-periods/:period_id/store-performance","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","financial-periods",":period_id","store-performance"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"period_id","value":""}]},"description":"Store period performance\n\nRequires schedule:read (GET) or schedule:write and live Schedule admin access on the project. Snapshots the actual-to-date units and cost of every activity and resource assignment of a saved version (default the current head; `update_period_id` stores an approved schedule update's accepted version) into a financial period that has ended at the version's data date. Activity rows also store earned value and planned value to date (project baseline as the PV basis). Actual this period = to date minus the previous stored period. Periods are stored in date order; earlier periods are frozen. Storing the latest period again needs `replace: true` and appends a superseding run; runs are immutable and audited. Sources are schedule resource actuals; the Accounting ledger is never read or written.","body":{"mode":"raw","raw":"{\n  \"note\": \"\",\n  \"replace\": false,\n  \"update_period_id\": 0,\n  \"version_id\": 0\n}","options":{"raw":{"language":"json"}}}}},{"id":"83964a46-f3fc-48c2-8638-a8dc7d4c2753","name":"listProjectScheduleForensics — List retained forensic delay analyses","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/forensics","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","forensics"],"query":[{"key":"before_id","value":"","disabled":true},{"key":"version_id","value":"","disabled":true},{"key":"method","value":"","disabled":true},{"key":"page_size","value":"","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"List retained forensic delay analyses\n\nRequires live Schedule admin access because complete-network forensic evidence may disclose private activities. Uses the original AACE RP 29R-03 forensic methods and concurrency assessment. Delay events, responsibility, concurrency facts and source documents are analyst statements; results do not establish causation, responsibility, entitlement or admissibility. All responses are private, no-store. Requires schedule:read token scope. Newest first; metadata and pinned inputs only."}},{"id":"210dd8fb-db68-4f15-845b-7d007351f3d4","name":"createProjectScheduleForensic — Create a retained forensic delay analysis","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/forensics","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","forensics"],"query":[{"key":"async","value":"","disabled":true,"description":"`1` always queues a background schedule analysis job (202); `0` forces the inline path (30 s engine limit). Omitted: inputs above the size threshold are queued automatically."}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Create a retained forensic delay analysis\n\nRequires live Schedule admin access because complete-network forensic evidence may disclose private activities. Uses the original AACE RP 29R-03 forensic methods and concurrency assessment. Delay events, responsibility, concurrency facts and source documents are analyst statements; results do not establish causation, responsibility, entitlement or admissibility. All responses are private, no-store. Requires schedule:write token scope. Inputs are explicit immutable versions or named baselines with method-specific roles; retained versions with data dates are supplied as metadata so a skipped update is named. Saves an immutable report with pinned input digests after rechecking authorization; never applies dates or advances the plan. Repeated requests create separate reports. No query parameters.","body":{"mode":"raw","raw":"{\n  \"method\": \"contemporaneous_as_is\"\n}","options":{"raw":{"language":"json"}}}}},{"id":"dd468266-8835-471e-8ef8-f4e4ce73c978","name":"getProjectScheduleForensic — Read a retained forensic delay analysis","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/forensics/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","forensics",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Read a retained forensic delay analysis\n\nRequires live Schedule admin access because complete-network forensic evidence may disclose private activities. Uses the original AACE RP 29R-03 forensic methods and concurrency assessment. Delay events, responsibility, concurrency facts and source documents are analyst statements; results do not establish causation, responsibility, entitlement or admissibility. All responses are private, no-store. Requires schedule:read token scope. Returns the retained report without recalculation after verifying its result digest; digest_current reports whether each pinned version still matches. No query parameters."}},{"id":"f6910f75-fb1e-43cb-8e5e-539b42cc897e","name":"listProjectScheduleGanttPrint — Print the saved schedule as a Gantt PDF","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/gantt-print","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","gantt-print"],"query":[{"key":"paper","value":"","disabled":true},{"key":"orientation","value":"","disabled":true},{"key":"timescale","value":"","disabled":true},{"key":"columns","value":"","disabled":true,"description":"Comma-separated, unique: id, name, start, finish, duration, total_float, percent."},{"key":"fit","value":"","disabled":true},{"key":"filter","value":"","disabled":true},{"key":"show_baseline","value":"","disabled":true},{"key":"show_legend","value":"","disabled":true},{"key":"from","value":"","disabled":true},{"key":"to","value":"","disabled":true},{"key":"title","value":"","disabled":true},{"key":"layout","value":"","disabled":true,"description":"Planner layout whose Timescale, Bar Chart Options and Bars sections style the print (builtin:<id> or layout:<id>, a layout visible to the caller). Absent keeps the timescale and fixed bar colours above."},{"key":"baseline_id","value":"","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Print the saved schedule as a Gantt PDF\n\nRequires live Schedule admin access (complete-network dates and float can disclose private activities) and the schedule:read token scope. Reads only retained evidence: the saved head version, its own retained schedule calculation (exact input, no data-date override), a named baseline's original calculation, and the latest retained health, resource histogram and cost dashboard. Never runs the engine and never writes. All responses are private, no-store. Page size and orientation, timescale, columns, legend and baseline bars are selectable. At actual scale the timeline tiles across pages and rows continue down; fit=width scales the timeline to one page width and fit=page also scales rows (down to a 2.5 pt legibility floor) to one page. Every page shows the project, version, data date, baseline and page position. Layouts above 400 pages are refused."}},{"id":"d253ea7d-cc35-4b4b-814f-79d61b396a7a","name":"createProjectScheduleHierarchyApply — Apply a reviewed native hierarchy publication","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/hierarchy/apply","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","hierarchy","apply"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Apply a reviewed native hierarchy publication\n\nRequires Schedule, Submittals and CRM admin permissions and enabled tools. Scoped tokens require schedule:write, submittals:read and crm:read. Responses are private, no-store. Strict snake_case JSON is bounded to 2 MiB and 20,000 explicit decisions. Identity namespaces distinguish activities from WBS nodes even when their opaque IDs match. Parent WBS identity and create privacy/assignment/baseline/unstarted-progress policies are explicit. Bind, move, restore, retain and retire require an exact existing task ID and row digest. Preview returns only existing task IDs and symbolic new parents; internal receipt and temporary planning IDs are excluded. Apply validates the reviewed digest, locks current authority and task rows, then atomically writes the hierarchy and receipt/head; identical current requests replay without new writes. Summaries are admin-only, private and unassigned. Progressed work, empty summaries and imported/mixed transitions require separate reconciliation. Canonical dependencies and resources are not projected by this endpoint.","body":{"mode":"raw","raw":"{\n  \"calculation_id\": 0,\n  \"decisions\": [\n    {\n      \"assigned_id\": 0,\n      \"baseline_policy\": \"none\",\n      \"identity\": null,\n      \"operation\": \"create\",\n      \"parent_wbs_id\": \"\",\n      \"private\": false,\n      \"progress_policy\": \"unstarted\"\n    }\n  ],\n  \"expected_version_id\": 0,\n  \"preview_digest\": \"\"\n}","options":{"raw":{"language":"json"}}}}},{"id":"36a3529d-640f-4833-8990-bc8bb34a4cbb","name":"listProjectScheduleHierarchyInventory — Read a paginated native hierarchy decision inventory","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/hierarchy/inventory","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","hierarchy","inventory"],"query":[{"key":"expected_version_id","value":"","disabled":false},{"key":"calculation_id","value":"","disabled":false},{"key":"node_page","value":"","disabled":true},{"key":"task_page","value":"","disabled":true},{"key":"page_size","value":"","disabled":true},{"key":"assignee_page","value":"","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Read a paginated native hierarchy decision inventory\n\nRequires Schedule, Submittals and CRM admin permissions and enabled tools, with schedule:read, submittals:read and crm:read token scopes. Responses are private, no-store. Supplies existing task IDs and exact row digests for reviewed decisions. Node, task and assignee pages are independent; active project members are the only assignment candidates; compare inventory_digest across every page to reject mixed snapshots. This inventory never authorizes apply: obtain a fresh hierarchy preview after composing decisions. Unknown or repeated query parameters are rejected. Summaries remain admin-only."}},{"id":"7f07c2c5-8d21-4edb-8240-fe87e68178d7","name":"createProjectScheduleHierarchyPreview — Preview a reviewed native hierarchy publication","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/hierarchy/preview","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","hierarchy","preview"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Preview a reviewed native hierarchy publication\n\nRequires Schedule, Submittals and CRM admin permissions and enabled tools. Scoped tokens require schedule:read, submittals:read and crm:read. Responses are private, no-store. Strict snake_case JSON is bounded to 2 MiB and 20,000 explicit decisions. Identity namespaces distinguish activities from WBS nodes even when their opaque IDs match. Parent WBS identity and create privacy/assignment/baseline/unstarted-progress policies are explicit. Bind, move, restore, retain and retire require an exact existing task ID and row digest. Preview returns only existing task IDs and symbolic new parents; internal receipt and temporary planning IDs are excluded. Apply validates the reviewed digest, locks current authority and task rows, then atomically writes the hierarchy and receipt/head; identical current requests replay without new writes. Summaries are admin-only, private and unassigned. Progressed work, empty summaries and imported/mixed transitions require separate reconciliation. Canonical dependencies and resources are not projected by this endpoint.","body":{"mode":"raw","raw":"{\n  \"calculation_id\": 0,\n  \"decisions\": [\n    {\n      \"assigned_id\": 0,\n      \"baseline_policy\": \"none\",\n      \"identity\": null,\n      \"operation\": \"create\",\n      \"parent_wbs_id\": \"\",\n      \"private\": false,\n      \"progress_policy\": \"unstarted\"\n    }\n  ],\n  \"expected_version_id\": 0\n}","options":{"raw":{"language":"json"}}}}},{"id":"5a1ddaab-d6d4-489a-8ad3-5b5b86369f95","name":"listProjectScheduleImports — List retained schedule imports","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/imports","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","imports"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"List retained schedule imports\n\nRequires Schedule admin permission and an enabled Schedule tool. Scoped tokens require schedule:read. Returns the newest 50 imports ordered by descending ID. Does not return retained source contents."}},{"id":"1da4f849-9dd6-48d9-8b36-f7840bd1fe44","name":"createProjectScheduleImport — Preview a schedule source upload","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/imports","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","imports"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Preview a schedule source upload\n\nRequires Schedule admin permission and an enabled Schedule tool. Scoped tokens require schedule:write. Upload UTF-8 XER or project XML, at most 2 MiB, with a plain matching .xer or .xml filename of at most 255 characters. Stores a digest-deduplicated retained source and preview; does not commit field tasks or initialize a Planner version. The source field is an alias for file.","body":{"mode":"formdata","formdata":[{"key":"file","type":"file","src":[]},{"key":"source","type":"file","src":[]}]}}},{"id":"a44e4231-aa7f-4e82-8493-6ace447c63a0","name":"getProjectScheduleImport — Read a retained schedule import preview","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/imports/:import_id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","imports",":import_id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"import_id","value":""}]},"description":"Read a retained schedule import preview\n\nRequires Schedule admin permission and an enabled Schedule tool. Scoped tokens require schedule:read. Verifies retained source integrity before parsing the preview."}},{"id":"558aa5e5-6e8f-46ab-8043-dfc3aa3f092d","name":"commitProjectScheduleImport — Commit a retained schedule import","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/imports/:import_id/commit","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","imports",":import_id","commit"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"import_id","value":""}]},"description":"Commit a retained schedule import\n\nRequires Schedule admin permission and an enabled Schedule tool. Scoped tokens require schedule:write. Creates field tasks, resources, assignments and dependencies atomically. A repeat of an applied import returns the recorded result with retried=true. A reviewed publication or ambiguous legacy source ownership blocks a new commit. This does not initialize or adopt a Planner definition."}},{"id":"225be054-ad9e-43a7-8713-9d2773fece6a","name":"listProjectScheduleImportConversion — Preview retained schedule conversion","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/imports/:import_id/conversion","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","imports",":import_id","conversion"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"import_id","value":""}]},"description":"Preview retained schedule conversion\n\nRead-only full-project inventory. Requires Schedule, Submittals and CRM admin privileges; scoped Bearer tokens must grant schedule:read, submittals:read and crm:read. Returns the imported canonical definition plus exact identity candidates, ambiguities, private/current metadata and historical references. Never matches names or modifies tasks, bindings or versions. All responses use private, no-store."}},{"id":"0231f17a-a87e-43ef-8465-f14e9adc8681","name":"createProjectScheduleImportConversionAdopt — Adopt a reviewed retained source as the initial canonical schedule","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/imports/:import_id/conversion/adopt","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","imports",":import_id","conversion","adopt"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"import_id","value":""}]},"description":"Adopt a reviewed retained source as the initial canonical schedule\n\nRequires schedule admin/write scope plus submittals and crm admin/read scopes. The canonical head must be absent; expected_version_id must be null. Only current applied source imports without manual-task/edit or mapping blockers can be adopted. Revalidates preview digest and authority before atomic publication, preserves existing task IDs/privacy/references and records legacy task provenance. Does not project calculated dates into legacy rows. All responses use private, no-store.","body":{"mode":"raw","raw":"{\n  \"expected_version_id\": null,\n  \"preview_digest\": \"\"\n}","options":{"raw":{"language":"json"}}}}},{"id":"e7e04336-e3a0-4dd1-821f-244e9c5041fc","name":"createProjectScheduleImportMergeApply — Apply a reviewed schedule import update","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/imports/:import_id/merge/apply","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","imports",":import_id","merge","apply"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"import_id","value":""}]},"description":"Apply a reviewed schedule import update\n\nP6 import options. The retained XER, P6 XML or MSPDI source of a schedule import (previewed or imported) is read by the scheduling engine and merged into the current canonical plan: Update existing (per object type actions), Replace, or Add into a WBS node. Activities match by retained P6 GUID, else by Activity ID; matched objects keep their local identities. Saves one new version through the versioned save path (expected version, calculation, audit event). The preview must still match preview_digest. Requires Schedule admin and schedule:write. No query parameters.","body":{"mode":"raw","raw":"{\n  \"expected_version_id\": 0,\n  \"mode\": \"update\",\n  \"preview_digest\": \"\"\n}","options":{"raw":{"language":"json"}}}}},{"id":"38bd2bcc-b5a5-458a-802f-aa11d8afd6f1","name":"createProjectScheduleImportMergePreview — Review a retained schedule import as an update of the current plan","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/imports/:import_id/merge/preview","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","imports",":import_id","merge","preview"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"import_id","value":""}]},"description":"Review a retained schedule import as an update of the current plan\n\nP6 import options. The retained XER, P6 XML or MSPDI source of a schedule import (previewed or imported) is read by the scheduling engine and merged into the current canonical plan: Update existing (per object type actions), Replace, or Add into a WBS node. Activities match by retained P6 GUID, else by Activity ID; matched objects keep their local identities. Read-only: returns counts per object type, a sample diff and preview_digest. Requires Schedule admin and schedule:write. No query parameters.","body":{"mode":"raw","raw":"{\n  \"expected_version_id\": 0,\n  \"mode\": \"update\"\n}","options":{"raw":{"language":"json"}}}}},{"id":"13141304-da58-4bc6-805f-769d1d11d8ea","name":"listProjectScheduleImportSource — Download retained schedule source","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/imports/:import_id/source","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","imports",":import_id","source"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"import_id","value":""}]},"description":"Download retained schedule source\n\nRequires Schedule admin permission and an enabled Schedule tool. Scoped tokens require schedule:read. Returns the retained source bytes after integrity verification, not an export of subsequent Planner or field edits. Download responses are private, no-store."}},{"id":"dd33c4fa-6648-4abe-86b4-d554b7f1beda","name":"replaceProjectScheduleLayoutDefaults — Set my default or the project default layout","request":{"method":"PUT","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/layout-defaults","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","layout-defaults"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Set my default or the project default layout\n\nPlanner layouts are view preferences and never change the schedule. Visible layouts: the caller's personal (user) layouts, this project's layouts and the company's shared layouts. Requires Schedule access on the project. Documents are versioned (planner/layout-schema.ts): every response carries the server-validated, migrated document; unknown feature sections are preserved. All responses are private, no-store. Requires schedule:write. target user sets the caller's own default on this project; target project needs Schedule admin and a layout everyone can see (built-in, project or shared). layout_ref null clears it. No query parameters.","body":{"mode":"raw","raw":"{\n  \"layout_ref\": \"\",\n  \"target\": \"user\"\n}","options":{"raw":{"language":"json"}}}}},{"id":"d7963d03-57c6-4db0-8fca-de6ee9a80ea1","name":"listProjectScheduleLayoutFiles — Download a layout as an os.construction layout file","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/layout-files","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","layout-files"],"query":[{"key":"layout_ref","value":"","disabled":false}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Download a layout as an os.construction layout file\n\nA built-in or visible stored layout as a .json file ({format: \"os.construction layout\", version: 1, name, document}). Importing the file back is lossless. Requires schedule:read and Schedule access."}},{"id":"5f319d5d-0a37-41ac-8e41-e4525d7bc4b5","name":"createProjectScheduleLayoutFile — Import a layout file as a new layout","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/layout-files","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","layout-files"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Import a layout file as a new layout\n\nValidates the file with the stored-layout readers (size-capped, unknown sections preserved) and saves it under the chosen scope with the same permissions as Save Layout As. P6 .plf layout files are refused with an explanation: their format is not publicly documented. Requires schedule:write. No query parameters.","body":{"mode":"raw","raw":"{\n  \"file\": \"\"\n}","options":{"raw":{"language":"json"}}}}},{"id":"0c55cf19-9fdf-40c5-83a1-e945c0311dba","name":"createProjectScheduleLayoutImport — Import browser layouts as personal layouts","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/layout-imports","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","layout-imports"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Import browser layouts as personal layouts\n\nPlanner layouts are view preferences and never change the schedule. Visible layouts: the caller's personal (user) layouts, this project's layouts and the company's shared layouts. Requires Schedule access on the project. Documents are versioned (planner/layout-schema.ts): every response carries the server-validated, migrated document; unknown feature sections are preserved. All responses are private, no-store. Requires schedule:write. One-click migration of the version-1 browser (localStorage) layouts: each valid view becomes a personal layout with the same meaning. Names already used by the caller's personal layouts are skipped, so repeating the import is harmless. No query parameters.","body":{"mode":"raw","raw":"{\n  \"views\": [\n    {}\n  ]\n}","options":{"raw":{"language":"json"}}}}},{"id":"194fa5b3-3b05-4bca-8902-e7be3aa0c896","name":"listProjectScheduleLayouts — List Planner layouts, defaults and save permissions","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/layouts","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","layouts"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"List Planner layouts, defaults and save permissions\n\nPlanner layouts are view preferences and never change the schedule. Visible layouts: the caller's personal (user) layouts, this project's layouts and the company's shared layouts. Requires Schedule access on the project. Documents are versioned (planner/layout-schema.ts): every response carries the server-validated, migrated document; unknown feature sections are preserved. All responses are private, no-store. Requires schedule:read. Includes the read-only built-in (Global) layouts, the caller's and the project's default layout references, and per-scope save permissions with the reason when denied. No query parameters."}},{"id":"e83dce38-c87d-49c7-8e9a-b7893abc31ac","name":"createProjectScheduleLayout — Create a Planner layout","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/layouts","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","layouts"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Create a Planner layout\n\nPlanner layouts are view preferences and never change the schedule. Visible layouts: the caller's personal (user) layouts, this project's layouts and the company's shared layouts. Requires Schedule access on the project. Documents are versioned (planner/layout-schema.ts): every response carries the server-validated, migrated document; unknown feature sections are preserved. All responses are private, no-store. Requires schedule:write. Saving to project scope needs Schedule admin; shared scope needs company administrator and Schedule admin. Names are unique per scope container (case-insensitive). set_default also makes it the caller's default on this project. No query parameters.","body":{"mode":"raw","raw":"{\n  \"document\": {},\n  \"name\": \"\",\n  \"scope\": \"user\"\n}","options":{"raw":{"language":"json"}}}}},{"id":"b1655082-2238-4bb6-80bf-73df1489dfa3","name":"updateProjectScheduleLayout — Rename or re-save a Planner layout","request":{"method":"PATCH","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/layouts/:layout_id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","layouts",":layout_id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"layout_id","value":""}]},"description":"Rename or re-save a Planner layout\n\nPlanner layouts are view preferences and never change the schedule. Visible layouts: the caller's personal (user) layouts, this project's layouts and the company's shared layouts. Requires Schedule access on the project. Documents are versioned (planner/layout-schema.ts): every response carries the server-validated, migrated document; unknown feature sections are preserved. All responses are private, no-store. Requires schedule:write. Optimistic concurrency: revision must equal the stored revision (409 otherwise); a successful update increments it. Scope and owner never change; copy with Save As (POST) instead. No query parameters.","body":{"mode":"raw","raw":"{\n  \"revision\": 0\n}","options":{"raw":{"language":"json"}}}}},{"id":"196cc6c8-67a0-4f71-89fa-f6d48ed24ec7","name":"deleteProjectScheduleLayout — Delete a Planner layout","request":{"method":"DELETE","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/layouts/:layout_id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","layouts",":layout_id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"layout_id","value":""}]},"description":"Delete a Planner layout\n\nPlanner layouts are view preferences and never change the schedule. Visible layouts: the caller's personal (user) layouts, this project's layouts and the company's shared layouts. Requires Schedule access on the project. Documents are versioned (planner/layout-schema.ts): every response carries the server-validated, migrated document; unknown feature sections are preserved. All responses are private, no-store. Requires schedule:write and the same permission as saving to the layout's scope. Defaults that referenced it are removed and fall back (my default, then project default, then Classic Schedule). No query parameters."}},{"id":"e4bc48a8-c43d-4345-8b89-0a35ff670de2","name":"listProjectScheduleLessonsLearned — Lessons learned: actual against planned durations across schedules","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/lessons-learned","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","lessons-learned"],"query":[{"key":"group_by","value":"","disabled":true},{"key":"code_type","value":"","disabled":true,"description":"Required when group_by=code"},{"key":"scope","value":"","disabled":true},{"key":"min_samples","value":"","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Lessons learned: actual against planned durations across schedules\n\nGroups completed activities by activity name, trade or an activity code value and compares actual working days (actual start to actual finish on the activity's calendar, exceptions honoured) with the planned duration. Reads only projects of the company where the caller is Schedule admin with the Schedule tool enabled, at most 200. scope completed_projects (default) uses only schedules whose every working activity has finished. Groups need min_samples (default 3). Requires schedule:read and Schedule access on this project. Private, no-store."}},{"id":"f1133396-b442-4522-83c4-bd26a2a9c915","name":"listProjectScheduleLibraryTemplates — List schedule library templates","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/library/templates","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","library","templates"],"query":[{"key":"kind","value":"","disabled":true},{"key":"include_archived","value":"","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"List schedule library templates\n\nTemplates are company-level and versioned: each save is an immutable version. Visible templates: company-shared ones and the caller's own private ones. Requires Schedule access on the project the request is made from. All responses are private, no-store. Requires schedule:read. Query: kind (plan | fragment), include_archived (true | false)."}},{"id":"bd5222c6-fb60-4572-8a51-39c7c7b66d02","name":"createProjectScheduleLibraryTemplate — Save this project's plan, or a fragment of it, as a library template","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/library/templates","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","library","templates"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Save this project's plan, or a fragment of it, as a library template\n\nTemplates are company-level and versioned: each save is an immutable version. Visible templates: company-shared ones and the caller's own private ones. Requires Schedule access on the project the request is made from. All responses are private, no-store. Requires schedule:write and Schedule admin on the project (the content is read from its current plan). A fragment is the chosen WBS subtrees and activities with the logic between them; progress, dates, constraints, resources and costs are not saved. No query parameters.","body":{"mode":"raw","raw":"{\n  \"name\": \"\",\n  \"selection\": {\n    \"kind\": \"plan\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"a2db0a95-5968-4d6e-883d-f84a136a3fb4","name":"getProjectScheduleLibraryTemplate — Get a library template with a version's content","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/library/templates/:template_id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","library","templates",":template_id"],"query":[{"key":"version","value":"","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"template_id","value":""}]},"description":"Get a library template with a version's content\n\nTemplates are company-level and versioned: each save is an immutable version. Visible templates: company-shared ones and the caller's own private ones. Requires Schedule access on the project the request is made from. All responses are private, no-store. Requires schedule:read. Query: version (default the latest)."}},{"id":"ea8e7477-389c-48b8-8305-96097e4e08a2","name":"updateProjectScheduleLibraryTemplate — Rename, share, unshare or archive a library template","request":{"method":"PATCH","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/library/templates/:template_id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","library","templates",":template_id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"template_id","value":""}]},"description":"Rename, share, unshare or archive a library template\n\nTemplates are company-level and versioned: each save is an immutable version. Visible templates: company-shared ones and the caller's own private ones. Requires Schedule access on the project the request is made from. All responses are private, no-store. Requires schedule:write. Only the owner, or a company administrator for a company-shared template, may change it; only the owner may make it private. No query parameters.","body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}}}},{"id":"f8a4800c-2435-49a9-81d0-583c0e45607f","name":"insertProjectScheduleLibraryTemplate — Insert a library template into this project's plan as a new version","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/library/templates/:template_id/insert","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","library","templates",":template_id","insert"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"template_id","value":""}]},"description":"Insert a library template into this project's plan as a new version\n\nTemplates are company-level and versioned: each save is an immutable version. Visible templates: company-shared ones and the caller's own private ones. Requires Schedule access on the project the request is made from. All responses are private, no-store. Requires schedule:write and Schedule admin on the project. Colliding activity ids, WBS ids and activity codes get the prefix; the fragment's open starts follow predecessor_id and its open ends drive successor_id (finish-to-start). Optional lessons scale durations by lessons learned. Saved and calculated like a planner save, with the expected-version check. No query parameters.","body":{"mode":"raw","raw":"{\n  \"expected_version_id\": 0\n}","options":{"raw":{"language":"json"}}}}},{"id":"940ab4a6-3e07-4938-8bfc-d873e77206fa","name":"createProjectScheduleLibraryTemplateVersion — Save a new version of a library template from this project's plan","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/library/templates/:template_id/versions","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","library","templates",":template_id","versions"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"template_id","value":""}]},"description":"Save a new version of a library template from this project's plan\n\nTemplates are company-level and versioned: each save is an immutable version. Visible templates: company-shared ones and the caller's own private ones. Requires Schedule access on the project the request is made from. All responses are private, no-store. Requires schedule:write, Schedule admin on the project and the right to manage the template. The selection kind must match the template's kind. No query parameters.","body":{"mode":"raw","raw":"{\n  \"selection\": {\n    \"kind\": \"plan\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"727e3635-5764-494b-8b26-a2ce5cbd5664","name":"listProjectScheduleLineOfBalance — Line of Balance (flowline) report","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/line-of-balance","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","line-of-balance"],"query":[{"key":"depth","value":"","disabled":true,"description":"Roll placements up to this hierarchy level (0 = top)"},{"key":"min_buffer_days","value":"","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Line of Balance (flowline) report\n\nRequires schedule:read (GET) or schedule:write and live Schedule admin access on the project. The location breakdown (from an activity code type flagged as the Location code, the project's Locations, or the activity location text, as set in the definition's `location_breakdown`), the flowline of the saved head version's latest calculation (one line per trade across the locations, from calculated dates only), conflicts (two trades in one location at once), buffers between trades (`tight` when under `min_buffer_days`), crossings, and the adherence of every generated takt plan (planned vs actual zone completion). Read only."}},{"id":"924d426d-6d58-4099-8bf9-e5ccf5e85366","name":"listProjectScheduleLinks — List schedule activity links","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/links","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","links"],"query":[{"key":"source_type","value":"","disabled":true},{"key":"source_id","value":"","disabled":true,"description":"Requires source_type."},{"key":"activity_id","value":"","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"List schedule activity links\n\nAuthorization is two-sided and live: Schedule access (non-admins only see activities bound to a field task they can see) and the source tool's own visibility for the linked record. All responses are private, no-store. Requires schedule:read token scope. Returns links whose source the caller can see, with the linked activity's calculated dates, float, critical flag and the workflow assessment (required-by for gating items, blocker state for blocking items)."}},{"id":"781ca349-467d-4f9a-8c6f-18ce13dd87ab","name":"createProjectScheduleLink — Link a record from another tool to a schedule activity","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/links","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","links"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Link a record from another tool to a schedule activity\n\nAuthorization is two-sided and live: Schedule access (non-admins only see activities bound to a field task they can see) and the source tool's own visibility for the linked record. All responses are private, no-store. Requires schedule:write token scope and edit permission on the source tool (daily-log evidence: Daily Log view plus Schedule edit). The source type fixes the workflow: submittal / purchase_order / material_delivery gate the activity (lead_time_days, forecast_date); rfi / inspection / punch_item block it (forecast_date); manpower_log / notes_log / quantity_log are progress evidence (progress_event, progress_percent); document / drawing are WPs & Docs references that carry no workflow fields (Documents or Drawings view plus Schedule edit). Change-event links are created through change-impacts. No query parameters.","body":{"mode":"raw","raw":"{\n  \"activity_id\": \"\",\n  \"source_id\": 0,\n  \"source_type\": \"submittal\"\n}","options":{"raw":{"language":"json"}}}}},{"id":"42ae4b7e-4465-4bcd-819f-80ae7821eb18","name":"createProjectScheduleLinksAlert — Evaluate schedule link alerts and notify","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/links/alerts","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","links","alerts"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Evaluate schedule link alerts and notify\n\nAuthorization is two-sided and live: Schedule access (non-admins only see activities bound to a field task they can see) and the source tool's own visibility for the linked record. All responses are private, no-store. Requires schedule:write token scope and Schedule admin. Compares every link with the current calculation and sends in-app/email notifications on transitions only: a linked activity becoming critical, or a gating item's required-by date being breached or forecast to be missed. Idempotent. Notifications are delivered for submittal, RFI and punch-item links (inbox source types); other links are evaluated and recorded. No body or query parameters."}},{"id":"61f705b5-8fed-42f4-8e97-32402a9e3f0d","name":"updateProjectScheduleLink — Update a schedule link's lead time, forecast, progress evidence or note","request":{"method":"PATCH","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/links/:link_id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","links",":link_id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"link_id","value":""}]},"description":"Update a schedule link's lead time, forecast, progress evidence or note\n\nAuthorization is two-sided and live: Schedule access (non-admins only see activities bound to a field task they can see) and the source tool's own visibility for the linked record. All responses are private, no-store. Requires schedule:write token scope. Identity (source and activity) is immutable; re-point by deleting and creating. Change-event impact links accept only a note. No query parameters.","body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}}}},{"id":"c6528d36-c2c1-4804-82cb-02ec6d2ec795","name":"deleteProjectScheduleLink — Remove a schedule link","request":{"method":"DELETE","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/links/:link_id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","links",":link_id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"link_id","value":""}]},"description":"Remove a schedule link\n\nAuthorization is two-sided and live: Schedule access (non-admins only see activities bound to a field task they can see) and the source tool's own visibility for the linked record. All responses are private, no-store. Requires schedule:write token scope. Change-event impact links pin a what-if scenario and are retained as forensic evidence (409). No query parameters."}},{"id":"a0553262-af8d-45a8-8fd7-087e0afa0adf","name":"listProjectScheduleLookahead — Constraints lookahead (make-ready)","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/lookahead","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","lookahead"],"query":[{"key":"from","value":"","disabled":true,"description":"Window start; default today (UTC)."},{"key":"weeks","value":"","disabled":true},{"key":"constrained_only","value":"","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Constraints lookahead (make-ready)\n\nAuthorization is two-sided and live: Schedule access (non-admins only see activities bound to a field task they can see) and the source tool's own visibility for the linked record. All responses are private, no-store. Requires schedule:read token scope. Activities whose calculated window overlaps the next weeks (default 3) and are not complete, with their unresolved linked gating and blocking items. Activities with no open constraints are ready."}},{"id":"af2af489-6da5-41fb-817d-dec88cdd3d06","name":"createProjectScheduleMaterializationApply — Apply a reviewed native field-task publication","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/materialization/apply","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","materialization","apply"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Apply a reviewed native field-task publication\n\nRequires Schedule, Submittals and CRM admin permissions and enabled tools. All responses use private, no-store. Only allowlisted response fields are exposed; raw source, linked-reference, calculation and receipt evidence is not returned. Scoped tokens require schedule:write, submittals:read and crm:read. Rechecks the exact decisions, saved version/calculation, preview digest, task state and publication authority, then atomically applies the supported operations and records publication evidence. Exact replay returns the existing receipt only while authoritative applied state remains current. Retired identities stay reserved; restore requires the exact original identity and current row digest. Existing task identity and unrelated fields are preserved according to the reviewed operation. Submittal due/procurement dates and CRM customer snapshots are not automatically rewritten. JSON is strict snake_case and limited to 2 MiB and 10,000 decisions. Native task publication supports flat task and start/finish milestone activities with date-only calculations and unstarted progress. Hierarchy/derived summaries, imported or mixed historical sources, progressed tasks and unresolved identities or linked-reference/resource constraints require reconciliation and can block application. This is separate from adopted-import task-date projection. ","body":{"mode":"raw","raw":"{\n  \"calculation_id\": 0,\n  \"decisions\": [\n    {\n      \"activity_id\": null,\n      \"assigned_id\": null,\n      \"baseline_policy\": null,\n      \"operation\": null,\n      \"private\": null,\n      \"progress_policy\": null\n    }\n  ],\n  \"expected_version_id\": 0,\n  \"preview_digest\": \"\"\n}","options":{"raw":{"language":"json"}}}}},{"id":"4c3b5cc5-61f6-468f-86d6-3f2236c62f0c","name":"listProjectScheduleMaterializationInventory — List authorized native publication decision candidates","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/materialization/inventory","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","materialization","inventory"],"query":[{"key":"expected_version_id","value":"","disabled":false,"description":"Positive decimal integer; unknown or repeated query keys are rejected."},{"key":"calculation_id","value":"","disabled":true,"description":"Positive decimal integer; unknown or repeated query keys are rejected."}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"List authorized native publication decision candidates\n\nRequires Schedule, Submittals and CRM admin permissions and enabled tools. All responses use private, no-store. Only allowlisted response fields are exposed; raw source, linked-reference, calculation and receipt evidence is not returned. Scoped tokens require schedule:read, submittals:read and crm:read. Read-only candidate inventory; does not run the scheduling engine or write tasks. Select exact activity/task IDs and row digests, then submit those decisions to preview. Candidate actions do not guarantee that a selected pairing can be applied. Inventory is bounded to 50,000 aggregate state/label rows and 16 MiB; required decisions also remain within 10,000/2 MiB. No truncation or pagination. Native task publication supports flat task and start/finish milestone activities with date-only calculations and unstarted progress. Hierarchy/derived summaries, imported or mixed historical sources, progressed tasks and unresolved identities or linked-reference/resource constraints require reconciliation and can block application. This is separate from adopted-import task-date projection. "}},{"id":"e221ca6e-99bb-48bd-8b85-700ae34cea02","name":"createProjectScheduleMaterializationPreview — Preview explicit native field-task publication decisions","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/materialization/preview","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","materialization","preview"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Preview explicit native field-task publication decisions\n\nRequires Schedule, Submittals and CRM admin permissions and enabled tools. All responses use private, no-store. Only allowlisted response fields are exposed; raw source, linked-reference, calculation and receipt evidence is not returned. Scoped tokens require schedule:read, submittals:read and crm:read. Read-only POST: scoped tokens require schedule:read, not schedule:write. Runs engine verification, then rechecks state before returning a digest and allowlisted before/after rows. Does not create tasks, bindings or publication receipts. Successful responses may contain blockers. JSON is strict snake_case and limited to 2 MiB and 10,000 decisions. Native task publication supports flat task and start/finish milestone activities with date-only calculations and unstarted progress. Hierarchy/derived summaries, imported or mixed historical sources, progressed tasks and unresolved identities or linked-reference/resource constraints require reconciliation and can block application. This is separate from adopted-import task-date projection. ","body":{"mode":"raw","raw":"{\n  \"decisions\": [\n    {\n      \"activity_id\": null,\n      \"assigned_id\": null,\n      \"baseline_policy\": null,\n      \"operation\": null,\n      \"private\": null,\n      \"progress_policy\": null\n    }\n  ],\n  \"expected_version_id\": 0\n}","options":{"raw":{"language":"json"}}}}},{"id":"45252ede-1d1b-4ec6-8ed8-17b960459ee2","name":"listProjectSchedulePeriodPerformance — Read stored period performance","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/period-performance","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","period-performance"],"query":[{"key":"financial_period_id","value":"","disabled":true},{"key":"run_id","value":"","disabled":true},{"key":"activity_id","value":"","disabled":true},{"key":"subject","value":"","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Read stored period performance\n\nRequires schedule:read (GET) or schedule:write and live Schedule admin access on the project. Returns the effective (latest) run of every stored period in date order (the Cost & EVM period series) and, with `financial_period_id` or `run_id`, that run's activity and assignment rows (optionally filtered by `activity_id` and `subject`)."}},{"id":"d209603f-36ee-4785-819d-301cc5937431","name":"listProjectSchedulePpc — Percent plan complete (PPC)","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/ppc","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","ppc"],"query":[{"key":"from","value":"","disabled":true,"description":"First week (snapped to its Monday)"},{"key":"to","value":"","disabled":true,"description":"Last week (snapped to its Monday); default the current week"},{"key":"weeks","value":"","disabled":true,"description":"Weeks to show when from is omitted"}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Percent plan complete (PPC)\n\nRequires schedule:read and live Schedule view access on the project. The PPC trend for every week of the window (weeks without a plan are listed with status `none`), the mean over measurable weeks only, PPC per trade, missed commitments by variance reason with the top three reasons, and issues about the measurement (unassessed weeks, unexplained misses). A week's PPC is null until every commitment is assessed."}},{"id":"2f748dc1-160c-4533-8da1-3b100e9e9ceb","name":"listProjectSchedulePresence — Who has the planner open","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/presence","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","presence"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Who has the planner open\n\nRequires schedule:read and live Schedule view access on the project. Everyone else with a live planner session on the project (seen within ttl_ms), one entry per person, with their selected activity and soft lock, plus the saved head."}},{"id":"998e1d03-c7ff-4c47-8c38-5ef05703bc96","name":"createProjectSchedulePresence — Planner presence heartbeat","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/presence","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","presence"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Planner presence heartbeat\n\nRequires schedule:read and Schedule view. Records this session's selected activity and whether it holds unsaved edits to it; poll about every 15 seconds. Advisory only: it never blocks a save. Returns the same body as GET.","body":{"mode":"raw","raw":"{\n  \"activity_id\": \"\",\n  \"editing\": false,\n  \"session_id\": \"\",\n  \"version_id\": 0\n}","options":{"raw":{"language":"json"}}}}},{"id":"16bdf750-baef-4a7e-850c-fae0a503df4a","name":"deleteProjectSchedulePresence — End a planner session","request":{"method":"DELETE","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/presence","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","presence"],"query":[{"key":"session_id","value":"","disabled":false}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"End a planner session\n\nRequires schedule:read and Schedule view. Forgets one of your sessions immediately."}},{"id":"4f937daf-f995-4289-8318-aa5bfb0ad95b","name":"createProjectScheduleProgressApply — Apply explicitly reviewed native schedule progress","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/progress/apply","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","progress","apply"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Apply explicitly reviewed native schedule progress\n\nRequires Schedule, Submittals and CRM administrative access and the documented token scopes. Explicit progress policies select duration or physical percentage, integer rounding and literal local calendar dates. Summary progress is not inferred. Imported/mixed transitions and field-observation reconciliation are not supported. Responses are private, no-store.","body":{"mode":"raw","raw":"{\n  \"calculation_id\": 0,\n  \"decisions\": [\n    {\n      \"assigned_id\": 0,\n      \"baseline_policy\": \"none\",\n      \"identity\": null,\n      \"operation\": \"create\",\n      \"parent_wbs_id\": \"\",\n      \"private\": false,\n      \"progress_policy\": \"unstarted\"\n    }\n  ],\n  \"expected_version_id\": 0,\n  \"preview_digest\": \"\",\n  \"progress_decisions\": [\n    {\n      \"allow_actual_date_clearing\": false,\n      \"expected_row_digest\": \"\",\n      \"identity\": {\n        \"id\": \"\",\n        \"namespace\": \"activity\"\n      },\n      \"policy\": {\n        \"actual_date_policy\": \"local_calendar_date\",\n        \"percentage_basis\": \"duration\",\n        \"rounding\": \"nearest\"\n      },\n      \"task_id\": 0\n    }\n  ]\n}","options":{"raw":{"language":"json"}}}}},{"id":"84e3a073-b519-4161-8ad0-e6aa8fb6fa8a","name":"listProjectScheduleProgressInventory — Review canonical progress and current field values","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/progress/inventory","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","progress","inventory"],"query":[{"key":"expected_version_id","value":"","disabled":false},{"key":"calculation_id","value":"","disabled":false},{"key":"node_page","value":"","disabled":true},{"key":"task_page","value":"","disabled":true},{"key":"page_size","value":"","disabled":true},{"key":"assignee_page","value":"","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Review canonical progress and current field values\n\nAdministrative, paginated progress decision inventory. Returns both canonical measures with raw units, normalized fractions and local actual timestamps alongside current field values and exact row digests. Does not choose a percentage basis or rounding policy, run the engine, or grant publication authority. All pages share an inventory digest; do not combine different digests. A new preview is required before apply."}},{"id":"9a5f5aaf-bf21-452e-8e9a-8720eaa97062","name":"createProjectScheduleProgressPreview — Preview explicitly reviewed native schedule progress","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/progress/preview","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","progress","preview"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Preview explicitly reviewed native schedule progress\n\nRequires Schedule, Submittals and CRM administrative access and the documented token scopes. Explicit progress policies select duration or physical percentage, integer rounding and literal local calendar dates. Summary progress is not inferred. Imported/mixed transitions and field-observation reconciliation are not supported. Responses are private, no-store.","body":{"mode":"raw","raw":"{\n  \"calculation_id\": 0,\n  \"decisions\": [\n    {\n      \"assigned_id\": 0,\n      \"baseline_policy\": \"none\",\n      \"identity\": null,\n      \"operation\": \"create\",\n      \"parent_wbs_id\": \"\",\n      \"private\": false,\n      \"progress_policy\": \"unstarted\"\n    }\n  ],\n  \"expected_version_id\": 0,\n  \"progress_decisions\": [\n    {\n      \"allow_actual_date_clearing\": false,\n      \"expected_row_digest\": \"\",\n      \"identity\": {\n        \"id\": \"\",\n        \"namespace\": \"activity\"\n      },\n      \"policy\": {\n        \"actual_date_policy\": \"local_calendar_date\",\n        \"percentage_basis\": \"duration\",\n        \"rounding\": \"nearest\"\n      },\n      \"task_id\": 0\n    }\n  ]\n}","options":{"raw":{"language":"json"}}}}},{"id":"d20a64e6-773a-4355-8f77-c5db161584be","name":"listProjectScheduleProjection — Preview calculated dates for existing linked schedule tasks","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/projection","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","projection"],"query":[{"key":"expected_version_id","value":"","disabled":false},{"key":"calculation_id","value":"","disabled":true,"description":"Saved schedule calculation for the current version; defaults to the latest eligible schedule calculation."}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Preview calculated dates for existing linked schedule tasks\n\nRead-only full-network review. Requires Schedule, Submittals and CRM admin permissions and enabled tools; scoped tokens need schedule:read, submittals:read and crm:read. Validates the current canonical head, saved schedule calculation, adopted source and exact stable task bindings. Returns the digest, affected task dates and blockers without changing tasks, linked records or customer snapshots. Engine date-only values map to UTC dates without rounding timestamps. All responses use private, no-store."}},{"id":"0a86ae6f-99a6-4b96-807d-72f5f70b4b47","name":"createProjectScheduleProjectionApply — Apply reviewed Planner dates to existing linked schedule tasks","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/projection/apply","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","projection","apply"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Apply reviewed Planner dates to existing linked schedule tasks\n\nRequires Schedule, Submittals and CRM admin permissions and enabled tools; scoped tokens need schedule:write, submittals:read and crm:read. Rechecks the reviewed digest, current version/calculation, source, task snapshot, mappings and authority under the project write lock. Applies only reviewed start/finish/critical changes and records a receipt atomically. Stable task IDs and unrelated fields remain unchanged. No-op receipts avoid task writes. An exact replay returns the existing receipt only while the applied snapshot remains current. Submittal linked-task displays reflect the new task dates; independent submittal due/procurement dates and CRM customer snapshots are not rewritten. JSON bodies are limited to 2 MiB. All responses use private, no-store.","body":{"mode":"raw","raw":"{\n  \"calculation_id\": 0,\n  \"expected_version_id\": 0,\n  \"preview_digest\": \"\"\n}","options":{"raw":{"language":"json"}}}}},{"id":"b635e863-5280-4ee3-8c21-cd01fcf47df1","name":"listProjectScheduleReports — List the schedule report catalog","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/reports","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","reports"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"List the schedule report catalog\n\nStatic catalog of P6-style schedule reports with their export formats and whether they use a named baseline. Requires the schedule:read token scope. No query parameters. Private, no-store."}},{"id":"7f1672e0-eda4-4d28-812a-87e54c77014c","name":"getProjectScheduleReport — Build a schedule report (JSON, CSV, XLSX or PDF)","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/reports/:report_key","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","reports",":report_key"],"query":[{"key":"format","value":"","disabled":true},{"key":"weeks","value":"","disabled":true,"description":"Look-ahead window (lookahead only)."},{"key":"from","value":"","disabled":true,"description":"Look-ahead start (default the data date) or progress period start (default the previous version's data date)."},{"key":"to","value":"","disabled":true,"description":"Progress period end, exclusive (default the data date)."},{"key":"baseline_id","value":"","disabled":true},{"key":"paper","value":"","disabled":true},{"key":"orientation","value":"","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"report_key","value":""}]},"description":"Build a schedule report (JSON, CSV, XLSX or PDF)\n\nRequires live Schedule admin access (complete-network dates and float can disclose private activities) and the schedule:read token scope. Reads only retained evidence: the saved head version, its own retained schedule calculation (exact input, no data-date override), a named baseline's original calculation, and the latest retained health, resource histogram and cost dashboard. Never runs the engine and never writes. All responses are private, no-store. cost_evm additionally requires the budget:read token scope and live Budget view; commitments and posted job cost follow the commitments:read and accounting:read scopes and their owners' access, and are reported unavailable rather than inferred. Baseline reports (baseline_variance, milestones, period_progress) default to the latest named project baseline. Missing evidence returns available=false with a reason, never empty figures. CSV cells beginning with formula characters are neutralized. PDF pages carry the project, version and data date in the header and footer."}},{"id":"c9f5e480-82a4-44d6-8c23-ea28c0c89d96","name":"listProjectScheduleRequiredBy — Required-by register for gating items","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/required-by","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","required-by"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Required-by register for gating items\n\nAuthorization is two-sided and live: Schedule access (non-admins only see activities bound to a field task they can see) and the source tool's own visibility for the linked record. All responses are private, no-store. Requires schedule:read token scope. Every submittal, purchase order and material delivery linked to an activity, ordered by required-by date (calculated early start minus lead time, calendar days), with forecast, slack and state (satisfied, activity_started, on_track, at_risk, breached, no_forecast, unscheduled). No query parameters."}},{"id":"2be63cc0-d91d-4c79-8298-0219b4fd0a20","name":"listProjectScheduleResourceInventory — Find suite resource mapping candidates","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/resource-inventory","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","resource-inventory"],"query":[{"key":"source_type","value":"","disabled":false},{"key":"search","value":"","disabled":true},{"key":"page","value":"1","disabled":true},{"key":"page_size","value":"","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Find suite resource mapping candidates\n\nRequires schedule:read. Requires live Schedule admin and selected owning tool view/enabled access; company view is also required for people, crews and equipment. Scoped tokens additionally require workforce:read, equipment:read or materials:read for every returned source. Identity mapping is unapproved and does not certify unit conversion, availability, reservations, capacity, rates, payroll or ledger actuals. Private, no-store. Live owner pagination is not a multi-page snapshot. Inactive or unavailable sources remain visible with their current state."}},{"id":"b388a1da-9264-4a72-8df1-f7c65cee6826","name":"createProjectScheduleResourceLevelingApply — Apply a retained leveling proposal as a new schedule version","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/resource-leveling/apply","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","resource-leveling","apply"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Apply a retained leveling proposal as a new schedule version\n\nRequires live Schedule admin access and schedule:write token scope. The proposal must have been calculated for the current head and expected_version_id must equal it (checked again at publish). Each selected move becomes a Start-On-Or-After constraint at the proposed start; started activities and activities with another primary constraint are skipped, never overridden. Saves through the standard versioned definition path (engine recalculation, history) and records an audit event listing every constraint. Field tasks change only when published. No query parameters. All responses are private, no-store.","body":{"mode":"raw","raw":"{\n  \"expected_version_id\": 0,\n  \"report_id\": 0\n}","options":{"raw":{"language":"json"}}}}},{"id":"72bb4ed5-148d-4d62-87d8-2f4587e0e2a0","name":"listProjectScheduleResourceMappingReports — List retained resource mapping metadata","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/resource-mapping-reports","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","resource-mapping-reports"],"query":[{"key":"before_id","value":"","disabled":true},{"key":"version_id","value":"","disabled":true},{"key":"page_size","value":"","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"List retained resource mapping metadata\n\nRequires schedule:read. Requires live Schedule admin and selected owning tool view/enabled access; company view is also required for people, crews and equipment. Scoped tokens additionally require workforce:read, equipment:read or materials:read for every returned source. Identity mapping is unapproved and does not certify unit conversion, availability, reservations, capacity, rates, payroll or ledger actuals. Private, no-store. Every displayed report is checked against its selected owners. A denied report denies the page; history never silently omits unauthorized reports."}},{"id":"364b6c5f-a146-44dc-8e8e-f76ea813fdac","name":"createProjectScheduleResourceMappingReport — Retain reviewed suite resource mappings","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/resource-mapping-reports","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","resource-mapping-reports"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Retain reviewed suite resource mappings\n\nRequires schedule:write. Requires live Schedule admin and selected owning tool view/enabled access; company view is also required for people, crews and equipment. Scoped tokens additionally require workforce:read, equipment:read or materials:read for every returned source. Identity mapping is unapproved and does not certify unit conversion, availability, reservations, capacity, rates, payroll or ledger actuals. Private, no-store. Both reviewed digests are required. Changed mapping or source facts return 409. No plan head, task, owner record or stock is changed.","body":{"mode":"raw","raw":"{\n  \"expected_mapping_digest\": \"\",\n  \"expected_source_digest\": \"\",\n  \"mappings\": [\n    {\n      \"resource_id\": \"\",\n      \"source_id\": 0,\n      \"source_type\": \"person\"\n    }\n  ],\n  \"version_id\": 0\n}","options":{"raw":{"language":"json"}}}}},{"id":"87c98b8b-0080-4300-8100-a314c84294cc","name":"getProjectScheduleResourceMappingReport — Read retained suite resource mapping evidence","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/resource-mapping-reports/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","resource-mapping-reports",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Read retained suite resource mapping evidence\n\nRequires schedule:read. Requires live Schedule admin and selected owning tool view/enabled access; company view is also required for people, crews and equipment. Scoped tokens additionally require workforce:read, equipment:read or materials:read for every returned source. Identity mapping is unapproved and does not certify unit conversion, availability, reservations, capacity, rates, payroll or ledger actuals. Private, no-store. Returns immutable source facts from retention time without refreshing them; current owning permissions and scopes are still required."}},{"id":"7252d6bb-545e-4329-8e88-d747f79c2d68","name":"createProjectScheduleResourceMappingsPreview — Preview explicit suite resource mappings","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/resource-mappings/preview","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","resource-mappings","preview"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Preview explicit suite resource mappings\n\nRequires schedule:read. Requires live Schedule admin and selected owning tool view/enabled access; company view is also required for people, crews and equipment. Scoped tokens additionally require workforce:read, equipment:read or materials:read for every returned source. Identity mapping is unapproved and does not certify unit conversion, availability, reservations, capacity, rates, payroll or ledger actuals. Private, no-store. No records are persisted. Each schedule resource maps to at most one explicit source. Multiple resources sharing a source are flagged for reconciliation.","body":{"mode":"raw","raw":"{\n  \"mappings\": [\n    {\n      \"resource_id\": \"\",\n      \"source_id\": 0,\n      \"source_type\": \"person\"\n    }\n  ],\n  \"version_id\": 0\n}","options":{"raw":{"language":"json"}}}}},{"id":"d8bbcecc-f8e5-48e6-8ea7-69d11951733e","name":"listProjectScheduleResourceReports — List saved resource report history","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/resource-reports","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","resource-reports"],"query":[{"key":"before_id","value":"","disabled":true},{"key":"version_id","value":"","disabled":true},{"key":"page_size","value":"","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"List saved resource report history\n\nRequires schedule:read token scope and live Schedule admin permission. Resource histograms and leveling proposals use explicitly selected immutable versions. Retains original engine qualifications and provenance. Capacity is from schedule inputs, not verified suite workforce availability. Applied mode includes proposed spans only. No definition heads, resource records or field dates are changed. Private, no-store."}},{"id":"05db631b-f80e-4c2b-81da-466ea20c2829","name":"createProjectScheduleResourceReport — Create saved-version resource report","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/resource-reports","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","resource-reports"],"query":[{"key":"async","value":"","disabled":true,"description":"`1` always queues a background schedule analysis job (202); `0` forces the inline path (30 s engine limit). Omitted: inputs above the size threshold are queued automatically."}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Create saved-version resource report\n\nRequires schedule:write token scope and live Schedule admin permission. Resource histograms and leveling proposals use explicitly selected immutable versions. Retains original engine qualifications and provenance. Capacity is from schedule inputs, not verified suite workforce availability. Applied mode includes proposed spans only. No definition heads, resource records or field dates are changed. Private, no-store.","body":{"mode":"raw","raw":"{\n  \"analysis\": {\n    \"kind\": \"histogram\"\n  },\n  \"data_date\": \"2026-01-31\",\n  \"version_id\": 0\n}","options":{"raw":{"language":"json"}}}}},{"id":"ad97661d-9671-4c5b-88b8-bb52b43e6d87","name":"getProjectScheduleResourceReport — Read saved resource report","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/resource-reports/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","resource-reports",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Read saved resource report\n\nRequires schedule:read token scope and live Schedule admin permission. Resource histograms and leveling proposals use explicitly selected immutable versions. Retains original engine qualifications and provenance. Capacity is from schedule inputs, not verified suite workforce availability. Applied mode includes proposed spans only. No definition heads, resource records or field dates are changed. Private, no-store."}},{"id":"231b5005-33a8-47ae-8d92-be866485b6a3","name":"listProjectScheduleResourceView — Resource demand against capacity, over-allocation and the latest leveling proposal","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/resource-view","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","resource-view"],"query":[{"key":"report_id","value":"","disabled":true},{"key":"leveling_report_id","value":"","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Resource demand against capacity, over-allocation and the latest leveling proposal\n\nRequires live Schedule admin access and schedule:read token scope. Shapes the latest retained resource histogram for the saved head (or report_id) into per-resource period series of total and peak-day demand, capacity recorded in the plan, engine-reported over-allocated days and, when a retained workforce capacity review is visible to the caller, recorded person availability converted by the stated minutes per unit. Includes the latest (or leveling_report_id) leveling proposal with per-move applicability. Read-only; calculate reports with POST /schedule/resource-reports. All responses are private, no-store."}},{"id":"59abb967-4a8d-425d-8c35-ead513bfa21d","name":"listProjectScheduleScenarios — List what-if schedule scenarios","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/scenarios","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","scenarios"],"query":[{"key":"before_id","value":"","disabled":true},{"key":"status","value":"","disabled":true},{"key":"page_size","value":"","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"List what-if schedule scenarios\n\nRequires live Schedule admin access because scenario results disclose the full network dates and float. All responses are private, no-store. Requires schedule:read token scope. Newest first; edits and status only, without engine results."}},{"id":"0c37bfbd-8f84-4d1d-8b13-2135477d1d86","name":"createProjectScheduleScenario — Create a what-if scenario from the current saved version","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/scenarios","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","scenarios"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Create a what-if scenario from the current saved version\n\nRequires live Schedule admin access because scenario results disclose the full network dates and float. All responses are private, no-store. Requires schedule:write token scope. expected_version_id must be the current schedule head; initial edits must apply cleanly to it. Idempotent by request_id (replays return 200). Never changes the saved schedule. No query parameters.","body":{"mode":"raw","raw":"{\n  \"expected_version_id\": 0,\n  \"name\": \"\",\n  \"request_id\": \"\"\n}","options":{"raw":{"language":"json"}}}}},{"id":"43ee4be1-8c50-4790-8420-50525e456fca","name":"getProjectScheduleScenario — Read a scenario with its latest comparison and compression evidence","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/scenarios/:scenario_id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","scenarios",":scenario_id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"scenario_id","value":""}]},"description":"Read a scenario with its latest comparison and compression evidence\n\nRequires live Schedule admin access because scenario results disclose the full network dates and float. All responses are private, no-store. Requires schedule:read token scope. No query parameters."}},{"id":"5b62840d-a9cd-427a-8146-2a223c38157b","name":"updateProjectScheduleScenario — Revise an open scenario's name, description or edits","request":{"method":"PATCH","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/scenarios/:scenario_id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","scenarios",":scenario_id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"scenario_id","value":""}]},"description":"Revise an open scenario's name, description or edits\n\nRequires live Schedule admin access because scenario results disclose the full network dates and float. All responses are private, no-store. Requires schedule:write token scope. expected_revision must match; each change advances the revision by one. Edits replace the full list and must apply cleanly to the pinned base version. No query parameters.","body":{"mode":"raw","raw":"{\n  \"expected_revision\": 0\n}","options":{"raw":{"language":"json"}}}}},{"id":"29b76823-8e29-4244-828f-14f83a91ec14","name":"adoptProjectScheduleScenario — Adopt a reviewed scenario as a new schedule version","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/scenarios/:scenario_id/adopt","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","scenarios",":scenario_id","adopt"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"scenario_id","value":""}]},"description":"Adopt a reviewed scenario as a new schedule version\n\nRequires live Schedule admin access because scenario results disclose the full network dates and float. All responses are private, no-store. Requires schedule:write token scope. Saves through the versioned definition path with the same expected-version (stale-write) check, history and calculation; the scenario closes as adopted in the same transaction. Requires the scenario base to still be the current version and a retained comparison for the expected revision. No query parameters.","body":{"mode":"raw","raw":"{\n  \"expected_revision\": 0,\n  \"expected_version_id\": 0\n}","options":{"raw":{"language":"json"}}}}},{"id":"864d9033-50fc-4ed9-81dd-5a20cea0430e","name":"calculateProjectScheduleScenario — Calculate a scenario and compare it with its base version","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/scenarios/:scenario_id/calculate","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","scenarios",":scenario_id","calculate"],"query":[{"key":"async","value":"","disabled":true,"description":"`1` always queues a background schedule analysis job (202); `0` forces the inline path (30 s engine limit). Omitted: inputs above the size threshold are queued automatically."}],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"scenario_id","value":""}]},"description":"Calculate a scenario and compare it with its base version\n\nRequires live Schedule admin access because scenario results disclose the full network dates and float. All responses are private, no-store. Requires schedule:write token scope. Calculates the pinned base and the edited scenario with the original CPM engine and retains an immutable comparison: finish delta, longest-path and criticality changes, float changes, per-activity date deltas, and cost impact when cost-loaded data exists (recorded budgets or priced resources, same currency). Acceleration premium is only what the edits state. No query parameters.","body":{"mode":"raw","raw":"{\n  \"expected_revision\": 0\n}","options":{"raw":{"language":"json"}}}}},{"id":"3e157c51-b8e1-4e64-8579-5047d047691f","name":"compressionProjectScheduleScenario — Propose crashing and fast-tracking for a scenario","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/scenarios/:scenario_id/compression","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","scenarios",":scenario_id","compression"],"query":[{"key":"async","value":"","disabled":true,"description":"`1` always queues a background schedule analysis job (202); `0` forces the inline path (30 s engine limit). Omitted: inputs above the size threshold are queued automatically."}],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"scenario_id","value":""}]},"description":"Propose crashing and fast-tracking for a scenario\n\nRequires live Schedule admin access because scenario results disclose the full network dates and float. All responses are private, no-store. Requires schedule:write token scope. Ports the original greedy CPM crashing (shorten the cheapest longest-path activity one day at a time, rescheduling after every cut) and trials replacing each driving FS link with an overlapping SS link. Every gain is measured by a real reschedule. Without crash_options, costs are illustrative unit costs. Each proposal carries a suggested scenario edit. Proposals only; no query parameters.","body":{"mode":"raw","raw":"{\n  \"expected_revision\": 0\n}","options":{"raw":{"language":"json"}}}}},{"id":"5a65c7be-3123-4200-83f9-d479faa5afe3","name":"discardProjectScheduleScenario — Discard an open scenario","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/scenarios/:scenario_id/discard","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","scenarios",":scenario_id","discard"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"scenario_id","value":""}]},"description":"Discard an open scenario\n\nRequires live Schedule admin access because scenario results disclose the full network dates and float. All responses are private, no-store. Requires schedule:write token scope. Terminal; retained evidence is kept. No query parameters.","body":{"mode":"raw","raw":"{\n  \"expected_revision\": 0\n}","options":{"raw":{"language":"json"}}}}},{"id":"e41cccdd-ae7f-43f3-8975-9f9f2f2de614","name":"listProjectScheduleSpreadsheet — Export the current version's activities to XLSX","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/spreadsheet","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","spreadsheet"],"query":[{"key":"layout_ref","value":"","disabled":true},{"key":"columns","value":"","disabled":true,"description":"Comma-separated column keys, e.g. duration,start,code:Area,udf:Inspector"}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Export the current version's activities to XLSX\n\nOne row per activity: Activity ID (the match key for re-import), Activity Name, then the layout's visible columns, codes and UDFs included. Editable cells hold the planner's draft text; calculated cells the grid's display text from the latest schedule calculation. A Columns sheet records each header's key and whether it is editable. Columns come from `columns` (comma-separated keys), else `layout_ref`, else the Classic Schedule layout. Requires Schedule admin."}},{"id":"31ab3409-47de-4e35-8fb9-6d1548cfabba","name":"createProjectScheduleSpreadsheetApply — Apply a reviewed activity spreadsheet","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/spreadsheet/apply","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","spreadsheet","apply"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Apply a reviewed activity spreadsheet\n\nP6 Import from spreadsheet. Rows match the current version's activities by Activity ID. Editable columns (name, durations, % complete, calendar, constraint, activity type, codes, UDFs) are validated exactly like inline grid edits; edited calculated columns are rejected and listed. Unknown Activity IDs are rejected or inserted (unknown_ids). Saves one new version with an audit event; the preview must still match preview_digest. Requires Schedule admin and schedule:write. No query parameters.","body":{"mode":"raw","raw":"{\n  \"expected_version_id\": 0,\n  \"file_base64\": \"\",\n  \"preview_digest\": \"\"\n}","options":{"raw":{"language":"json"}}}}},{"id":"b894db94-c436-4cfe-8d66-695e380bacac","name":"createProjectScheduleSpreadsheetPreview — Review an edited activity spreadsheet","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/spreadsheet/preview","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","spreadsheet","preview"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Review an edited activity spreadsheet\n\nP6 Import from spreadsheet. Rows match the current version's activities by Activity ID. Editable columns (name, durations, % complete, calendar, constraint, activity type, codes, UDFs) are validated exactly like inline grid edits; edited calculated columns are rejected and listed. Unknown Activity IDs are rejected or inserted (unknown_ids). Read-only. Requires Schedule admin and schedule:write. No query parameters.","body":{"mode":"raw","raw":"{\n  \"expected_version_id\": 0,\n  \"file_base64\": \"\"\n}","options":{"raw":{"language":"json"}}}}},{"id":"f3e5424e-ac1b-4e64-82e1-63065549620f","name":"listProjectScheduleSubmittals — List schedule submittal packages","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/submittals","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","submittals"],"query":[{"key":"before_id","value":"","disabled":true},{"key":"period_id","value":"","disabled":true},{"key":"page_size","value":"","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"List schedule submittal packages\n\nRequires live Schedule admin access because the update cycle discloses the full network dates and float. All responses are private, no-store. Requires schedule:read token scope. Newest first, with generated document metadata."}},{"id":"075ce5cc-577d-4117-8e60-f4e74afb1e06","name":"createProjectScheduleSubmittal — Build a schedule submittal package","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/submittals","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","submittals"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Build a schedule submittal package\n\nRequires live Schedule admin access because the update cycle discloses the full network dates and float. All responses are private, no-store. Requires schedule:write token scope. Packages a submitted or accepted update round, or a baseline: P6 XER and/or P6 XML export, narrative, health/check report and compare report, pinned to one immutable version. Idempotent by request_id.","body":{"mode":"raw","raw":"{\n  \"request_id\": \"\",\n  \"subject\": \"update\"\n}","options":{"raw":{"language":"json"}}}}},{"id":"9b05134d-6806-46f6-83c8-96bec6d00f76","name":"getProjectScheduleSubmittal — Read a schedule submittal package","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/submittals/:submittal_id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","submittals",":submittal_id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"submittal_id","value":""}]},"description":"Read a schedule submittal package\n\nRequires live Schedule admin access because the update cycle discloses the full network dates and float. All responses are private, no-store. Requires schedule:read token scope. No query parameters."}},{"id":"d55e2bbc-9064-4e42-89e1-69963d4f8ee2","name":"distributeProjectScheduleSubmittal — Distribute a schedule submittal","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/submittals/:submittal_id/distribute","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","submittals",":submittal_id","distribute"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"submittal_id","value":""}]},"description":"Distribute a schedule submittal\n\nRequires live Schedule admin access because the update cycle discloses the full network dates and float. All responses are private, no-store. Requires schedule:write token scope. Sends one Emails-tool communication (users and/or external addresses) back-linked to the package, with document links; recorded once.","body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}}}},{"id":"e1dfe67a-ebea-4069-8b04-1a86c7739aec","name":"getProjectScheduleSubmittalFile — Download a submittal document","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/submittals/:submittal_id/files/:kind","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","submittals",":submittal_id","files",":kind"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"submittal_id","value":""},{"key":"kind","value":""}]},"description":"Download a submittal document\n\nRequires live Schedule admin access because the update cycle discloses the full network dates and float. All responses are private, no-store. Requires schedule:read token scope. The immutable generated file; X-Submittal-Document-SHA256 carries its digest."}},{"id":"ed784882-5420-4cd2-83c4-eed602dae094","name":"responseProjectScheduleSubmittal — Record the response to a schedule submittal","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/submittals/:submittal_id/response","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","submittals",":submittal_id","response"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"submittal_id","value":""}]},"description":"Record the response to a schedule submittal\n\nRequires live Schedule admin access because the update cycle discloses the full network dates and float. All responses are private, no-store. Requires schedule:write token scope. Records the external response once, after distribution.","body":{"mode":"raw","raw":"{\n  \"response\": \"approved\",\n  \"response_date\": \"2026-01-31\"\n}","options":{"raw":{"language":"json"}}}}},{"id":"82d0daba-9ed8-4553-8a0b-d628db67b84c","name":"createProjectScheduleTaktPreview — Preview a takt plan","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/takt/preview","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","takt","preview"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Preview a takt plan\n\nRequires schedule:read (GET) or schedule:write and live Schedule admin access on the project. Runs the scheduling engine's takt module: every trade (wagon) occupies exactly one zone for exactly one takt; crews are derived from crew-days of work content up to each trade's ceiling; the plan is returned as slot dates on the given calendar plus an ordinary network (each trade's zone chain and the handover between trades, finish-to-start, every slot pinned start-on-or-after its takt). Overloaded trades, empty wagons and low utilisation are reported in `issues`. A proposal only: nothing is stored; the planner applies a reviewed preview to its draft.","body":{"mode":"raw","raw":"{\n  \"start\": \"2026-01-31\",\n  \"takt_days\": 0,\n  \"wagons\": [\n    {\n      \"id\": \"\"\n    }\n  ],\n  \"zones\": [\n    {\n      \"id\": \"\"\n    }\n  ]\n}","options":{"raw":{"language":"json"}}}}},{"id":"a139cf5b-269e-4422-8811-34b8f3d29f0e","name":"listProjectScheduleTimeImpactAnalyses — List time impact analyses","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/time-impact-analyses","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","time-impact-analyses"],"query":[{"key":"change_event_id","value":"","disabled":true},{"key":"status","value":"","disabled":true},{"key":"before_id","value":"","disabled":true},{"key":"page_size","value":"","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"List time impact analyses\n\nProspective time impact analysis (AACE RP 52R-06). Requires live Schedule admin; a linked change event also needs change event edit access. Private, no-store. Newest first."}},{"id":"90fb9977-daab-498d-84f1-ca9a66d508ca","name":"createProjectScheduleTimeImpactAnalyse — Submit a fragnet for owner review","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/time-impact-analyses","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","time-impact-analyses"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Submit a fragnet for owner review\n\nProspective time impact analysis (AACE RP 52R-06). Requires live Schedule admin; a linked change event also needs change event edit access. Private, no-store. The fragnet is fixed at submission against the update in effect: the last approved update period statused on or before delay_start (RP 52R-06 Step 2); 422 when none exists. Every impacted activity, extra-link end and the measured milestone must be in that update. Idempotent by request_id. No query parameters.","body":{"mode":"raw","raw":"{\n  \"delay_start\": \"2026-01-31\",\n  \"fragnet\": {\n    \"description\": \"\",\n    \"events\": [\n      {\n        \"duration_days\": 0,\n        \"id\": \"\",\n        \"impacts\": \"\",\n        \"name\": \"\"\n      }\n    ],\n    \"id\": \"\"\n  },\n  \"request_id\": \"\",\n  \"title\": \"\",\n  \"unit\": \"work_days\"\n}","options":{"raw":{"language":"json"}}}}},{"id":"6deadaf7-f3a4-4cba-8eed-e938c88d3957","name":"getProjectScheduleTimeImpactAnalyse — Read a time impact analysis","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/time-impact-analyses/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","time-impact-analyses",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Read a time impact analysis\n\nProspective time impact analysis (AACE RP 52R-06). Requires live Schedule admin; a linked change event also needs change event edit access. Private, no-store. Includes the review history and, once analysed, the report's time impact summary."}},{"id":"d3afaf4c-b0a3-4c77-8b61-b1051fb07691","name":"analyzeProjectScheduleTimeImpactAnalyse — Run RP 52R-06 Steps 2-8 on the accepted fragnet","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/time-impact-analyses/:id/analyze","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","time-impact-analyses",":id","analyze"],"query":[{"key":"async","value":"","disabled":true,"description":"`1` always queues a background schedule analysis job (202); `0` forces the inline path (30 s engine limit). Omitted: inputs above the size threshold are queued automatically."}],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Run RP 52R-06 Steps 2-8 on the accepted fragnet\n\nProspective time impact analysis (AACE RP 52R-06). Requires live Schedule admin; a linked change event also needs change event edit access. Private, no-store. Only an accepted fragnet without a report. Retains an immutable forensic report (method prospective_tia, evidence manifest) and links it to the analysis once; inputs are the update in effect then later approved updates. A refusal by the standard (Step 2 selection, Step 3(a) zero-duration gate, Step 3(b)) is 422 and retains nothing. Same async negotiation as forensics."}},{"id":"c9234160-3e28-4b35-8b99-d36837ad38fc","name":"decisionProjectScheduleTimeImpactAnalyse — Accept or reject the fragnet (reviewed -> accepted | rejected)","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/time-impact-analyses/:id/decision","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","time-impact-analyses",":id","decision"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Accept or reject the fragnet (reviewed -> accepted | rejected)\n\nProspective time impact analysis (AACE RP 52R-06). Requires live Schedule admin; a linked change event also needs change event edit access. Private, no-store. By someone other than the submitter; a rejection states why. Final once recorded; a rejected fragnet is resubmitted as a new analysis.","body":{"mode":"raw","raw":"{\n  \"decision\": \"accepted\",\n  \"expected_revision\": 0\n}","options":{"raw":{"language":"json"}}}}},{"id":"0f99392e-b3ef-4226-80a3-932a2eabc2a0","name":"reviewProjectScheduleTimeImpactAnalyse — Record the owner's review (submitted -> reviewed)","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/time-impact-analyses/:id/review","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","time-impact-analyses",":id","review"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Record the owner's review (submitted -> reviewed)\n\nProspective time impact analysis (AACE RP 52R-06). Requires live Schedule admin; a linked change event also needs change event edit access. Private, no-store. By someone other than the submitter; expected_revision guards concurrent edits. Final once recorded.","body":{"mode":"raw","raw":"{\n  \"expected_revision\": 0,\n  \"note\": \"\"\n}","options":{"raw":{"language":"json"}}}}},{"id":"8c56729e-6d50-4ea5-8213-012b42f951b5","name":"listProjectScheduleUpdates — List schedule update periods (period history)","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/updates","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","updates"],"query":[{"key":"before_id","value":"","disabled":true},{"key":"status","value":"","disabled":true},{"key":"page_size","value":"","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"List schedule update periods (period history)\n\nRequires live Schedule admin access because the update cycle discloses the full network dates and float. All responses are private, no-store. Requires schedule:read token scope. Newest first: data date, forecast finish, longest path, health grade, approval state and ball in court. forensic_series lists accepted updates of record in data-date order for windows analysis."}},{"id":"909d3f5f-1ab2-4dde-89ff-2e51547c7495","name":"createProjectScheduleUpdate — Open a schedule update for a new data date","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/updates","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","updates"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Open a schedule update for a new data date\n\nRequires live Schedule admin access because the update cycle discloses the full network dates and float. All responses are private, no-store. Requires schedule:write token scope. Drafts from the current saved head (expected_version_id): when the data date changes, a new version is saved through the versioned definition path. One update in progress per project; the data date must follow the previous update. Idempotent by request_id (replays return 200).","body":{"mode":"raw","raw":"{\n  \"data_date\": \"2026-01-31\",\n  \"expected_version_id\": 0,\n  \"request_id\": \"\"\n}","options":{"raw":{"language":"json"}}}}},{"id":"f14aa005-18ce-4ead-8e86-c5dca962ab1e","name":"getProjectScheduleUpdate — Read a schedule update","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/updates/:update_id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","updates",":update_id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"update_id","value":""}]},"description":"Read a schedule update\n\nRequires live Schedule admin access because the update cycle discloses the full network dates and float. All responses are private, no-store. Requires schedule:read token scope. Update, latest check evidence, narrative draft generated from the checks, submission rounds with reviewer steps, comments and ball in court."}},{"id":"061da92d-bafd-47a1-8d2c-1ab78b9657ad","name":"updateProjectScheduleUpdate — Edit a schedule update narrative or name","request":{"method":"PATCH","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/updates/:update_id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","updates",":update_id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"update_id","value":""}]},"description":"Edit a schedule update narrative or name\n\nRequires live Schedule admin access because the update cycle discloses the full network dates and float. All responses are private, no-store. Requires schedule:write token scope. Only while open or revision requested; advances the revision.","body":{"mode":"raw","raw":"{\n  \"expected_revision\": 0\n}","options":{"raw":{"language":"json"}}}}},{"id":"9092d486-7493-43f7-8940-26685d9fd874","name":"createProjectScheduleUpdateCheck — Run the update checks","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/updates/:update_id/checks","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","updates",":update_id","checks"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"update_id","value":""}]},"description":"Run the update checks\n\nRequires live Schedule admin access because the update cycle discloses the full network dates and float. All responses are private, no-store. Requires schedule:write token scope. Calculates the current head, the previous accepted update and the baseline with the original engine and retains immutable evidence: DCMA health, out-of-sequence progress, actuals after the data date, progress not reported, changes since the last accepted update, baseline slip, critical path change and float erosion.","body":{"mode":"raw","raw":"{\n  \"expected_revision\": 0\n}","options":{"raw":{"language":"json"}}}}},{"id":"9abfe853-bfb7-4ed9-8327-d9e1e105b296","name":"createProjectScheduleUpdateComment — Comment on a submitted schedule update","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/updates/:update_id/comments","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","updates",":update_id","comments"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"update_id","value":""}]},"description":"Comment on a submitted schedule update\n\nRequires live Schedule admin access because the update cycle discloses the full network dates and float. All responses are private, no-store. Requires schedule:write token scope. Optionally on one activity of the submitted version. Append-only.","body":{"mode":"raw","raw":"{\n  \"body\": \"\"\n}","options":{"raw":{"language":"json"}}}}},{"id":"876e9a24-a426-484a-8058-b3bbf19ef5bb","name":"resolveProjectScheduleUpdateComment — Resolve a review comment","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/updates/:update_id/comments/:comment_id/resolve","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","updates",":update_id","comments",":comment_id","resolve"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"update_id","value":""},{"key":"comment_id","value":""}]},"description":"Resolve a review comment\n\nRequires live Schedule admin access because the update cycle discloses the full network dates and float. All responses are private, no-store. Requires schedule:write token scope. Recorded once. No request body."}},{"id":"45fa7e52-bcc1-4cd4-831a-2feff184d754","name":"respondProjectScheduleUpdate — Review a submitted schedule update","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/updates/:update_id/respond","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","updates",":update_id","respond"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"update_id","value":""}]},"description":"Review a submitted schedule update\n\nRequires live Schedule admin access because the update cycle discloses the full network dates and float. All responses are private, no-store. Requires schedule:write token scope. A reviewer holding the ball approves, approves as noted, or requests a revision (comment required). The final approval records the submitted version as the immutable accepted update of record.","body":{"mode":"raw","raw":"{\n  \"expected_revision\": 0,\n  \"response\": \"approved\"\n}","options":{"raw":{"language":"json"}}}}},{"id":"0ebcaafa-c8ff-457e-849f-b411abdf121a","name":"listProjectScheduleUpdateReview — Compare a submission against the previous accepted update","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/updates/:update_id/review","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","updates",":update_id","review"],"query":[{"key":"submission_id","value":"","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"update_id","value":""}]},"description":"Compare a submission against the previous accepted update\n\nRequires live Schedule admin access because the update cycle discloses the full network dates and float. All responses are private, no-store. Requires schedule:read token scope. Flags logic, duration, constraint, calendar, progress and retroactive actual changes against the previous accepted update (or the baseline for the first update), with the round's check evidence and comments."}},{"id":"00971040-fa26-4325-8a51-9092d145bdef","name":"submitProjectScheduleUpdate — Submit a schedule update for review","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/updates/:update_id/submit","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","updates",":update_id","submit"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"update_id","value":""}]},"description":"Submit a schedule update for review\n\nRequires live Schedule admin access because the update cycle discloses the full network dates and float. All responses are private, no-store. Requires schedule:write token scope. Freezes the checked head version, check evidence and complete narrative into a review round. Reviewer steps (explicit or from a ScheduleUpdate workflow template) are advanced by the shared workflow engine; reviewers need Schedule admin and cannot be the submitter. Failed checks require acknowledge_failures.","body":{"mode":"raw","raw":"{\n  \"check_run_id\": 0,\n  \"expected_revision\": 0\n}","options":{"raw":{"language":"json"}}}}},{"id":"595261ae-b25f-439b-8fe8-ae6f4aa4f9ed","name":"withdrawProjectScheduleUpdate — Withdraw a schedule update","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/updates/:update_id/withdraw","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","updates",":update_id","withdraw"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"update_id","value":""}]},"description":"Withdraw a schedule update\n\nRequires live Schedule admin access because the update cycle discloses the full network dates and float. All responses are private, no-store. Requires schedule:write token scope. Closes an update in progress; pending reviewer steps are voided. Saved versions are retained.","body":{"mode":"raw","raw":"{\n  \"expected_revision\": 0,\n  \"reason\": \"\"\n}","options":{"raw":{"language":"json"}}}}},{"id":"5cfeebc5-a5a9-4cac-8947-bf23094864b6","name":"createProjectScheduleVersionsDiff — Compare two saved canonical schedule versions","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/versions/diff","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","versions","diff"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Compare two saved canonical schedule versions\n\nRead-only authored-input comparison. Requires live Schedule admin permission and schedule:read token scope despite POST. Both immutable versions must belong to the current project and pass content integrity checks. Includes all activity fields, relationship multiset changes and changed project sections. Missing fields differ from explicit null. Does not calculate CPM, advance the head or publish field changes. All responses are private, no-store. Response limit is 16 MiB.","body":{"mode":"raw","raw":"{\n  \"version_a\": 0,\n  \"version_b\": 0\n}","options":{"raw":{"language":"json"}}}}},{"id":"e452a0c1-388e-40fb-84cb-095df69fffd9","name":"listProjectScheduleVersionExport — Export a canonical schedule version as Primavera P6 XER, P6 XML or MSPDI","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/versions/:version_id/export","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","versions",":version_id","export"],"query":[{"key":"format","value":"","disabled":false}],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"version_id","value":"","description":"Canonical schedule version id, or `current` for the head version."}]},"description":"Export a canonical schedule version as Primavera P6 XER, P6 XML or MSPDI\n\nRequires Schedule admin permission and an enabled Schedule tool. Recalculates the version with the scheduling engine and writes it in the requested format, including in-app edits. P6 fields the canonical model does not carry are restored from the version's retained source metadata (p6_retention). Field coverage and intentional differences: docs/SCHEDULE-P6-PARITY.md. Nothing is written. Download responses are private, no-store."}},{"id":"381ef52c-8e4b-42e0-8398-a44260bba675","name":"listProjectScheduleWeeklyPlans — List weekly work plans","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/weekly-plans","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","weekly-plans"],"query":[{"key":"from","value":"","disabled":true,"description":"First week (snapped to its Monday)"},{"key":"to","value":"","disabled":true,"description":"Last week (snapped to its Monday); default the current week"},{"key":"weeks","value":"","disabled":true,"description":"Weeks to show when from is omitted"}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"List weekly work plans\n\nRequires schedule:read and live Schedule view access on the project. Last Planner weekly work plans in a window of weeks, newest first, each with its commitments and week PPC."}},{"id":"93d47892-f79e-4604-8502-8a844807559a","name":"createProjectScheduleWeeklyPlan — Start a weekly work plan","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/weekly-plans","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","weekly-plans"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Start a weekly work plan\n\nRequires schedule:write and live Schedule edit access on the project. Audited. Creates the draft plan for a Monday-starting week (one per week).","body":{"mode":"raw","raw":"{\n  \"note\": \"\",\n  \"week_starting\": \"2026-01-31\"\n}","options":{"raw":{"language":"json"}}}}},{"id":"0f90064f-3dfc-49bd-8473-da1367185813","name":"getProjectScheduleWeeklyPlan — Read a weekly work plan","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/weekly-plans/:plan_id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","weekly-plans",":plan_id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"plan_id","value":""}]},"description":"Read a weekly work plan\n\nRequires schedule:read and live Schedule view access on the project. One plan with its commitments and week PPC."}},{"id":"3d1dca02-c8bc-4c25-80ec-d1137aa13b12","name":"updateProjectScheduleWeeklyPlan — Edit a weekly work plan note","request":{"method":"PATCH","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/weekly-plans/:plan_id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","weekly-plans",":plan_id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"plan_id","value":""}]},"description":"Edit a weekly work plan note\n\nRequires schedule:write and live Schedule edit access on the project. Audited. Only the note changes; the week is immutable.","body":{"mode":"raw","raw":"{\n  \"note\": \"\"\n}","options":{"raw":{"language":"json"}}}}},{"id":"39f1015d-17cc-45ae-827d-21002286c4de","name":"deleteProjectScheduleWeeklyPlan — Delete a draft weekly work plan","request":{"method":"DELETE","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/weekly-plans/:plan_id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","weekly-plans",":plan_id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"plan_id","value":""}]},"description":"Delete a draft weekly work plan\n\nRequires schedule:write and live Schedule edit access on the project. Audited. A committed week is the record PPC is measured against and is retained (database trigger)."}},{"id":"39df912f-2aaa-43bc-800b-9b7c23acd0fc","name":"commitProjectScheduleWeeklyPlan — Commit a weekly work plan","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/weekly-plans/:plan_id/commit","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","weekly-plans",":plan_id","commit"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"plan_id","value":""}]},"description":"Commit a weekly work plan\n\nRequires schedule:write and live Schedule edit access on the project. Audited. Freezes the week's commitments (the PPC denominator): afterwards none can be added, removed or rewritten, only assessed. Refused while any commitment's activity has open constraints in the constraints lookahead for that week (not make-ready), unless `allow_constrained` is true, which is recorded on the plan and in the audit trail.","body":{"mode":"raw","raw":"{\n  \"allow_constrained\": false\n}","options":{"raw":{"language":"json"}}}}},{"id":"de7202a0-019f-4062-8c7d-946df80e2362","name":"createProjectScheduleWeeklyPlanCommitment — Add commitments","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/weekly-plans/:plan_id/commitments","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","weekly-plans",":plan_id","commitments"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"plan_id","value":""}]},"description":"Add commitments\n\nRequires schedule:write and live Schedule edit access on the project. Audited. Adds one commitment, or a batch (`commitments`, at most 200), to a draft week. Each names an activity, a description and the trade or crew making it. The activity must be in the project's current saved schedule and visible to you; a week that has ended may also name an activity of the schedule as it stood that week. An omitted trade is prefilled from the activity's trade field or trade activity code.","body":{"mode":"raw","raw":"{\n  \"activity_id\": \"\",\n  \"description\": \"\"\n}","options":{"raw":{"language":"json"}}}}},{"id":"03ccfd81-55e6-4479-8d22-b0ed6a5a25d2","name":"updateProjectScheduleWeeklyPlanCommitment — Edit or assess a commitment","request":{"method":"PATCH","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/weekly-plans/:plan_id/commitments/:commitment_id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","weekly-plans",":plan_id","commitments",":commitment_id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"plan_id","value":""},{"key":"commitment_id","value":""}]},"description":"Edit or assess a commitment\n\nRequires schedule:write and live Schedule edit access on the project. Audited. On a draft week, rewrites the promise (activity, description, trade, quantity, unit, notes). On a committed week, only assesses it: `completed: true` (met, no reason), `completed: false` with a `variance_reason` (missed; use `not_recorded` if nobody gave one), or `completed: null` (not yet assessed); notes may change. Partial completion is not partial credit. A new `activity_id` is checked against the schedule as when adding; a committed week's activities are never re-checked, even after they are removed from the schedule.","body":{"mode":"raw","raw":"{\n  \"activity_id\": \"\",\n  \"completed\": false,\n  \"description\": \"\",\n  \"notes\": \"\",\n  \"planned_quantity\": 0,\n  \"trade\": \"\",\n  \"unit\": \"\",\n  \"variance_reason\": \"prerequisite_work\"\n}","options":{"raw":{"language":"json"}}}}},{"id":"80b44769-a268-4e70-8ebb-7f113e58aab2","name":"deleteProjectScheduleWeeklyPlanCommitment — Remove a commitment","request":{"method":"DELETE","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/weekly-plans/:plan_id/commitments/:commitment_id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","weekly-plans",":plan_id","commitments",":commitment_id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"plan_id","value":""},{"key":"commitment_id","value":""}]},"description":"Remove a commitment\n\nRequires schedule:write and live Schedule edit access on the project. Audited. Only from a draft week."}},{"id":"1c0f71d4-bb3b-4821-8b4f-06215d920f14","name":"createProjectScheduleWorkforceCapacityPreview — Preview workforce capacity against daily schedule demand","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/workforce-capacity/preview","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","workforce-capacity","preview"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Preview workforce capacity against daily schedule demand\n\nRequires schedule:read, workforce:read, live Schedule admin, Workforce view and company admin access. Up to 100 explicit person mappings over 366 inclusive days. User-stated minutes-per-unit conversions combine shared-person demand without duplicating supply. Allocation overlaps require review; no reservations, leveling or field dates change. Missing capacity and usage remain unknown. Two matching owner snapshots bracket the engine calculation. No query parameters.","body":{"mode":"raw","raw":"{\n  \"from_day\": \"2026-01-31\",\n  \"mappings\": [\n    {\n      \"minutes_per_unit\": 0,\n      \"person_id\": 0,\n      \"resource_id\": \"\"\n    }\n  ],\n  \"through_day\": \"2026-01-31\",\n  \"version_id\": 0\n}","options":{"raw":{"language":"json"}}}}},{"id":"47419f8f-0c68-405a-83ce-bc93f9d8689c","name":"listProjectScheduleWorkforceCapacityReports — List saved workforce capacity reviews","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/workforce-capacity/reports","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","workforce-capacity","reports"],"query":[{"key":"before_id","value":"","disabled":true},{"key":"version_id","value":"","disabled":true},{"key":"page_size","value":"","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"List saved workforce capacity reviews\n\nRequires live Schedule admin, Workforce view and company admin permissions, plus workforce:read. Evidence is retained unapproved; no reservations, leveling or dates change. Requires schedule:read. Newest first; metadata only."}},{"id":"51697f41-2a7f-4ca1-83b6-cabc69f85089","name":"createProjectScheduleWorkforceCapacityReport — Save reviewed workforce capacity evidence","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/workforce-capacity/reports","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","workforce-capacity","reports"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Save reviewed workforce capacity evidence\n\nRequires live Schedule admin, Workforce view and company admin permissions, plus workforce:read. Evidence is retained unapproved; no reservations, leveling or dates change. Requires schedule:write. Recalculates and checks expected_review_digest. Identical evidence saved by the same actor returns its existing record. Snapshot retention is not an atomic capacity approval. No query parameters.","body":{"mode":"raw","raw":"{\n  \"expected_review_digest\": \"\",\n  \"from_day\": \"2026-01-31\",\n  \"mappings\": [\n    {\n      \"minutes_per_unit\": 0,\n      \"person_id\": 0,\n      \"resource_id\": \"\"\n    }\n  ],\n  \"through_day\": \"2026-01-31\",\n  \"version_id\": 0\n}","options":{"raw":{"language":"json"}}}}},{"id":"eb078c88-5752-47af-8204-2f4e3306d7bf","name":"getProjectScheduleWorkforceCapacityReport — Read saved workforce capacity evidence","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/schedule/workforce-capacity/reports/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","schedule","workforce-capacity","reports",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Read saved workforce capacity evidence\n\nRequires live Schedule admin, Workforce view and company admin permissions, plus workforce:read. Evidence is retained unapproved; no reservations, leveling or dates change. Requires schedule:read. Returns original evidence without refreshing availability. No query parameters."}},{"id":"6d280764-89f1-4913-84a1-ab36fd67d85a","name":"listProjectScheduleRequestedChangesV11 — List schedule requested changes","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.1/projects/:project_id/schedule/requested_changes","host":["{{baseUrl}}"],"path":["rest","v1.1","projects",":project_id","schedule","requested_changes"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"List schedule requested changes"}},{"id":"c5669679-9611-4226-8492-7d09084cce36","name":"updateProjectScheduleRequestedChangesReviewV11 — Review (approve/reject) schedule requested changes","request":{"method":"PATCH","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.1/projects/:project_id/schedule/requested_changes/review","host":["{{baseUrl}}"],"path":["rest","v1.1","projects",":project_id","schedule","requested_changes","review"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Review (approve/reject) schedule requested changes","body":{"mode":"raw","raw":"{\n  \"requested_changes\": [\n    {}\n  ]\n}","options":{"raw":{"language":"json"}}}}},{"id":"97fbd3d0-62b2-4d40-8570-860876270713","name":"getProjectScheduleResourceAssignmentV11 — Show resource assignment","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.1/projects/:project_id/schedule/resource_assignments/:id","host":["{{baseUrl}}"],"path":["rest","v1.1","projects",":project_id","schedule","resource_assignments",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Show resource assignment"}},{"id":"7ceaa66c-e32a-490c-834f-bceff97043a1","name":"listProjectScheduleResourcesV11 — List Resources","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.1/projects/:project_id/schedule/resources","host":["{{baseUrl}}"],"path":["rest","v1.1","projects",":project_id","schedule","resources"],"query":[{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true},{"key":"filters[query]","value":"","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"List Resources"}},{"id":"6831a446-568d-4632-87db-ec4137ccbf6f","name":"createProjectScheduleResourceV11 — Create resource","request":{"method":"POST","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.1/projects/:project_id/schedule/resources","host":["{{baseUrl}}"],"path":["rest","v1.1","projects",":project_id","schedule","resources"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Create resource","body":{"mode":"raw","raw":"{\n  \"project_id\": 0,\n  \"resource\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"caef8b45-c4de-41a2-814b-9425bddef5ed","name":"getProjectScheduleResourceV11 — Show resource","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.1/projects/:project_id/schedule/resources/:id","host":["{{baseUrl}}"],"path":["rest","v1.1","projects",":project_id","schedule","resources",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Show resource"}},{"id":"d87bb19e-5adc-4876-8ffc-60b57844e2ad","name":"updateProjectScheduleResourceV11 — Update resource","request":{"method":"PATCH","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.1/projects/:project_id/schedule/resources/:id","host":["{{baseUrl}}"],"path":["rest","v1.1","projects",":project_id","schedule","resources",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Update resource","body":{"mode":"raw","raw":"{\n  \"project_id\": 0,\n  \"resource\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"e12618c2-fd07-4855-8c4d-1ffa50bd8187","name":"deleteProjectScheduleResourceV11 — Delete resource","request":{"method":"DELETE","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.1/projects/:project_id/schedule/resources/:id","host":["{{baseUrl}}"],"path":["rest","v1.1","projects",":project_id","schedule","resources",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Delete resource"}},{"id":"79cb3c55-d54e-445a-8bde-27c14e8d8c6f","name":"createProjectScheduleTaskRequestedChangeV11 — Create a schedule requested change","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.1/projects/:project_id/schedule/tasks/:task_id/requested_changes","host":["{{baseUrl}}"],"path":["rest","v1.1","projects",":project_id","schedule","tasks",":task_id","requested_changes"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"task_id","value":""}]},"description":"Create a schedule requested change","body":{"mode":"raw","raw":"{\n  \"requested_change\": {}\n}","options":{"raw":{"language":"json"}}}}}]},{"name":"Specifications","description":"Module: specifications","item":[{"id":"faaf9fe8-8c97-4ad3-8f97-683e090d86cd","name":"sendEmailProjectSpecificationSectionRevisionEmail — Send email","request":{"method":"POST","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/specification_section_revision_emails/:id/send_email","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","specification_section_revision_emails",":id","send_email"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Send email\n\nEmail a specification section revision ({id} is the revision id) to project users. The email is recorded in the project Emails tool and linked to the revision. At least one recipient is required.","body":{"mode":"raw","raw":"{\n  \"bcc_distribution_ids\": [\n    0\n  ],\n  \"body\": \"\",\n  \"cc_distribution_ids\": [\n    0\n  ],\n  \"distribution_ids\": [\n    0\n  ],\n  \"subject\": \"\"\n}","options":{"raw":{"language":"json"}}}}},{"id":"062c2164-de63-40ac-8aaa-b67bc9ed9e37","name":"listProjectSpecificationSets — List Specification Sets","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/specification_sets","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","specification_sets"],"query":[{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"List Specification Sets"}},{"id":"7661f246-4a07-42ca-8f06-0d99bb710555","name":"createProjectSpecificationSet — Create Specification Set","request":{"method":"POST","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/specification_sets","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","specification_sets"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Create Specification Set","body":{"mode":"raw","raw":"{\n  \"date\": \"\",\n  \"name\": \"\"\n}","options":{"raw":{"language":"json"}}}}},{"id":"10e22d0f-b414-472a-869b-dc43febdb21c","name":"getProjectSpecificationSet — Show Specification Set","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/specification_sets/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","specification_sets",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Show Specification Set"}},{"id":"e6e162c9-f242-4b0a-82f7-9704a3da8f7d","name":"issueProjectSpecificationSet — Issue a specification set","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/specification_sets/:id/issue","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","specification_sets",":id","issue"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Issue a specification set\n\nRequires specifications:write and project specifications edit permission. The existing handler checks tenant ownership and tool enablement. Chooses the highest-position revision (highest ID breaks ties) in this set for each live section, makes it current, and supersedes sibling revisions. Returns affected section count. An absent or invalid JSON body is treated as {} by this handler. Catalog presence does not grant authorization.","body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}}}},{"id":"b05bd3c1-e527-40c1-8322-a13c2a021e3b","name":"getProjectSubmittalsFilterOption — Get submittals filter options for one field","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/submittals/filter_options/:field","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","submittals","filter_options",":field"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"field","value":""}]},"description":"Get submittals filter options for one field\n\nRequires the `view` permission on the project's submittals tool. A scoped API token needs `submittals:read`."}},{"id":"bf16140b-9a66-49aa-8ce1-70ca9093a251","name":"listSpecificationSectionDivisions — List Specification Section Divisions for a Project","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/specification_section_divisions","host":["{{baseUrl}}"],"path":["rest","v1.0","specification_section_divisions"],"query":[{"key":"project_id","value":"","disabled":false},{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true}]},"description":"List Specification Section Divisions for a Project"}},{"id":"65d60ab3-c53c-4eca-806a-f0c8b555a223","name":"createSpecificationSectionDivision — Create Specification Section Division for a Project","request":{"method":"POST","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/specification_section_divisions","host":["{{baseUrl}}"],"path":["rest","v1.0","specification_section_divisions"],"query":[{"key":"project_id","value":"","disabled":true}]},"description":"Create Specification Section Division for a Project","body":{"mode":"raw","raw":"{\n  \"specification_section_division\": {\n    \"number\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"2f8d7f4d-2722-4c61-890e-9c795d47f59b","name":"listSpecificationSectionDivisionsRecycleBin — List recycled specification divisions","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/specification_section_divisions/recycle_bin","host":["{{baseUrl}}"],"path":["rest","v1.0","specification_section_divisions","recycle_bin"],"query":[{"key":"project_id","value":"","disabled":false,"description":"Project to authorize and scope the operation."},{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true}]},"description":"List recycled specification divisions\n\nRequires specifications:read and project specifications view permission. The existing handler checks tenant ownership and tool enablement. Lists recycled divisions, most recently deleted first, then descending ID. Catalog presence does not grant authorization."}},{"id":"dbb790ed-04b5-4903-8b70-251d3935a004","name":"deleteSpecificationSectionDivision — Recycle a specification division","request":{"method":"DELETE","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/specification_section_divisions/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","specification_section_divisions",":id"],"query":[{"key":"project_id","value":"","disabled":false,"description":"Project to authorize and scope the operation."}],"variable":[{"key":"id","value":""}]},"description":"Recycle a specification division\n\nRequires specifications:write and project specifications delete permission. The existing handler checks tenant ownership and tool enablement. Soft-deletes the division. Live sections using it prevent deletion with 400. Returns empty HTTP 200. Catalog presence does not grant authorization."}},{"id":"382ecd8c-1224-4e8c-8a3f-7fd676b80d73","name":"restoreSpecificationSectionDivision — Restore a specification division","request":{"method":"PATCH","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/specification_section_divisions/:id/restore","host":["{{baseUrl}}"],"path":["rest","v1.0","specification_section_divisions",":id","restore"],"query":[{"key":"project_id","value":"","disabled":false,"description":"Project to authorize and scope the operation."}],"variable":[{"key":"id","value":""}]},"description":"Restore a specification division\n\nRequires specifications:write and project specifications delete permission. The existing handler checks tenant ownership and tool enablement. Restores only a recycled division in this project. url remains null; no concatenated PDF is produced. Catalog presence does not grant authorization."}},{"id":"de33cf93-cab2-47f2-8bf7-c591a6580845","name":"listSpecificationSectionRevisions — List Specification Section Revisions for a Specification Section Division","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/specification_section_revisions","host":["{{baseUrl}}"],"path":["rest","v1.0","specification_section_revisions"],"query":[{"key":"project_id","value":"","disabled":false},{"key":"specification_section_division_id","value":"","disabled":false},{"key":"all_revisions","value":"","disabled":true},{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true}]},"description":"List Specification Section Revisions for a Specification Section Division"}},{"id":"6b4bead9-0959-4609-83a6-9a74aa136452","name":"getSpecificationSectionRevision — Show Specification Section Revision","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/specification_section_revisions/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","specification_section_revisions",":id"],"query":[{"key":"project_id","value":"","disabled":false}],"variable":[{"key":"id","value":""}]},"description":"Show Specification Section Revision"}},{"id":"9f2cf11e-8965-4438-86b0-01d74fc3111a","name":"updateSpecificationSectionRevision — Update a specification revision","request":{"method":"PATCH","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/specification_section_revisions/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","specification_section_revisions",":id"],"variable":[{"key":"id","value":""}]},"description":"Update a specification revision\n\nRequires specifications:write and project specifications edit permission. The existing handler checks tenant ownership and tool enablement. Derives the project from the revision before authorization. May edit section metadata and promote the revision. Does not replace or upload files. The returned URL is metadata; downloading bytes requires separate upload-owner authorization. Catalog presence does not grant authorization.","body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}}}},{"id":"744abbea-e8ff-49e5-879a-6144f9736577","name":"listSpecificationSections — List Specification Sections","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/specification_sections","host":["{{baseUrl}}"],"path":["rest","v1.0","specification_sections"],"query":[{"key":"project_id","value":"","disabled":false},{"key":"filters[id]","value":"","disabled":true},{"key":"sort","value":"","disabled":true}]},"description":"List Specification Sections"}},{"id":"f606afab-b9cf-4381-83c3-3a34f4293a78","name":"createSpecificationSection — Create Specification Section for a Project","request":{"method":"POST","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/specification_sections","host":["{{baseUrl}}"],"path":["rest","v1.0","specification_sections"],"query":[{"key":"project_id","value":"","disabled":false}]},"description":"Create Specification Section for a Project","body":{"mode":"raw","raw":"{\n  \"specification_section\": {\n    \"number\": \"\",\n    \"specification_section_division_id\": 0\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"8b7b270d-6616-426d-81e0-da54381ea8f3","name":"listSpecificationSectionsRecycleBin — List recycled specification sections","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/specification_sections/recycle_bin","host":["{{baseUrl}}"],"path":["rest","v1.0","specification_sections","recycle_bin"],"query":[{"key":"project_id","value":"","disabled":false,"description":"Project to authorize and scope the operation."},{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true}]},"description":"List recycled specification sections\n\nRequires specifications:read and project specifications view permission. The existing handler checks tenant ownership and tool enablement. Lists recycled sections, most recently deleted first, then descending ID, with division/current-revision context. Catalog presence does not grant authorization."}},{"id":"f342dbe7-3e0a-4a91-81dd-0f2af82eaaeb","name":"getSpecificationSection — Get a specification section","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/specification_sections/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","specification_sections",":id"],"query":[{"key":"project_id","value":"","disabled":true,"description":"Optional lookup restriction. Without it, the handler derives and authorizes the record project."}],"variable":[{"key":"id","value":""}]},"description":"Get a specification section\n\nRequires specifications:read and project specifications view permission. The existing handler checks tenant ownership and tool enablement. Returns division and current revision metadata. The returned revision URL does not grant file access. Catalog presence does not grant authorization."}},{"id":"3d717875-f4fc-4c59-8a21-97f6b78ad05b","name":"updateSpecificationSection — Update a specification section","request":{"method":"PATCH","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/specification_sections/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","specification_sections",":id"],"query":[{"key":"project_id","value":"","disabled":true,"description":"Optional lookup restriction. Without it, the handler derives and authorizes the record project."}],"variable":[{"key":"id","value":""}]},"description":"Update a specification section\n\nRequires specifications:write and project specifications edit permission. The existing handler checks tenant ownership and tool enablement. Changing its division updates all live revisions of this section. Does not upload or replace file bytes. Catalog presence does not grant authorization.","body":{"mode":"raw","raw":"{\n  \"specification_section\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"a533b3f9-3b75-48af-8679-b60bc3a95a0b","name":"deleteSpecificationSection — Recycle a specification section","request":{"method":"DELETE","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/specification_sections/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","specification_sections",":id"],"query":[{"key":"project_id","value":"","disabled":true,"description":"Optional lookup restriction. Without it, the handler derives and authorizes the record project."}],"variable":[{"key":"id","value":""}]},"description":"Recycle a specification section\n\nRequires specifications:write and project specifications delete permission. The existing handler checks tenant ownership and tool enablement. Soft-deletes the section, retaining its revision rows. Returns empty HTTP 200. Catalog presence does not grant authorization."}},{"id":"3d4af519-0777-4731-8717-1445a8314b81","name":"listSpecificationSectionCompare — Compare specification revisions","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/specification_sections/:id/compare","host":["{{baseUrl}}"],"path":["rest","v1.0","specification_sections",":id","compare"],"query":[{"key":"project_id","value":"","disabled":false},{"key":"a","value":"","disabled":false},{"key":"b","value":"","disabled":false}],"variable":[{"key":"id","value":""}]},"description":"Compare specification revisions\n\nRequires specifications:read and project specifications view permission, tenant ownership and tool enablement. Requires exactly one project_id, a and b query value; both revision IDs must belong to the live section. Returns metadata differences and source identities, not a complete PDF content diff. Owned PDFs require current actor and every upload-owner read scope before storage access. Extracted text may be partial; legacy revisions without owned PDFs return explicitly synthetic placeholder content. Catalog presence does not grant authorization."}},{"id":"344939ab-5220-48eb-8e88-f921c76bff0b","name":"listSpecificationSectionRelated — List visible specification-related records","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/specification_sections/:id/related","host":["{{baseUrl}}"],"path":["rest","v1.0","specification_sections",":id","related"],"variable":[{"key":"id","value":""}]},"description":"List visible specification-related records\n\nRequires specifications:read and project specifications view permission, tenant ownership and tool enablement. Derives and authorizes the section project. Returns only live, actor-visible linked RFIs and submittals. Grant-scoped callers additionally need rfis:read or submittals:read for each family; missing scope or source tool access yields an empty array for that family. Catalog presence does not grant authorization."}},{"id":"a0ecbc36-7b3d-43ea-8480-cc477b78b10c","name":"restoreSpecificationSection — Restore a specification section","request":{"method":"PATCH","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/specification_sections/:id/restore","host":["{{baseUrl}}"],"path":["rest","v1.0","specification_sections",":id","restore"],"query":[{"key":"project_id","value":"","disabled":false,"description":"Project to authorize and scope the operation."}],"variable":[{"key":"id","value":""}]},"description":"Restore a specification section\n\nRequires specifications:write and project specifications delete permission. The existing handler checks tenant ownership and tool enablement. Restores only a currently recycled section in the specified project and returns its division/current revision metadata. Catalog presence does not grant authorization."}},{"id":"fc61bf1a-f836-4055-8a7c-c10086028eb8","name":"listCompanyProjectSpecificationSectionDivisionsV20 — List Specification Sections Divisions","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v2.0/companies/:company_id/projects/:project_id/specification_section_divisions","host":["{{baseUrl}}"],"path":["rest","v2.0","companies",":company_id","projects",":project_id","specification_section_divisions"],"query":[{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true}],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"project_id","value":"{{projectId}}"}]},"description":"List Specification Sections Divisions\n\nLive divisions."}},{"id":"e5a7540a-22cf-4f60-81c2-6a640827ade7","name":"listCompanyProjectSpecificationSectionRevisionsV20 — List Specification Sections Revisions for a Project","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v2.0/companies/:company_id/projects/:project_id/specification_section_revisions","host":["{{baseUrl}}"],"path":["rest","v2.0","companies",":company_id","projects",":project_id","specification_section_revisions"],"query":[{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true}],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"project_id","value":"{{projectId}}"}]},"description":"List Specification Sections Revisions for a Project\n\nEvery live revision of live sections, ordered by section number."}},{"id":"2f0b29ce-c0c3-4b53-8074-95beb8bb7e17","name":"listCompanyProjectSpecificationSectionsV20 — List Specification Sections for a Project","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v2.0/companies/:company_id/projects/:project_id/specification_sections","host":["{{baseUrl}}"],"path":["rest","v2.0","companies",":company_id","projects",":project_id","specification_sections"],"query":[{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true},{"key":"filter_set_id","value":"","disabled":true},{"key":"filter_division_id","value":"","disabled":true},{"key":"filters[division_ids]","value":"","disabled":true},{"key":"search_string","value":"","disabled":true}],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"project_id","value":"{{projectId}}"}]},"description":"List Specification Sections for a Project\n\nLive sections with their current division. Filters: filter_set_id, filter_division_id, filters[division_ids], search_string."}},{"id":"d39c2084-d4aa-476b-88bc-3f53dacbfdbb","name":"listCompanyProjectSpecificationSetsV20 — List Specification Sets for a Project","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v2.0/companies/:company_id/projects/:project_id/specification_sets","host":["{{baseUrl}}"],"path":["rest","v2.0","companies",":company_id","projects",":project_id","specification_sets"],"query":[{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true},{"key":"is_recycle_bin","value":"","disabled":true}],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"project_id","value":"{{projectId}}"}]},"description":"List Specification Sets for a Project\n\nSpecification sets. is_recycle_bin=true lists deleted sets. `deletable` is false while a set holds revisions."}},{"id":"66e560c1-5d6e-4be5-8dff-2ccad28e73c7","name":"updateCompanyProjectSpecificationSetsV20 — Bulk update for Specification Sets for a Project","request":{"method":"PATCH","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v2.0/companies/:company_id/projects/:project_id/specification_sets","host":["{{baseUrl}}"],"path":["rest","v2.0","companies",":company_id","projects",":project_id","specification_sets"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"project_id","value":"{{projectId}}"}]},"description":"Bulk update for Specification Sets for a Project\n\nCreate, update and delete sets in one request. Updates and deletes run in one transaction; deleting a set that still holds revisions returns 409. Returns the project's sets. Requires Specifications admin.","body":{"mode":"raw","raw":"{\n  \"creation_params\": [\n    {\n      \"name\": \"\"\n    }\n  ],\n  \"deletion_params\": [\n    {\n      \"id\": 0\n    }\n  ],\n  \"updation_params\": [\n    {\n      \"id\": 0\n    }\n  ]\n}","options":{"raw":{"language":"json"}}}}},{"id":"f9dc1637-a8a5-4ac5-8287-337c2e397ef0","name":"listCompanyProjectSpecificationConfigurationDistributionGroupsV21 — List distribution groups for Specifications","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v2.1/companies/:company_id/projects/:project_id/specification_configuration/distribution_groups","host":["{{baseUrl}}"],"path":["rest","v2.1","companies",":company_id","projects",":project_id","specification_configuration","distribution_groups"],"query":[{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true}],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"project_id","value":"{{projectId}}"}]},"description":"List distribution groups for Specifications\n\nThe project's distribution groups (Directory) with member user ids."}},{"id":"53e0bf7e-a838-45ab-82eb-0aa4abafca8b","name":"listCompanyProjectSpecificationConfigurationPotentialDistributionMembersV21 — List potential distribution members for Specifications","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v2.1/companies/:company_id/projects/:project_id/specification_configuration/potential_distribution_members","host":["{{baseUrl}}"],"path":["rest","v2.1","companies",":company_id","projects",":project_id","specification_configuration","potential_distribution_members"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"project_id","value":"{{projectId}}"}]},"description":"List potential distribution members for Specifications\n\nActive project members a specification revision can be emailed to."}},{"id":"7f98dadc-8344-47bf-8ead-27fbe5f9ee2a","name":"listCompanyProjectSpecificationSectionDivisionsV21 — List Specification Section Divisions","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v2.1/companies/:company_id/projects/:project_id/specification_section_divisions","host":["{{baseUrl}}"],"path":["rest","v2.1","companies",":company_id","projects",":project_id","specification_section_divisions"],"query":[{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true},{"key":"id","value":"","disabled":true},{"key":"search_string","value":"","disabled":true},{"key":"specification_set_ids","value":"","disabled":true}],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"project_id","value":"{{projectId}}"}]},"description":"List Specification Section Divisions\n\nLive divisions with the live sections and revisions classified under them (`deletable` when none)."}},{"id":"56999de2-9187-4ab7-8d18-a024c89edb2a","name":"createCompanyProjectSpecificationSectionDivisionV21 — Create a Specification Section Division","request":{"method":"POST","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v2.1/companies/:company_id/projects/:project_id/specification_section_divisions","host":["{{baseUrl}}"],"path":["rest","v2.1","companies",":company_id","projects",":project_id","specification_section_divisions"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"project_id","value":"{{projectId}}"}]},"description":"Create a Specification Section Division\n\nCreate a division. description defaults to the number.","body":{"mode":"raw","raw":"{\n  \"specification_section_division\": {\n    \"number\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"9a3ff916-d4bb-4ead-8f22-43700b4707e0","name":"updateCompanyProjectSpecificationSectionDivisionsV21 — Update Specification Section Divisions","request":{"method":"PATCH","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v2.1/companies/:company_id/projects/:project_id/specification_section_divisions","host":["{{baseUrl}}"],"path":["rest","v2.1","companies",":company_id","projects",":project_id","specification_section_divisions"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"project_id","value":"{{projectId}}"}]},"description":"Update Specification Section Divisions\n\nCreate, update and delete divisions in one transaction. Deleting a division that still classifies live sections returns 409. Returns the project's divisions. Requires Specifications admin.","body":{"mode":"raw","raw":"{\n  \"creation_params\": [\n    {\n      \"number\": \"\"\n    }\n  ],\n  \"deletion_params\": [\n    {\n      \"id\": 0\n    }\n  ],\n  \"updation_params\": [\n    {\n      \"id\": 0\n    }\n  ]\n}","options":{"raw":{"language":"json"}}}}},{"id":"35ed4a15-13cf-4e90-8278-5a33934a2695","name":"listCompanyProjectSpecificationSectionRevisionsV21 — List Specification Sections Revisions for a Project","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v2.1/companies/:company_id/projects/:project_id/specification_section_revisions","host":["{{baseUrl}}"],"path":["rest","v2.1","companies",":company_id","projects",":project_id","specification_section_revisions"],"query":[{"key":"filter_division_id","value":"","disabled":true},{"key":"search_string","value":"","disabled":true}],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"project_id","value":"{{projectId}}"}]},"description":"List Specification Sections Revisions for a Project\n\nEvery live revision grouped division → section → set."}},{"id":"f099937c-bfb7-4d01-87ca-8b9392b2d27d","name":"createCompanyProjectSpecificationSectionRevisionsBulkUpdateV21 — Bulk Update Specification Section Revisions","request":{"method":"POST","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v2.1/companies/:company_id/projects/:project_id/specification_section_revisions/bulk_update","host":["{{baseUrl}}"],"path":["rest","v2.1","companies",":company_id","projects",":project_id","specification_section_revisions","bulk_update"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"project_id","value":"{{projectId}}"}]},"description":"Bulk Update Specification Section Revisions\n\nUpdate up to 100 revisions. Items run in order; a failing item does not undo the others. Each result has status updated or failed.","body":{"mode":"raw","raw":"[\n  {\n    \"id\": 0\n  }\n]","options":{"raw":{"language":"json"}}}}},{"id":"160a84d2-034b-4b67-873a-0a12c4604059","name":"createCompanyProjectSpecificationSectionRevisionsCreateZipDownloadV21 — Download zip of Specification Section Revisions","request":{"method":"POST","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v2.1/companies/:company_id/projects/:project_id/specification_section_revisions/create_zip_download","host":["{{baseUrl}}"],"path":["rest","v2.1","companies",":company_id","projects",":project_id","specification_section_revisions","create_zip_download"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"project_id","value":"{{projectId}}"}]},"description":"Download zip of Specification Section Revisions\n\nA ZIP of the listed revisions' original PDFs (at most 100 revisions and 200 MB). has_public_markup is accepted and ignored: markups are not burned into downloads.","body":{"mode":"raw","raw":"{\n  \"has_public_markup\": false,\n  \"specification_section_revision_ids\": [\n    \"\"\n  ]\n}","options":{"raw":{"language":"json"}}}}},{"id":"065eea99-af71-4cdd-8603-d452a62c8df9","name":"createCompanyProjectSpecificationSectionRevisionsSinglePdfDownloadV21 — Download single pdf of Specification Section Revisions","request":{"method":"POST","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v2.1/companies/:company_id/projects/:project_id/specification_section_revisions/single_pdf_download","host":["{{baseUrl}}"],"path":["rest","v2.1","companies",":company_id","projects",":project_id","specification_section_revisions","single_pdf_download"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"project_id","value":"{{projectId}}"}]},"description":"Download single pdf of Specification Section Revisions\n\nThe listed revisions' original PDFs combined into one PDF in the order given (at most 100 revisions and 200 MB). 422 when a revision has no uploaded PDF or its PDF cannot be combined.","body":{"mode":"raw","raw":"{\n  \"specification_section_revision_ids\": [\n    \"\"\n  ]\n}","options":{"raw":{"language":"json"}}}}},{"id":"f9753af6-b5fa-4771-8891-c10a6410e379","name":"getCompanyProjectSpecificationSectionRevisionV21 — Show Specification Section Revision","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v2.1/companies/:company_id/projects/:project_id/specification_section_revisions/:id","host":["{{baseUrl}}"],"path":["rest","v2.1","companies",":company_id","projects",":project_id","specification_section_revisions",":id"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Show Specification Section Revision\n\nThe revision and every live revision of its section."}},{"id":"8ce4772d-ecb5-49dc-827e-9d57cc71708b","name":"replaceCompanyProjectSpecificationSectionRevisionV21 — Update Specification Section Revision","request":{"method":"PUT","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v2.1/companies/:company_id/projects/:project_id/specification_section_revisions/:id","host":["{{baseUrl}}"],"path":["rest","v2.1","companies",":company_id","projects",":project_id","specification_section_revisions",":id"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Update Specification Section Revision\n\nUpdate the revision and its section. Same body as PATCH /rest/v1.0/specification_section_revisions/{id}. Changes are recorded in change_history.","body":{"mode":"raw","raw":"{\n  \"specification_section\": {},\n  \"specification_section_revision\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"4c32590c-a283-4af2-8704-660458d37913","name":"deleteCompanyProjectSpecificationSectionRevisionV21 — Destroy Specification Section Revision","request":{"method":"DELETE","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v2.1/companies/:company_id/projects/:project_id/specification_section_revisions/:id","host":["{{baseUrl}}"],"path":["rest","v2.1","companies",":company_id","projects",":project_id","specification_section_revisions",":id"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Destroy Specification Section Revision\n\nDelete the revision. When it was current, the latest remaining revision becomes current. Deleting a section's only revision returns 409 (recycle the section instead)."}},{"id":"5d9baeac-8b1a-4f42-8459-f0cceb44aebd","name":"listCompanyProjectSpecificationSectionRevisionChangeHistoryV21 — Change History of Specification Section Revision","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v2.1/companies/:company_id/projects/:project_id/specification_section_revisions/:id/change_history","host":["{{baseUrl}}"],"path":["rest","v2.1","companies",":company_id","projects",":project_id","specification_section_revisions",":id","change_history"],"query":[{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true}],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Change History of Specification Section Revision\n\nAudit history of the revision, newest first."}},{"id":"8f761bf8-4ce0-4bd9-84c8-474bfd94fe31","name":"listCompanyProjectSpecificationSectionRevisionDownloadV21 — Download Specification Section Revision","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v2.1/companies/:company_id/projects/:project_id/specification_section_revisions/:id/download","host":["{{baseUrl}}"],"path":["rest","v2.1","companies",":company_id","projects",":project_id","specification_section_revisions",":id","download"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Download Specification Section Revision\n\nWhere to download the revision's original PDF: an authenticated /rest/v1.0/uploads URL. 422 when the revision has no uploaded PDF."}},{"id":"d214f315-0031-4025-8a87-3cc5150f03c0","name":"listCompanyProjectSpecificationSectionsV21 — List Specification Sections for a Project","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v2.1/companies/:company_id/projects/:project_id/specification_sections","host":["{{baseUrl}}"],"path":["rest","v2.1","companies",":company_id","projects",":project_id","specification_sections"],"query":[{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true},{"key":"filter_set_id","value":"","disabled":true},{"key":"filter_division_id","value":"","disabled":true},{"key":"filters[division_ids]","value":"","disabled":true},{"key":"search_string","value":"","disabled":true}],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"project_id","value":"{{projectId}}"}]},"description":"List Specification Sections for a Project\n\nThe current revision of each live section, with division and set."}},{"id":"0ff43063-ebea-4af1-838a-930243376ace","name":"createCompanyProjectSpecificationSectionV21 — Create a Specification Section","request":{"method":"POST","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v2.1/companies/:company_id/projects/:project_id/specification_sections","host":["{{baseUrl}}"],"path":["rest","v2.1","companies",":company_id","projects",":project_id","specification_sections"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"project_id","value":"{{projectId}}"}]},"description":"Create a Specification Section\n\nCreate a section with its first (current) revision. Same `specification_section` body as POST /rest/v1.0/specification_sections. Returns the new revision.","body":{"mode":"raw","raw":"{\n  \"specification_section\": {\n    \"number\": \"\",\n    \"specification_section_division_id\": 0\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"74791d3c-0891-406d-856b-299d8b125821","name":"createCompanyProjectSpecificationSectionsBulkEditCollectionV21 — Bulk edit specification sections","request":{"method":"POST","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v2.1/companies/:company_id/projects/:project_id/specification_sections/bulk_edit_collection","host":["{{baseUrl}}"],"path":["rest","v2.1","companies",":company_id","projects",":project_id","specification_sections","bulk_edit_collection"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"project_id","value":"{{projectId}}"}]},"description":"Bulk edit specification sections\n\nApply one division and/or dates and set to the listed revisions (the division applies to every revision of each affected section). All or nothing.","body":{"mode":"raw","raw":"{\n  \"specification_section_revision_ids\": [\n    \"\"\n  ],\n  \"specification_section_revisions\": {},\n  \"specification_sections\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"bfe458b7-eb0a-4498-8df1-8c2f699f342b","name":"createCompanyProjectSpecificationSectionsCreateSubmittalsFromSpecV21 — Create submittals from specs","request":{"method":"POST","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v2.1/companies/:company_id/projects/:project_id/specification_sections/create_submittals_from_specs","host":["{{baseUrl}}"],"path":["rest","v2.1","companies",":company_id","projects",":project_id","specification_sections","create_submittals_from_specs"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"project_id","value":"{{projectId}}"}]},"description":"Create submittals from specs\n\nCreate one DRAFT submittal per selected section, linked to it and numbered by the project's submittal sequence. Nothing is sent for review. Needs Submittals create permission. user_instructions becomes each draft's description.","body":{"mode":"raw","raw":"{\n  \"specification_section_revision_ids\": [\n    \"\"\n  ],\n  \"user_instructions\": \"\"\n}","options":{"raw":{"language":"json"}}}}},{"id":"aa47de3d-f466-4c0e-8534-c343cd5df06b","name":"listCompanyProjectSpecificationSectionsDeletionLogV21 — Get list of deleted specification sections for a Project","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v2.1/companies/:company_id/projects/:project_id/specification_sections/deletion_log","host":["{{baseUrl}}"],"path":["rest","v2.1","companies",":company_id","projects",":project_id","specification_sections","deletion_log"],"query":[{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true}],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"project_id","value":"{{projectId}}"}]},"description":"Get list of deleted specification sections for a Project\n\nRecycled sections, most recently deleted first. Restore with PATCH /rest/v1.0/specification_sections/{id}/restore."}},{"id":"09fab703-062f-430b-803d-e537f5e18b3c","name":"deleteCompanyProjectSpecificationSectionsDestroyCollectionV21 — Bulk delete specification sections","request":{"method":"DELETE","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v2.1/companies/:company_id/projects/:project_id/specification_sections/destroy_collection","host":["{{baseUrl}}"],"path":["rest","v2.1","companies",":company_id","projects",":project_id","specification_sections","destroy_collection"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"project_id","value":"{{projectId}}"}]},"description":"Bulk delete specification sections\n\nRecycle the sections of the listed revisions. All or nothing (404 if any id is unknown).","body":{"mode":"raw","raw":"{\n  \"specification_section_revision_ids\": [\n    \"\"\n  ]\n}","options":{"raw":{"language":"json"}}}}},{"id":"f71e8bcd-3919-48fb-8c19-3fef17647067","name":"listCompanyProjectSpecificationSectionsDivisionsAndSetsV21 — Get divisions and sets options for specification sections for a Project","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v2.1/companies/:company_id/projects/:project_id/specification_sections/divisions_and_sets","host":["{{baseUrl}}"],"path":["rest","v2.1","companies",":company_id","projects",":project_id","specification_sections","divisions_and_sets"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"project_id","value":"{{projectId}}"}]},"description":"Get divisions and sets options for specification sections for a Project\n\nDivision and set options for section forms."}}]},{"name":"Submittals","description":"Module: submittals","item":[{"id":"96aba30e-7887-4f8c-8f39-5b03e0afc07e","name":"listCompanySubmittalStatuses — List Submittal Statuses","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/submittal_statuses","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","submittal_statuses"],"query":[{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true}],"variable":[{"key":"company_id","value":"{{companyId}}"}]},"description":"List Submittal Statuses"}},{"id":"26fcd640-754e-453b-8f77-2b1e2ea80afb","name":"closeAndDistributeProjectSubmittalLog — Close a submittal log and distribute it","request":{"method":"PATCH","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/submittal_logs/:id/close_and_distribute","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","submittal_logs",":id","close_and_distribute"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Close a submittal log and distribute it"}},{"id":"be349659-e80c-4140-8d3c-f8c2ce5b5431","name":"listProjectSubmittalPackages — GET /rest/v1.0/projects/{project_id}/submittal_packages","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/submittal_packages","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","submittal_packages"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"GET /rest/v1.0/projects/{project_id}/submittal_packages"}},{"id":"757c7577-e327-4501-84d9-5ecc0df05932","name":"createProjectSubmittalPackage — POST /rest/v1.0/projects/{project_id}/submittal_packages","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/submittal_packages","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","submittal_packages"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"POST /rest/v1.0/projects/{project_id}/submittal_packages"}},{"id":"7244eab4-e935-4b34-873d-36c0c40fad78","name":"getProjectSubmittalPackage — GET /rest/v1.0/projects/{project_id}/submittal_packages/{id}","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/submittal_packages/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","submittal_packages",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"GET /rest/v1.0/projects/{project_id}/submittal_packages/{id}"}},{"id":"6dfa3a17-9baa-440e-8294-c3a7dff8c0c2","name":"updateProjectSubmittalPackage — PATCH /rest/v1.0/projects/{project_id}/submittal_packages/{id}","request":{"method":"PATCH","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/submittal_packages/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","submittal_packages",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"PATCH /rest/v1.0/projects/{project_id}/submittal_packages/{id}"}},{"id":"044595d7-e48d-49f9-8570-840d9ff2ec60","name":"deleteProjectSubmittalPackage — Delete submittal package","request":{"method":"DELETE","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/submittal_packages/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","submittal_packages",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Delete submittal package"}},{"id":"fa4a33fa-2dc0-47be-8d6a-99304c1c6c8c","name":"createProjectSubmittalPackageSubmittal — POST /rest/v1.0/projects/{project_id}/submittal_packages/{id}/submittals","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/submittal_packages/:id/submittals","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","submittal_packages",":id","submittals"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"POST /rest/v1.0/projects/{project_id}/submittal_packages/{id}/submittals"}},{"id":"818fca05-2343-482e-8036-b14b0d06ddf9","name":"deleteProjectSubmittalPackageSubmittals — DELETE /rest/v1.0/projects/{project_id}/submittal_packages/{id}/submittals","request":{"method":"DELETE","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/submittal_packages/:id/submittals","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","submittal_packages",":id","submittals"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"DELETE /rest/v1.0/projects/{project_id}/submittal_packages/{id}/submittals"}},{"id":"2448ca25-204a-4381-82a7-fd8dffb219e4","name":"listProjectSubmittalWorkflowTemplates — List submittal workflow templates","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/submittal_workflow_templates","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","submittal_workflow_templates"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"List submittal workflow templates"}},{"id":"1292a3e5-52ba-4b3a-8a8b-58dae0020bbf","name":"createProjectSubmittalWorkflowTemplate — Create a submittal workflow template","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/submittal_workflow_templates","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","submittal_workflow_templates"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Create a submittal workflow template"}},{"id":"2ca11231-e2a9-4e57-8b91-aa6f0c2ad91b","name":"listProjectSubmittalsFilterOptionsBallInCourtId — List Filter Options for Ball in Court","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/submittals/filter_options/ball_in_court_id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","submittals","filter_options","ball_in_court_id"],"query":[{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"List Filter Options for Ball in Court"}},{"id":"98062e6a-805a-4b38-8d92-c9996a2627ff","name":"listProjectSubmittalsFilterOptionsResponsibleContractorId — List Filter Options for Responsible Contractor","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/submittals/filter_options/responsible_contractor_id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","submittals","filter_options","responsible_contractor_id"],"query":[{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"List Filter Options for Responsible Contractor"}},{"id":"62f43ba2-16ab-49ec-8aa3-7909034839e3","name":"listProjectSubmittalsFilterOptionsSpecificationSectionId — List Filter Options for Specification Section","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/submittals/filter_options/specification_section_id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","submittals","filter_options","specification_section_id"],"query":[{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"List Filter Options for Specification Section"}},{"id":"41880b55-90af-43c2-86b3-1fa1f7d36f63","name":"listProjectSubmittalsFilterOptionsStatusId — List Filter Options for Submittal Status","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/submittals/filter_options/status_id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","submittals","filter_options","status_id"],"query":[{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"List Filter Options for Submittal Status"}},{"id":"a5db8c44-0f66-47d6-81f8-d853d10ac4bf","name":"updateSubmittalApprover — Update Submittal Approver","request":{"method":"PATCH","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/submittal_approvers/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","submittal_approvers",":id"],"query":[{"key":"project_id","value":"","disabled":false},{"key":"send_emails","value":"","disabled":true},{"key":"submittal_id","value":"","disabled":false}],"variable":[{"key":"id","value":""}]},"description":"Update Submittal Approver","body":{"mode":"raw","raw":"{\n  \"submittal_approver\": {\n    \"submittal_response_id\": 0\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"fda18715-b2e0-4ab8-83e7-3a0283634676","name":"listProjectSubmittalsV11 — List Submittals on a project","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.1/projects/:project_id/submittals","host":["{{baseUrl}}"],"path":["rest","v1.1","projects",":project_id","submittals"],"query":[{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true},{"key":"filters[procurement_queue]","value":"","disabled":true,"description":"Current revisions with delivery planning: at_risk includes passed release/required/delivery dates and delivery forecasts after the required date; release_due includes unconfirmed release targets from today through 14 calendar days; missing_plan includes partial or invalid plans. Uses UTC date boundaries and intersects all visibility and other filters before pagination. Approval is not proof of ordering or receipt."},{"key":"filters[review_queue]","value":"","disabled":true,"description":"Actionable current revisions: overdue open/draft reviews (before today in UTC), rejected or revise-and-resubmit items, or open/draft items in the authenticated user's ball in court. Intersects all other filters and visibility rules."},{"key":"filters[id]","value":"","disabled":true},{"key":"filters[ball_in_court_id]","value":"","disabled":true},{"key":"filters[created_at]","value":"","disabled":true},{"key":"filters[query]","value":"","disabled":true},{"key":"filters[received_from_id]","value":"","disabled":true},{"key":"filters[responsible_contractor_id]","value":"","disabled":true},{"key":"filters[required_on_site_date]","value":"","disabled":true},{"key":"filters[specification_section_id]","value":"","disabled":true},{"key":"filters[approver_id]","value":"","disabled":true},{"key":"filters[current_revision]","value":"","disabled":true},{"key":"filters[division]","value":"","disabled":true},{"key":"filters[location_id]","value":"","disabled":true},{"key":"filters[submittal_manager_id]","value":"","disabled":true},{"key":"filters[submittal_package_id]","value":"","disabled":true},{"key":"filters[response_id]","value":"","disabled":true},{"key":"filters[status_id]","value":"","disabled":true},{"key":"filters[type]","value":"","disabled":true},{"key":"filters[updated_at]","value":"","disabled":true},{"key":"filters[unpackaged]","value":"","disabled":true},{"key":"filters[number]","value":"","disabled":true},{"key":"filters[task_id]","value":"","disabled":true},{"key":"filters[anticipated_delivery_date]","value":"","disabled":true},{"key":"sort","value":"","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"List Submittals on a project"}},{"id":"ac4d617b-fa5f-4cd5-830f-c9ab46d642ee","name":"createProjectSubmittalV11 — Create Submittal","request":{"method":"POST","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.1/projects/:project_id/submittals","host":["{{baseUrl}}"],"path":["rest","v1.1","projects",":project_id","submittals"],"query":[{"key":"send_emails","value":"","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Create Submittal","body":{"mode":"raw","raw":"{\n  \"submittal\": {\n    \"number\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"d24068aa-6322-4a5b-8a86-b8dfc4d89b6b","name":"listProjectSubmittalsRecycleBinV11 — List of deleted Submittals","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.1/projects/:project_id/submittals/recycle_bin","host":["{{baseUrl}}"],"path":["rest","v1.1","projects",":project_id","submittals","recycle_bin"],"query":[{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true},{"key":"filters[id]","value":"","disabled":true},{"key":"filters[ball_in_court_id]","value":"","disabled":true},{"key":"filters[created_at]","value":"","disabled":true},{"key":"filters[query]","value":"","disabled":true},{"key":"filters[received_from_id]","value":"","disabled":true},{"key":"filters[responsible_contractor_id]","value":"","disabled":true},{"key":"filters[specification_section_id]","value":"","disabled":true},{"key":"filters[approver_id]","value":"","disabled":true},{"key":"filters[current_revision]","value":"","disabled":true},{"key":"filters[division]","value":"","disabled":true},{"key":"filters[location_id]","value":"","disabled":true},{"key":"filters[submittal_manager_id]","value":"","disabled":true},{"key":"filters[submittal_package_id]","value":"","disabled":true},{"key":"filters[response_id]","value":"","disabled":true},{"key":"filters[status_id]","value":"","disabled":true},{"key":"filters[type]","value":"","disabled":true},{"key":"filters[updated_at]","value":"","disabled":true},{"key":"sort","value":"","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"List of deleted Submittals"}},{"id":"265bfa79-7fb5-40f2-8050-6022b8d46e44","name":"getProjectSubmittalV11 — Show Submittal","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.1/projects/:project_id/submittals/:id","host":["{{baseUrl}}"],"path":["rest","v1.1","projects",":project_id","submittals",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Show Submittal"}},{"id":"99636a80-f6dd-4235-8a6d-5ec8b35500f8","name":"updateProjectSubmittalV11 — Update Submittal","request":{"method":"PATCH","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.1/projects/:project_id/submittals/:id","host":["{{baseUrl}}"],"path":["rest","v1.1","projects",":project_id","submittals",":id"],"query":[{"key":"send_emails","value":"","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Update Submittal","body":{"mode":"raw","raw":"{\n  \"submittal\": {\n    \"number\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"80f53338-c8d5-4bfa-87d9-341c3771573e","name":"deleteProjectSubmittalV11 — Delete Submittal","request":{"method":"DELETE","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.1/projects/:project_id/submittals/:id","host":["{{baseUrl}}"],"path":["rest","v1.1","projects",":project_id","submittals",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Delete Submittal"}},{"id":"be37cce0-542b-4a24-891e-f55c4958dc8a","name":"listProjectSubmittalRevisionsV11 — List a submittal's revisions","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.1/projects/:project_id/submittals/:id/revisions","host":["{{baseUrl}}"],"path":["rest","v1.1","projects",":project_id","submittals",":id","revisions"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"List a submittal's revisions"}},{"id":"6d4c3c7c-cb70-4fba-868e-66a5cc3b84a4","name":"createProjectSubmittalRevisionV11 — Create a new revision of a submittal","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.1/projects/:project_id/submittals/:id/revisions","host":["{{baseUrl}}"],"path":["rest","v1.1","projects",":project_id","submittals",":id","revisions"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Create a new revision of a submittal"}}]},{"name":"Tasks","description":"Module: tasks","item":[{"id":"6fe14a3f-1a15-4ad1-87cb-67c78b6ddafc","name":"listCompanyProjectTaskItemCategories — List task item categories","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/projects/:project_id/task_item_categories","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","projects",":project_id","task_item_categories"],"query":[{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true},{"key":"view","value":"","disabled":true}],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"project_id","value":"{{projectId}}"}]},"description":"List task item categories"}},{"id":"46037284-3563-43f9-8ae7-4f0afaeca94f","name":"listCompanyProjectTaskItemComments — List Task Item Comments","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/projects/:project_id/task_item_comments","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","projects",":project_id","task_item_comments"],"query":[{"key":"filters[task_item_id]","value":"","disabled":true},{"key":"filters[created_by_id]","value":"","disabled":true},{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true},{"key":"view","value":"","disabled":true}],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"project_id","value":"{{projectId}}"}]},"description":"List Task Item Comments"}},{"id":"cabd54a0-727e-4beb-82da-5e52f5f4fbad","name":"createCompanyProjectTaskItemComment — Create a task item comment","request":{"method":"POST","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/projects/:project_id/task_item_comments","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","projects",":project_id","task_item_comments"],"query":[{"key":"view","value":"","disabled":true}],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"project_id","value":"{{projectId}}"}]},"description":"Create a task item comment","body":{"mode":"raw","raw":"{\n  \"task_item_comment\": {\n    \"task_item_id\": 0\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"6ded6fd0-b161-40bb-8981-d8974149ae75","name":"updateCompanyProjectTaskItemComment — Update a task item comment","request":{"method":"PATCH","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/projects/:project_id/task_item_comments/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","projects",":project_id","task_item_comments",":id"],"query":[{"key":"view","value":"","disabled":true}],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Update a task item comment","body":{"mode":"raw","raw":"{\n  \"task_item_comment\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"3a28e37b-e30f-4035-8a43-fe3a22c93633","name":"deleteCompanyProjectTaskItemComment — Delete a task item comment","request":{"method":"DELETE","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/projects/:project_id/task_item_comments/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","projects",":project_id","task_item_comments",":id"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Delete a task item comment"}},{"id":"928f12db-7c24-4f39-88c9-c40ee27fb6a4","name":"listTaskItems — List task items","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/task_items","host":["{{baseUrl}}"],"path":["rest","v1.0","task_items"],"query":[{"key":"project_id","value":"","disabled":false},{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true},{"key":"filters[query]","value":"","disabled":true},{"key":"filters[assigned_id]","value":"","disabled":true},{"key":"filters[created_at]","value":"","disabled":true},{"key":"filters[created_by_id]","value":"","disabled":true},{"key":"filters[due_date]","value":"","disabled":true},{"key":"filters[status]","value":"","disabled":true},{"key":"filters[task_item_category_id]","value":"","disabled":true},{"key":"filters[id]","value":"","disabled":true},{"key":"sort","value":"","disabled":true},{"key":"view","value":"","disabled":true}]},"description":"List task items"}},{"id":"0b1621e0-8815-4c02-8868-11a39da1dfdb","name":"createTaskItem — Create task item","request":{"method":"POST","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/task_items","host":["{{baseUrl}}"],"path":["rest","v1.0","task_items"],"query":[{"key":"project_id","value":"","disabled":false},{"key":"view","value":"","disabled":true}]},"description":"Create task item","body":{"mode":"raw","raw":"{\n  \"task_item\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"f3333884-949a-4897-89b8-b404b1af63bc","name":"listTaskItemsAssignees — List Task Items Assignee options","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/task_items/assignees","host":["{{baseUrl}}"],"path":["rest","v1.0","task_items","assignees"],"query":[{"key":"project_id","value":"","disabled":false},{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true},{"key":"filters[search]","value":"","disabled":true}]},"description":"List Task Items Assignee options"}},{"id":"d982832a-2e00-4610-8741-084bcfde94cf","name":"listTaskItemsAssigneesCurrent — List Assignees for Accessible Tasks","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/task_items/assignees/current","host":["{{baseUrl}}"],"path":["rest","v1.0","task_items","assignees","current"],"query":[{"key":"project_id","value":"","disabled":false},{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true}]},"description":"List Assignees for Accessible Tasks"}},{"id":"9542b935-f94b-49e9-8c5b-04b9d5dc1277","name":"createTaskItemsFromCoordinationIssue — Create task item from coordination issue","request":{"method":"POST","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/task_items/from_coordination_issue","host":["{{baseUrl}}"],"path":["rest","v1.0","task_items","from_coordination_issue"]},"description":"Create task item from coordination issue"}},{"id":"8211acdf-614f-4383-8cf1-54285ef70144","name":"createTaskItemsFromMeetingTopic — Create task item from meeting topic","request":{"method":"POST","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/task_items/from_meeting_topic","host":["{{baseUrl}}"],"path":["rest","v1.0","task_items","from_meeting_topic"]},"description":"Create task item from meeting topic"}},{"id":"01c94003-f58e-4dc3-8eaf-1b6d54124273","name":"createTaskItemsFromRfi — Create task item from RFI","request":{"method":"POST","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/task_items/from_rfi","host":["{{baseUrl}}"],"path":["rest","v1.0","task_items","from_rfi"]},"description":"Create task item from RFI"}},{"id":"a672961c-3361-45f3-82af-183d3b49b612","name":"getTaskItem — Show task item","request":{"method":"GET","header":[{"key":"OS-Company-Id","value":"{{companyId}}"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/task_items/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","task_items",":id"],"query":[{"key":"project_id","value":"","disabled":false},{"key":"view","value":"","disabled":true}],"variable":[{"key":"id","value":""}]},"description":"Show task item"}},{"id":"26efd4f6-c005-46dc-8c59-0a888cd0bb24","name":"updateTaskItem — Update task item","request":{"method":"PATCH","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/task_items/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","task_items",":id"],"query":[{"key":"project_id","value":"","disabled":false},{"key":"view","value":"","disabled":true}],"variable":[{"key":"id","value":""}]},"description":"Update task item","body":{"mode":"formdata","formdata":[{"key":"task_item","value":"","type":"text"}]}}},{"id":"c6179df0-ff80-458a-8f6f-98290b161044","name":"deleteTaskItem — Destroy task item","request":{"method":"DELETE","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/task_items/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","task_items",":id"],"query":[{"key":"project_id","value":"","disabled":false},{"key":"view","value":"","disabled":true}],"variable":[{"key":"id","value":""}]},"description":"Destroy task item"}}]},{"name":"Timesheets","description":"Module: timesheets","item":[{"id":"76949668-6da7-4362-8cea-bb34dbf239c4","name":"listProjectTimecardEntries — List timecard entries","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/timecard_entries","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","timecard_entries"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"List timecard entries"}},{"id":"8bf6688e-d0eb-49ef-89a3-ed91e5276058","name":"createProjectTimecardEntry — Create timecard entry","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/timecard_entries","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","timecard_entries"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Create timecard entry","body":{"mode":"raw","raw":"{\n  \"timecard_entry\": {\n    \"hours\": \"\",\n    \"party_id\": 0\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"466b6761-a67c-4a8d-8d35-39b796760f98","name":"createProjectTimecardEntriesBulkCreate — Bulk create timecard entries","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/timecard_entries/bulk_create","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","timecard_entries","bulk_create"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Bulk create timecard entries\n\nCreate up to 100 timecard entries ({ timecard_entries: [...] }). All or nothing: every entry is created in one transaction, or none is (422 lists the failing fields). Above 100 entries: 422."}},{"id":"9c2744d9-8eeb-421e-8877-b534821bb96d","name":"updateProjectTimecardEntriesBulkUpdate — Bulk update timecard entries","request":{"method":"PATCH","header":[{"key":"OS-Company-Id","value":"{{companyId}}"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/timecard_entries/bulk_update","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","timecard_entries","bulk_update"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Bulk update timecard entries\n\nUpdate up to 100 timecard entries. Each item carries the record `id` and the fields to change, and runs through the same checks as PATCH …/timecard_entries/{id}. Items run in order; a failing item does not roll back the others. With Idempotency-Key, a retried batch replays the first response; retry only the failed items with a new key.","body":{"mode":"raw","raw":"{\n  \"timecard_entries\": [\n    {\n      \"hours\": \"\",\n      \"party_id\": 0\n    }\n  ]\n}","options":{"raw":{"language":"json"}}}}},{"id":"cf4e300f-2df3-4645-8c7a-1a5b485afa51","name":"getProjectTimecardEntry — Show timecard entry","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/timecard_entries/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","timecard_entries",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Show timecard entry"}},{"id":"47a9d4a2-9b65-42c3-8e58-daf9ec1eb627","name":"updateProjectTimecardEntry — Update timecard entry","request":{"method":"PATCH","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/timecard_entries/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","timecard_entries",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Update timecard entry","body":{"mode":"raw","raw":"{\n  \"timecard_entry\": {\n    \"hours\": \"\",\n    \"party_id\": 0\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"f75168ad-0138-4010-86e1-d5cca03c3fed","name":"deleteProjectTimecardEntry — Delete a timecard entry","request":{"method":"DELETE","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/timecard_entries/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","timecard_entries",":id"],"variable":[{"key":"project_id","value":"{{projectId}}","description":"Project id in the authenticated company."},{"key":"id","value":"","description":"Timecard entry id in the specified project."}]},"description":"Delete a timecard entry\n\nRequires timesheets:write and Timesheets delete permission in the specified project. Soft-deletes one live entry. A linked timesheet must be live and belong to the same project. An approved or completed entry, or an approved parent timesheet, blocks deletion."}},{"id":"9ba67fd0-4057-4b18-88b3-5f7105c728a0","name":"removeSignatureProjectTimecardEntry — Remove a timecard entry signature","request":{"method":"PATCH","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/timecard_entries/:id/remove_signature","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","timecard_entries",":id","remove_signature"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Remove a timecard entry signature"}},{"id":"fa5ec035-29a7-480b-8819-c4280462b3dd","name":"signProjectTimecardEntry — Sign a timecard entry","request":{"method":"PATCH","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/timecard_entries/:id/sign","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","timecard_entries",":id","sign"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Sign a timecard entry","body":{"mode":"raw","raw":"{\n  \"signature_text\": \"\"\n}","options":{"raw":{"language":"json"}}}}},{"id":"7c6be8a4-af25-42f0-848d-e84270a87483","name":"listProjectTimesheets — List timesheets","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/timesheets","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","timesheets"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"List timesheets"}},{"id":"8b9a3767-4790-49f5-83f0-8e47c4b1dfb0","name":"createProjectTimesheet — Create timesheet","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/timesheets","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","timesheets"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Create timesheet","body":{"mode":"raw","raw":"{\n  \"timesheet\": {\n    \"date\": \"2026-01-31\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"dccb4675-114d-4130-8793-e6264f113b88","name":"updateProjectTimesheetsUpdateApproval — Update timesheet approval status","request":{"method":"PATCH","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/timesheets/update_approval","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","timesheets","update_approval"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Update timesheet approval status","body":{"mode":"raw","raw":"{\n  \"timesheets\": [\n    {}\n  ]\n}","options":{"raw":{"language":"json"}}}}},{"id":"102bd0c7-fe26-4afe-8015-96bcaf1103ff","name":"getProjectTimesheet — Show timesheet","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/timesheets/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","timesheets",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Show timesheet"}},{"id":"99d11081-3f80-4aa1-8115-0812873f57d9","name":"updateProjectTimesheet — Update timesheet","request":{"method":"PATCH","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/timesheets/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","timesheets",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Update timesheet"}},{"id":"e3e4b5c0-26f1-4e9e-8827-d6b8da7feda9","name":"deleteProjectTimesheet — Delete a timesheet","request":{"method":"DELETE","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/timesheets/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","timesheets",":id"],"variable":[{"key":"project_id","value":"{{projectId}}","description":"Project id in the authenticated company."},{"key":"id","value":"","description":"Timesheet id in the specified project."}]},"description":"Delete a timesheet\n\nRequires timesheets:write and Timesheets delete permission in the specified project. Soft-deletes a live timesheet and keeps its linked timecard entry rows. Reopen an approved timesheet before deleting it. Approved or completed live entries block deletion."}},{"id":"95573749-778a-4eec-889e-52e9cdb5a8dc","name":"approveProjectTimesheet — Approve timesheet","request":{"method":"PATCH","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/timesheets/:id/approve","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","timesheets",":id","approve"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Approve timesheet"}},{"id":"0f5459bb-d816-400c-86c2-1e6601684716","name":"rejectProjectTimesheet — Reject timesheet","request":{"method":"PATCH","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/timesheets/:id/reject","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","timesheets",":id","reject"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Reject timesheet"}},{"id":"a9f8a65f-a301-4ff9-8df1-9bdde6cddfff","name":"submitProjectTimesheet — Submit timesheet","request":{"method":"PATCH","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/timesheets/:id/submit","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","timesheets",":id","submit"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Submit timesheet"}}]},{"name":"T&M Tickets","description":"Module: tm_tickets","item":[{"id":"ee12eec0-c856-4bd1-89f5-934248bce6b0","name":"listProjectTmTickets — List Time & Materials Tickets","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/tm_tickets","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","tm_tickets"],"query":[{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true}],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"List Time & Materials Tickets"}},{"id":"3eff790b-d7e3-4fb7-839c-0d5c35776d6c","name":"createProjectTmTicket — Create a Time & Materials Ticket","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/tm_tickets","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","tm_tickets"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Create a Time & Materials Ticket"}},{"id":"abdf6748-1d60-4187-8977-7b74b9e77e37","name":"getProjectTmTicket — Show a Time & Materials Ticket","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/tm_tickets/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","tm_tickets",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Show a Time & Materials Ticket"}},{"id":"09e30d4a-b985-4036-8284-ec95c9e52aae","name":"updateProjectTmTicket — Update a Time & Materials Ticket","request":{"method":"PATCH","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/tm_tickets/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","tm_tickets",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Update a Time & Materials Ticket"}},{"id":"0a66d23a-0e1b-41a5-885e-4d652eaf6544","name":"deleteProjectTmTicket — Delete a Time & Materials Ticket","request":{"method":"DELETE","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/tm_tickets/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","tm_tickets",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Delete a Time & Materials Ticket"}},{"id":"644dffae-e90f-4cb6-8f89-2f235bfc83d1","name":"approveProjectTmTicket — Approve T&M ticket","request":{"method":"POST","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/tm_tickets/:id/approve","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","tm_tickets",":id","approve"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Approve T&M ticket"}},{"id":"c51a40b4-64d2-45be-8240-f7cd2c516175","name":"approveProjectTmTicketPatch — Approve a submitted ticket","request":{"method":"PATCH","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/tm_tickets/:id/approve","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","tm_tickets",":id","approve"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Approve a submitted ticket"}},{"id":"cdfacf89-c346-43f1-84d6-b6a582b793fa","name":"listProjectTmTicketAttachments — List a T&M ticket's attachments","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/tm_tickets/:id/attachments","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","tm_tickets",":id","attachments"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"List a T&M ticket's attachments"}},{"id":"b3c4681a-a545-4504-80a8-b164b70aa43d","name":"createProjectTmTicketAttachment — Append name+URL attachments to a T&M ticket","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/tm_tickets/:id/attachments","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","tm_tickets",":id","attachments"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Append name+URL attachments to a T&M ticket","body":{"mode":"raw","raw":"{\n  \"attachments\": [\n    {\n      \"name\": \"\",\n      \"url\": \"\"\n    }\n  ]\n}","options":{"raw":{"language":"json"}}}}},{"id":"2fde1a71-4677-4495-864f-380991a9173b","name":"deleteProjectTmTicketAttachment — Remove an attachment from a T&M ticket","request":{"method":"DELETE","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/tm_tickets/:id/attachments/:attachment_id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","tm_tickets",":id","attachments",":attachment_id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""},{"key":"attachment_id","value":""}]},"description":"Remove an attachment from a T&M ticket"}},{"id":"e4455ff4-8eed-4a75-8b9c-61ee77c50aaf","name":"rejectProjectTmTicket — Reject T&M ticket","request":{"method":"POST","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/tm_tickets/:id/reject","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","tm_tickets",":id","reject"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Reject T&M ticket"}},{"id":"f231ece3-19fb-4abc-8994-4dddc6e084c8","name":"rejectProjectTmTicketPatch — Reject a submitted ticket","request":{"method":"PATCH","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/tm_tickets/:id/reject","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","tm_tickets",":id","reject"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Reject a submitted ticket"}},{"id":"e711f89e-a714-4601-86e7-d695d0687b12","name":"submitProjectTmTicket — Submit T&M ticket","request":{"method":"POST","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/tm_tickets/:id/submit","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","tm_tickets",":id","submit"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Submit T&M ticket"}},{"id":"ea95fb5e-8244-4428-8fba-f26e96d6a8e6","name":"submitProjectTmTicketPatch — Submit a ticket for review","request":{"method":"PATCH","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/tm_tickets/:id/submit","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","tm_tickets",":id","submit"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Submit a ticket for review"}}]},{"name":"Transmittals","description":"Module: transmittals","item":[{"id":"78bd8c95-1adc-44ad-84c2-d48101b8fed6","name":"listTransmittals — List visible project transmittals","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/transmittals","host":["{{baseUrl}}"],"path":["rest","v1.0","transmittals"],"query":[{"key":"project_id","value":"","disabled":false},{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true},{"key":"search","value":"","disabled":true},{"key":"sort","value":"","disabled":true},{"key":"filters[id]","value":"","disabled":true},{"key":"filters[sent_via]","value":"","disabled":true},{"key":"filters[submitted_for]","value":"","disabled":true},{"key":"filters[from_id]","value":"","disabled":true},{"key":"filters[search]","value":"","disabled":true}]},"description":"List visible project transmittals\n\n Authorization and record visibility are checked by the existing REST handler; catalog presence does not grant access."}},{"id":"26468222-d34e-4471-8def-2ed95edaf996","name":"createTransmittal — Create a transmittal","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/transmittals","host":["{{baseUrl}}"],"path":["rest","v1.0","transmittals"],"query":[{"key":"project_id","value":"","disabled":false}]},"description":"Create a transmittal\n\nCreates a transmittal. deliver=true queues recipient email notifications and requires a UUID submission_key plus at least one recipient. Referenced documents/drawings require their corresponding source permissions.  Authorization and record visibility are checked by the existing REST handler; catalog presence does not grant access.","body":{"mode":"raw","raw":"{\n  \"transmittal\": {\n    \"subject\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"a7d58f6f-d05e-483b-825b-c498977c0df9","name":"createTransmittalsCreateFrom — Create a transmittal from documents or drawings","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/transmittals/create_from","host":["{{baseUrl}}"],"path":["rest","v1.0","transmittals","create_from"],"query":[{"key":"project_id","value":"","disabled":false}]},"description":"Create a transmittal from documents or drawings\n\nCreates a transmittal. deliver=true queues recipient email notifications and requires a UUID submission_key plus at least one recipient. Referenced documents/drawings require their corresponding source permissions. Select at least one document or drawing. Version selection arrays must match the corresponding IDs in length. Authorization and record visibility are checked by the existing REST handler; catalog presence does not grant access.","body":{"mode":"raw","raw":"{\n  \"transmittal\": {\n    \"document_ids\": null\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"1b655dd4-e562-4f95-8313-f48ad68adbeb","name":"listTransmittalsRecycleBin — List recycled project transmittals","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/transmittals/recycle_bin","host":["{{baseUrl}}"],"path":["rest","v1.0","transmittals","recycle_bin"],"query":[{"key":"project_id","value":"","disabled":false},{"key":"page","value":"1","disabled":true},{"key":"per_page","value":"100","disabled":true}]},"description":"List recycled project transmittals\n\nRequires the project transmittals delete permission even though this operation is read only. Authorization and record visibility are checked by the existing REST handler; catalog presence does not grant access."}},{"id":"c4ebe1f1-1390-46ab-80b2-beaa10314273","name":"getTransmittal — Get a visible transmittal","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/transmittals/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","transmittals",":id"],"query":[{"key":"project_id","value":"","disabled":true}],"variable":[{"key":"id","value":""}]},"description":"Get a visible transmittal\n\n Authorization and record visibility are checked by the existing REST handler; catalog presence does not grant access."}},{"id":"53c51940-67b6-444f-8a42-e678121a3b4b","name":"updateTransmittal — Update a transmittal","request":{"method":"PATCH","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/transmittals/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","transmittals",":id"],"query":[{"key":"project_id","value":"","disabled":true}],"variable":[{"key":"id","value":""}]},"description":"Update a transmittal\n\n Authorization and record visibility are checked by the existing REST handler; catalog presence does not grant access.","body":{"mode":"raw","raw":"{\n  \"transmittal\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"4b007b1e-0141-460b-8267-14ee82d337ae","name":"deleteTransmittal — Move a transmittal to the recycle bin","request":{"method":"DELETE","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/transmittals/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","transmittals",":id"],"query":[{"key":"project_id","value":"","disabled":true}],"variable":[{"key":"id","value":""}]},"description":"Move a transmittal to the recycle bin\n\n Authorization and record visibility are checked by the existing REST handler; catalog presence does not grant access."}},{"id":"1c9f4a2d-3819-4461-8a8a-3c1ba2d3785a","name":"listTransmittalItemDownload — Download transmittal item","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/transmittals/:id/items/:item_id/download","host":["{{baseUrl}}"],"path":["rest","v1.0","transmittals",":id","items",":item_id","download"],"variable":[{"key":"id","value":""},{"key":"item_id","value":""}]},"description":"Download transmittal item"}},{"id":"efe8337b-b64a-4509-80b6-a0a9ff1bc6ea","name":"updateTransmittalReceipts — Update a current recipient receipt","request":{"method":"PATCH","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/transmittals/:id/receipts","host":["{{baseUrl}}"],"path":["rest","v1.0","transmittals",":id","receipts"],"query":[{"key":"project_id","value":"","disabled":true}],"variable":[{"key":"id","value":""}]},"description":"Update a current recipient receipt\n\nRequires a current recipient. The authenticated user may update their own receipt; project transmittals administrators may update other recipient receipts. Authorization and record visibility are checked by the existing REST handler; catalog presence does not grant access.","body":{"mode":"raw","raw":"{\n  \"user_id\": 0\n}","options":{"raw":{"language":"json"}}}}},{"id":"612358f2-f945-4427-8808-b9f34503e017","name":"restoreTransmittal — Restore a recycled transmittal","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/transmittals/:id/restore","host":["{{baseUrl}}"],"path":["rest","v1.0","transmittals",":id","restore"],"query":[{"key":"project_id","value":"","disabled":true}],"variable":[{"key":"id","value":""}]},"description":"Restore a recycled transmittal\n\nRequires the project transmittals delete permission. Authorization and record visibility are checked by the existing REST handler; catalog presence does not grant access."}},{"id":"491672fc-edde-4df3-8b07-421eaf93b363","name":"restoreTransmittalPatch — Restore a recycled transmittal","request":{"method":"PATCH","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/transmittals/:id/restore","host":["{{baseUrl}}"],"path":["rest","v1.0","transmittals",":id","restore"],"query":[{"key":"project_id","value":"","disabled":true}],"variable":[{"key":"id","value":""}]},"description":"Restore a recycled transmittal\n\nRequires the project transmittals delete permission. Authorization and record visibility are checked by the existing REST handler; catalog presence does not grant access."}}]},{"name":"Work Breakdown Structure","description":"Module: wbs","item":[{"id":"13ef8bd1-ad1a-456e-82a4-2e41d5e2f465","name":"listCompanyWorkBreakdownStructurePatterns — Show the company WBS pattern","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/work_breakdown_structure/patterns","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","work_breakdown_structure","patterns"],"variable":[{"key":"company_id","value":"{{companyId}}"}]},"description":"Show the company WBS pattern"}},{"id":"3334433d-2fe9-49f9-885e-20808f564b86","name":"listCompanyWorkBreakdownStructureSegments — List company WBS segments","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/work_breakdown_structure/segments","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","work_breakdown_structure","segments"],"variable":[{"key":"company_id","value":"{{companyId}}"}]},"description":"List company WBS segments"}},{"id":"e0e3e5dc-54ec-4fc7-8921-80f609cc9c87","name":"createCompanyWorkBreakdownStructureSegment — Create a company WBS segment","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/work_breakdown_structure/segments","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","work_breakdown_structure","segments"],"variable":[{"key":"company_id","value":"{{companyId}}"}]},"description":"Create a company WBS segment"}},{"id":"d39751a2-3b76-4799-8a0c-34ba4c6ec7de","name":"getCompanyWorkBreakdownStructureSegment — Show a company WBS segment","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/work_breakdown_structure/segments/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","work_breakdown_structure","segments",":id"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Show a company WBS segment"}},{"id":"89c89ad9-be84-4019-8f18-78866b534148","name":"updateCompanyWorkBreakdownStructureSegment — Update a company WBS segment","request":{"method":"PATCH","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/work_breakdown_structure/segments/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","work_breakdown_structure","segments",":id"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Update a company WBS segment"}},{"id":"95ded442-cca3-47a3-8aa8-aebc73a75a88","name":"deleteCompanyWorkBreakdownStructureSegment — Delete a company WBS segment","request":{"method":"DELETE","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/work_breakdown_structure/segments/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","work_breakdown_structure","segments",":id"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Id of the authenticated company."},{"key":"id","value":"","description":"WBS segment id."}]},"description":"Delete a company WBS segment\n\nRequires wbs:write and company administrator access in the authenticated company. Deletes a shared company segment. Deletes the segment and its items. Deletion is blocked if an assembled WBS code uses any of its items or the retained hierarchy is invalid."}},{"id":"85778eba-3c91-4519-8cbb-78dd23226e06","name":"listCompanyWorkBreakdownStructureSegmentSegmentItems — List company segment items","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/work_breakdown_structure/segments/:id/segment_items","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","work_breakdown_structure","segments",":id","segment_items"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"List company segment items"}},{"id":"6625c4ad-7e54-42ca-8661-fe87facaee55","name":"createCompanyWorkBreakdownStructureSegmentSegmentItem — Create a company segment item","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/work_breakdown_structure/segments/:id/segment_items","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","work_breakdown_structure","segments",":id","segment_items"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Create a company segment item"}},{"id":"846c9a63-8b69-460f-8b31-2e259c79ae96","name":"getCompanyWorkBreakdownStructureSegmentSegmentItem — Show a company WBS segment item","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/work_breakdown_structure/segments/:id/segment_items/:item_id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","work_breakdown_structure","segments",":id","segment_items",":item_id"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Id of the authenticated company."},{"key":"id","value":"","description":"WBS segment id."},{"key":"item_id","value":"","description":"WBS segment item id within the segment."}]},"description":"Show a company WBS segment item\n\nRequires wbs:read for the authenticated company. The item must belong to the specified shared company segment."}},{"id":"482f3acd-c563-453a-826d-ec99f6a1f93e","name":"updateCompanyWorkBreakdownStructureSegmentSegmentItem — Update a company WBS segment item","request":{"method":"PATCH","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/work_breakdown_structure/segments/:id/segment_items/:item_id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","work_breakdown_structure","segments",":id","segment_items",":item_id"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Id of the authenticated company."},{"key":"id","value":"","description":"WBS segment id."},{"key":"item_id","value":"","description":"WBS segment item id within the segment."}]},"description":"Update a company WBS segment item\n\nRequires wbs:write and company administrator access in the authenticated company. Updates fields supplied under segment_item in a shared company segment. A parent must belong to the same tiered segment and preserve an acyclic hierarchy. Set parent_id to null to make the item a root.","body":{"mode":"raw","raw":"{\n  \"segment_item\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"f5319a77-f979-4886-840c-2dcc71b3f54b","name":"deleteCompanyWorkBreakdownStructureSegmentSegmentItem — Delete a company WBS segment item","request":{"method":"DELETE","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/work_breakdown_structure/segments/:id/segment_items/:item_id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","work_breakdown_structure","segments",":id","segment_items",":item_id"],"variable":[{"key":"company_id","value":"{{companyId}}","description":"Id of the authenticated company."},{"key":"id","value":"","description":"WBS segment id."},{"key":"item_id","value":"","description":"WBS segment item id within the segment."}]},"description":"Delete a company WBS segment item\n\nRequires wbs:write and company administrator access in the authenticated company. Applies to a shared company segment. Deletes this item and its descendants. Deletion is blocked if an assembled WBS code uses an item in this subtree or the retained hierarchy is invalid."}},{"id":"8f4aa713-3f91-4589-860d-bcbad7bfd85f","name":"listLineItemTypes — List cost types (line item types)","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/line_item_types","host":["{{baseUrl}}"],"path":["rest","v1.0","line_item_types"]},"description":"List cost types (line item types)"}},{"id":"7ee9a29e-5507-4ba8-82be-b46a79751d35","name":"createLineItemType — Create a cost type","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/line_item_types","host":["{{baseUrl}}"],"path":["rest","v1.0","line_item_types"]},"description":"Create a cost type"}},{"id":"22b4f23b-e5e8-44f8-8642-c9597003d7f9","name":"getLineItemType — Show a cost type","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/line_item_types/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","line_item_types",":id"],"variable":[{"key":"id","value":""}]},"description":"Show a cost type"}},{"id":"81bc818e-0874-4d40-8543-d55345ec8bf9","name":"updateLineItemType — Update a cost type","request":{"method":"PATCH","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/line_item_types/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","line_item_types",":id"],"variable":[{"key":"id","value":""}]},"description":"Update a cost type"}},{"id":"fed535cd-29ec-450d-8ea7-08840eb7e428","name":"deleteLineItemType — Delete line item type","request":{"method":"DELETE","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/line_item_types/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","line_item_types",":id"],"variable":[{"key":"id","value":""}]},"description":"Delete line item type"}},{"id":"3b739f18-9728-4e7b-8a86-b9ea51dce07b","name":"listProjectWorkBreakdownStructurePatterns — Show the project WBS pattern","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/work_breakdown_structure/patterns","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","work_breakdown_structure","patterns"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Show the project WBS pattern"}},{"id":"ae75cd29-3a40-4f0b-8eda-d21a4cfd2d09","name":"listProjectWorkBreakdownStructureSegments — List project WBS segments","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/work_breakdown_structure/segments","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","work_breakdown_structure","segments"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"List project WBS segments"}},{"id":"a66b3ae9-6d56-4e8d-8b63-3742b45b4ef4","name":"createProjectWorkBreakdownStructureSegment — Create a project WBS segment","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/work_breakdown_structure/segments","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","work_breakdown_structure","segments"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Create a project WBS segment"}},{"id":"0f75bb57-3fe2-4dcc-8274-e016ca6f8f60","name":"getProjectWorkBreakdownStructureSegment — Show a project WBS segment","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/work_breakdown_structure/segments/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","work_breakdown_structure","segments",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Show a project WBS segment"}},{"id":"0d572d10-578a-45b8-848b-ec337ef3d9f5","name":"updateProjectWorkBreakdownStructureSegment — Update a project WBS segment","request":{"method":"PATCH","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/work_breakdown_structure/segments/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","work_breakdown_structure","segments",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Update a project WBS segment"}},{"id":"44603c9c-54f1-4fb2-8cb5-b56f9559239a","name":"deleteProjectWorkBreakdownStructureSegment — Delete a project WBS segment","request":{"method":"DELETE","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/work_breakdown_structure/segments/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","work_breakdown_structure","segments",":id"],"variable":[{"key":"project_id","value":"{{projectId}}","description":"Project id in the authenticated company."},{"key":"id","value":"","description":"WBS segment id."}]},"description":"Delete a project WBS segment\n\nRequires wbs:write and the WBS delete permission on the specified project. The segment must belong to that project. Use the company endpoint for shared segments. Deletes the segment and its items. Deletion is blocked if an assembled WBS code uses any of its items or the retained hierarchy is invalid."}},{"id":"1b3e26a4-9c00-4d86-8890-702d01936f02","name":"listProjectWorkBreakdownStructureSegmentSegmentItems — List project segment items","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/work_breakdown_structure/segments/:id/segment_items","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","work_breakdown_structure","segments",":id","segment_items"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"List project segment items"}},{"id":"d40581a6-912d-4d90-8888-28b34562df23","name":"createProjectWorkBreakdownStructureSegmentSegmentItem — Create a project segment item","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/work_breakdown_structure/segments/:id/segment_items","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","work_breakdown_structure","segments",":id","segment_items"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Create a project segment item"}},{"id":"7057ace2-dee8-43d6-8f33-acc7623cc98c","name":"getProjectWorkBreakdownStructureSegmentSegmentItem — Show a WBS segment item in project context","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/work_breakdown_structure/segments/:id/segment_items/:item_id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","work_breakdown_structure","segments",":id","segment_items",":item_id"],"variable":[{"key":"project_id","value":"{{projectId}}","description":"Project id in the authenticated company."},{"key":"id","value":"","description":"WBS segment id."},{"key":"item_id","value":"","description":"WBS segment item id within the segment."}]},"description":"Show a WBS segment item in project context\n\nRequires wbs:read and WBS view permission on the project. Reads a project-owned item or an item inherited from a company WBS segment. The item must belong to the specified segment."}},{"id":"eb7fdc05-dd28-4f3d-8caf-56fa58e93cb1","name":"updateProjectWorkBreakdownStructureSegmentSegmentItem — Update a project segment item","request":{"method":"PATCH","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/work_breakdown_structure/segments/:id/segment_items/:item_id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","work_breakdown_structure","segments",":id","segment_items",":item_id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""},{"key":"item_id","value":""}]},"description":"Update a project segment item"}},{"id":"4bc0dff9-bb23-4344-8cd9-1cdac31ae588","name":"deleteProjectWorkBreakdownStructureSegmentSegmentItem — Delete a project WBS segment item","request":{"method":"DELETE","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/work_breakdown_structure/segments/:id/segment_items/:item_id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","work_breakdown_structure","segments",":id","segment_items",":item_id"],"variable":[{"key":"project_id","value":"{{projectId}}","description":"Project id in the authenticated company."},{"key":"id","value":"","description":"WBS segment id."},{"key":"item_id","value":"","description":"WBS segment item id within the segment."}]},"description":"Delete a project WBS segment item\n\nRequires wbs:write and the WBS delete permission on the specified project. The item must belong to a segment owned by that project. Use the company endpoint for shared items. Deletes this item and its descendants. Deletion is blocked if an assembled WBS code uses an item in this subtree or the retained hierarchy is invalid."}},{"id":"e9cb80c6-ba40-4c59-88e0-5fb4b81af6ce","name":"listProjectWorkBreakdownStructureWbsCodes — List assembled WBS codes","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/work_breakdown_structure/wbs_codes","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","work_breakdown_structure","wbs_codes"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"List assembled WBS codes"}},{"id":"5b1ac4e2-ef42-43cf-850b-8911e09e28de","name":"createProjectWorkBreakdownStructureWbsCode — Create an assembled WBS code","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/work_breakdown_structure/wbs_codes","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","work_breakdown_structure","wbs_codes"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Create an assembled WBS code"}},{"id":"2710b978-7c52-4f93-8a4b-fae0564efaa8","name":"getProjectWorkBreakdownStructureWbsCode — Show an assembled WBS code","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/work_breakdown_structure/wbs_codes/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","work_breakdown_structure","wbs_codes",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Show an assembled WBS code"}},{"id":"15aa45d0-1780-4ce4-8c5f-feafbfaf8db5","name":"updateProjectWorkBreakdownStructureWbsCode — Update an assembled WBS code","request":{"method":"PATCH","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/work_breakdown_structure/wbs_codes/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","work_breakdown_structure","wbs_codes",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Update an assembled WBS code"}},{"id":"0f185a50-e311-4e5c-8ac3-95adf167a3ea","name":"deleteProjectWorkBreakdownStructureWbsCode — Delete a project WBS code","request":{"method":"DELETE","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/work_breakdown_structure/wbs_codes/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","work_breakdown_structure","wbs_codes",":id"],"variable":[{"key":"project_id","value":"{{projectId}}","description":"Project id in the authenticated company."},{"key":"id","value":"","description":"Assembled WBS code id in the project."}]},"description":"Delete a project WBS code\n\nRequires wbs:write and the WBS delete permission on the specified project. Deletes the assembled code and its links to segment items. The underlying segment items are retained."}},{"id":"6be26fec-b756-4545-8c27-c9359f4e1fa9","name":"listStandardCostCodes — List standard cost codes","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/standard_cost_codes","host":["{{baseUrl}}"],"path":["rest","v1.0","standard_cost_codes"]},"description":"List standard cost codes"}},{"id":"33b337b1-36b8-4c3b-80ef-11afb6f605af","name":"createStandardCostCode — Create a standard cost code","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/standard_cost_codes","host":["{{baseUrl}}"],"path":["rest","v1.0","standard_cost_codes"]},"description":"Create a standard cost code"}},{"id":"155736eb-08b7-4f10-8386-08e51b6146cc","name":"getStandardCostCode — Show a standard cost code","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/standard_cost_codes/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","standard_cost_codes",":id"],"variable":[{"key":"id","value":""}]},"description":"Show a standard cost code"}},{"id":"939e75b3-8c7e-4ec2-82d7-c83e1d1d5914","name":"updateStandardCostCode — Update a standard cost code","request":{"method":"PATCH","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/standard_cost_codes/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","standard_cost_codes",":id"],"variable":[{"key":"id","value":""}]},"description":"Update a standard cost code"}},{"id":"9eccf5a0-f92a-45f1-88b6-020c037ee95d","name":"deleteStandardCostCode — Delete a company standard cost code","request":{"method":"DELETE","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/standard_cost_codes/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","standard_cost_codes",":id"],"variable":[{"key":"id","value":"","description":"Standard cost code id in the authenticated company catalog."}]},"description":"Delete a company standard cost code\n\nRequires wbs:write and company administrator access in the authenticated company. Permanently deletes the catalog code and all of its descendants. Project cost codes use a separate catalog."}}]},{"name":"Webhooks","description":"Module: webhooks","item":[{"id":"ee321013-ff75-44f9-8759-9ad8064d1afc","name":"listCompanyWebhooks — List webhook subscriptions","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/webhooks","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","webhooks"],"variable":[{"key":"company_id","value":"{{companyId}}"}]},"description":"List webhook subscriptions"}},{"id":"4897dd54-998c-4dc2-822b-41aaf33ea1c8","name":"createCompanyWebhook — Create a webhook subscription","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/webhooks","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","webhooks"],"variable":[{"key":"company_id","value":"{{companyId}}"}]},"description":"Create a webhook subscription","body":{"mode":"raw","raw":"{\n  \"webhook\": {\n    \"events\": [\n      \"\"\n    ],\n    \"url\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"ffdc6ca4-6ea5-4d8d-87a9-eefe0793a4e9","name":"listCompanyWebhooksEventTypes — List the project record event catalog","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/webhooks/event_types","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","webhooks","event_types"],"variable":[{"key":"company_id","value":"{{companyId}}"}]},"description":"List the project record event catalog\n\nEvery project record event with its version, resource, the permission a subscription owner needs, and the JSON Schema of data."}},{"id":"2a56db2b-db92-415c-8462-33b033e788cf","name":"getCompanyWebhook — Show a webhook subscription (secret masked; see secret_preview)","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/webhooks/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","webhooks",":id"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Show a webhook subscription (secret masked; see secret_preview)"}},{"id":"7b98e1a2-a5a7-458f-8bc7-56e36ef29617","name":"updateCompanyWebhook — Update a webhook subscription","request":{"method":"PATCH","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/webhooks/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","webhooks",":id"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Update a webhook subscription\n\nReturns the full secret only when the request sets secret (a rotation); otherwise secret_preview only. A secret may not start with v1: or v2:.","body":{"mode":"raw","raw":"{\n  \"webhook\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"80b1da5a-2e91-4451-8284-3f00fec58fd3","name":"deleteCompanyWebhook — Delete a webhook subscription","request":{"method":"DELETE","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/webhooks/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","webhooks",":id"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Delete a webhook subscription"}},{"id":"ee8a3627-8822-4e51-8be5-be4551cd9708","name":"listCompanyWebhookDeliveries — List delivery history (company administrators only)","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/webhooks/:id/deliveries","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","webhooks",":id","deliveries"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"List delivery history (company administrators only)"}},{"id":"b97b9ac8-24ac-46d1-865c-7996bd7642fd","name":"createCompanyWebhookDelivery — Queue an idempotent synthetic webhook.test delivery (company administrators only)","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/webhooks/:id/deliveries","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","webhooks",":id","deliveries"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Queue an idempotent synthetic webhook.test delivery (company administrators only)","body":{"mode":"raw","raw":"{\n  \"request_key\": \"\"\n}","options":{"raw":{"language":"json"}}}}},{"id":"df26908b-6495-427c-8739-50a6ab3702a6","name":"replayCompanyWebhookDelivery — Replay one project record event delivery","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/webhooks/:id/deliveries/:delivery_id/replay","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","webhooks",":id","deliveries",":delivery_id","replay"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""},{"key":"delivery_id","value":""}]},"description":"Replay one project record event delivery\n\nQueues the same event (same event_id) under a new delivery id, with replay: true, replay_of and no sequence. The event must be within the 30-day retention and the subscription active; the owner must still be able to read the record."}},{"id":"62ce335d-c272-456c-88b2-0f25ca088da4","name":"retryCompanyWebhookDelivery — Requeue a failed test delivery with its original bytes and identity","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/webhooks/:id/deliveries/:delivery_id/retry","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","webhooks",":id","deliveries",":delivery_id","retry"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""},{"key":"delivery_id","value":""}]},"description":"Requeue a failed test delivery with its original bytes and identity"}},{"id":"db8e017b-6f13-4f9b-8520-f0fd19c42f3d","name":"replayCompanyWebhook — Replay project record events from a time range","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/webhooks/:id/replay","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","webhooks",":id","replay"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Replay project record events from a time range\n\nQueues replays of the subscription's matching project record events recorded in [since, until), oldest first, at most 500 per call (truncated: true when more remain). Optional events narrows by name or wildcard.","body":{"mode":"raw","raw":"{\n  \"events\": [\n    \"\"\n  ],\n  \"since\": \"2026-01-31T12:00:00Z\",\n  \"until\": \"2026-01-31T12:00:00Z\"\n}","options":{"raw":{"language":"json"}}}}},{"id":"aa6485ae-c2b2-4059-8ebc-c557d934649f","name":"rotateSecretCompanyWebhook — Rotate the signing secret","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/webhooks/:id/rotate_secret","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","webhooks",":id","rotate_secret"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Rotate the signing secret\n\nReplaces the signing secret with a generated 64-hex-character value and returns it; this is the only time it is shown. Deliveries sign with it from their next attempt. No overlap window: update the receiver right away."}}]},{"name":"Workforce Planning","description":"Module: workforce","item":[{"id":"370052d9-1c86-464c-84a5-a32ff8d4306d","name":"listCompanyCrews — List crews","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/crews","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","crews"],"variable":[{"key":"company_id","value":"{{companyId}}"}]},"description":"List crews"}},{"id":"64008d9d-8d6d-494c-8786-5f94b8deb8ba","name":"createCompanyCrew — Create a crew","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/crews","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","crews"],"variable":[{"key":"company_id","value":"{{companyId}}"}]},"description":"Create a crew","body":{"mode":"raw","raw":"{\n  \"crew\": {\n    \"name\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"5863d2b5-98e1-486f-825e-0fafecff6fd9","name":"getCompanyCrew — Show a crew","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/crews/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","crews",":id"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Show a crew"}},{"id":"d8567f8a-7cca-4a4a-8400-7fe15fd9b042","name":"updateCompanyCrew — Update a crew","request":{"method":"PATCH","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/crews/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","crews",":id"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Update a crew","body":{"mode":"raw","raw":"{\n  \"crew\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"da95d2f5-b615-4a8e-88e2-0e3479c22f76","name":"listCompanyPeople — List company people (roster)","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/people","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","people"],"variable":[{"key":"company_id","value":"{{companyId}}"}]},"description":"List company people (roster)"}},{"id":"848d51d8-64da-40a8-8e43-10aa4cc85b97","name":"peopleCompany — Create a person","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/people","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","people"],"variable":[{"key":"company_id","value":"{{companyId}}"}]},"description":"Create a person","body":{"mode":"raw","raw":"{\n  \"person\": {\n    \"first_name\": \"\",\n    \"last_name\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"dd3b3bb5-6733-484f-8525-42114f207798","name":"listCompanyPeopleFilterOptionsTrade — Trade filter options","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/people/filter_options/trade","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","people","filter_options","trade"],"variable":[{"key":"company_id","value":"{{companyId}}"}]},"description":"Trade filter options"}},{"id":"02b31ee0-a361-4374-81a1-a50408005920","name":"listCompanyPeopleInactive — List inactive company people","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/people/inactive","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","people","inactive"],"variable":[{"key":"company_id","value":"{{companyId}}"}]},"description":"List inactive company people"}},{"id":"bdd98e9f-bcd5-4c99-8c00-9e509a3b0c61","name":"getCompanyPeople — Show a person","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/people/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","people",":id"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Show a person"}},{"id":"62f55857-107f-4594-8c3f-2c6ee1ef0642","name":"updateCompanyPeople — Update a person","request":{"method":"PATCH","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/people/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","people",":id"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Update a person","body":{"mode":"raw","raw":"{\n  \"person\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"426efd73-9e2d-4f94-88a0-d074a305b58e","name":"listCompanyPeopleAvailability — Read daily workforce availability","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/people/:id/availability","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","people",":id","availability"],"query":[{"key":"from_day","value":"","disabled":false},{"key":"through_day","value":"","disabled":false}],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Read daily workforce availability\n\nCompany-owned supply in exact minutes. Inclusive window of at most 366 days; missing or cleared days remain null. This does not reserve labor or verify scheduling unit conversion. Requires workforce:read and live company view permission."}},{"id":"ca272a3c-6130-4828-8da4-7c102298464d","name":"availabilityCompanyPeople — Record daily workforce availability","request":{"method":"PUT","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/companies/:company_id/people/:id/availability","host":["{{baseUrl}}"],"path":["rest","v1.0","companies",":company_id","people",":id","availability"],"variable":[{"key":"company_id","value":"{{companyId}}"},{"key":"id","value":""}]},"description":"Record daily workforce availability\n\nRequires workforce:write and live company edit permission. Set expected_revision to 0 only for a day never recorded; use the returned revision for changes. Null clears the value but retains its revision. Each successful save appends immutable history.","body":{"mode":"raw","raw":"{\n  \"availability\": {\n    \"available_minutes\": 0,\n    \"day\": \"2026-01-31\",\n    \"expected_revision\": 0\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"99fb0a51-9adb-49a3-8543-0e40c64d7c77","name":"listProjectWorkforceAssignments — List project assignments (optionally by date range)","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/workforce/assignments","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","workforce","assignments"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"List project assignments (optionally by date range)"}},{"id":"914b880d-740f-42b1-85d0-1655bf40aa43","name":"createProjectWorkforceAssignment — Create an assignment","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/workforce/assignments","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","workforce","assignments"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Create an assignment","body":{"mode":"raw","raw":"{\n  \"assignment\": {\n    \"start_day\": \"\"\n  }\n}","options":{"raw":{"language":"json"}}}}},{"id":"535de4f3-55f7-4b99-8298-4f5e7ddf0e98","name":"listProjectWorkforceAssignmentsFilterOptionsCrews — Crew filter options for a project","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/workforce/assignments/filter_options/crews","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","workforce","assignments","filter_options","crews"],"variable":[{"key":"project_id","value":"{{projectId}}"}]},"description":"Crew filter options for a project"}},{"id":"eb241092-0246-4bf6-815a-5699038d9808","name":"getProjectWorkforceAssignment — Show an assignment","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/workforce/assignments/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","workforce","assignments",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Show an assignment"}},{"id":"39e142e7-fa2d-4986-8377-aa078dd4a843","name":"updateProjectWorkforceAssignment — Update an assignment","request":{"method":"PATCH","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Retry-safe writes: reuse a fixed key to get the stored response back."},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/workforce/assignments/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","workforce","assignments",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Update an assignment","body":{"mode":"raw","raw":"{\n  \"assignment\": {}\n}","options":{"raw":{"language":"json"}}}}},{"id":"1254c5a0-c341-490c-836b-40c23dee5e83","name":"deleteProjectWorkforceAssignment — Delete assignment","request":{"method":"DELETE","header":[],"url":{"raw":"{{baseUrl}}/rest/v1.0/projects/:project_id/workforce/assignments/:id","host":["{{baseUrl}}"],"path":["rest","v1.0","projects",":project_id","workforce","assignments",":id"],"variable":[{"key":"project_id","value":"{{projectId}}"},{"key":"id","value":""}]},"description":"Delete assignment"}}]}]}