Get Bill Profitability Summary
GET/api/bills/:bill/profitability-summary
Get a profitability-tracking summary for a bill: how much of the bill's total has been turned into cost entries, how much remains untracked, and the full list of cost entries created from the bill.
purchase-orders:readGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Response fields:
bill_total- The bill's grand total.tracked_for_profitability- Sum of the cost entries created from this bill, in the account's base currency.not_tracked- Remainder of the bill total not yet tracked.tracking_percentage- Tracked amount as a percentage of the bill total (rounded to 2 decimals).cost_entries- Every cost entry created from this bill or its lines, including its allocation status and allocated/unallocated totals.
Use this to decide whether more of the bill can still be tracked via POST /api/bills/:bill/cost-entries.
Authentication: Requires Bearer token. Scope: purchase-orders (read/write).
Request
Responses
- 200
- 401
- 403
- 404
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Not Found
Response Headers
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.