> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.tabs.com/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.tabs.com/_mcp/server. # Bulk update usage estimates POST https://integrators.prod.api.tabsplatform.com/v3/performance-obligations/estimates Content-Type: application/json Records the expected total output quantity for usage-based performance obligations, across any number of contracts. Estimates are append-only: each call adds a revision rather than overwriting, and a quantity already in effect comes back as `UNCHANGED`. A revision restates the revenue schedule going forwards, leaving closed periods and the allocated transaction price untouched. Reference: https://docs.tabs.com/api-reference/performance-obligations/integrators-api-performance-obligations-controller-bulk-update-usage-estimates ## Authentication - `Authorization` header (required) — API Key authentication via header ## Request ### Body (application/json) This endpoint expects an object. - `items` (list of object, required) — Estimates to record, at most 100 per request. A performance obligation may appear only once. - `performanceObligationId` (string, required) — The ID of the performance obligation to record an estimate against - `estimatedQuantity` (string, required) — Expected total output quantity over the performance obligation's whole service period. Must be greater than zero. - `rationale` (string, optional) — Optional note explaining the revision, stored alongside it for audit. ## Response ### 202 Accepted. One result per request entry, in request order — `UPDATED`, `UNCHANGED`, or `REJECTED` with a `reason`. Entries are applied independently, so one rejection does not stop the rest. - `payload` (object, required) — Response payload, will be empty when success is false - `results` (list of object, required) — One result per request entry, in request order. - `performanceObligationId` (string, required) — The performance obligation this result is for - `status` (enum, required) — What happened to this entry - Allowed values: `UPDATED`, `UNCHANGED`, `REJECTED` - `estimatedQuantity` (string, required, nullable) — The estimate now in effect. Null when nothing was recorded. - `reason` (enum, optional) — Why the entry did not apply. Only set on REJECTED. - Allowed values: `NOT_FOUND`, `NOT_OUTPUT_BASED`, `INVALID_QUANTITY`, `ERROR` - `message` (string, optional) — Human-readable detail for a rejection. Only set on REJECTED. - `success` (boolean, required) — Boolean with true=success, false=failure - `message` (string, required) — Plain-text description of the result - `error` (object, optional) — json element with any error messages or warnings - `code` (double, required) — API response code - `message` (string, required) — API response message - `details` (object, optional) — Additional details about the error ## Errors ### 400 Bad Request Error Empty batch, more than 100 entries, a malformed quantity, or the same performance obligation listed twice. - `any` ### 500 Internal Server Error Internal Server Error - `any` ## Examples **Request** ```json { "items": [ { "performanceObligationId": "123e4567-e89b-12d3-a456-426614174000", "estimatedQuantity": "5000" } ] } ``` **Response** ```json { "payload": { "results": [ { "performanceObligationId": "string", "status": "UPDATED", "estimatedQuantity": "string", "reason": "NOT_FOUND", "message": "string" } ] }, "success": true, "message": "string", "error": { "code": 1.1, "message": "string", "details": {} } } ``` **SDK Code** ```python import requests url = "https://integrators.prod.api.tabsplatform.com/v3/performance-obligations/estimates" payload = { "items": [ { "performanceObligationId": "123e4567-e89b-12d3-a456-426614174000", "estimatedQuantity": "5000" } ] } headers = { "Authorization": "", "Content-Type": "application/json" } response = requests.post(url, json=payload, headers=headers) print(response.json()) ``` ```javascript const url = 'https://integrators.prod.api.tabsplatform.com/v3/performance-obligations/estimates'; const options = { method: 'POST', headers: {Authorization: '', 'Content-Type': 'application/json'}, body: '{"items":[{"performanceObligationId":"123e4567-e89b-12d3-a456-426614174000","estimatedQuantity":"5000"}]}' }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://integrators.prod.api.tabsplatform.com/v3/performance-obligations/estimates" payload := strings.NewReader("{\n \"items\": [\n {\n \"performanceObligationId\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"estimatedQuantity\": \"5000\"\n }\n ]\n}") req, _ := http.NewRequest("POST", url, payload) req.Header.Add("Authorization", "") req.Header.Add("Content-Type", "application/json") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://integrators.prod.api.tabsplatform.com/v3/performance-obligations/estimates") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Post.new(url) request["Authorization"] = '' request["Content-Type"] = 'application/json' request.body = "{\n \"items\": [\n {\n \"performanceObligationId\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"estimatedQuantity\": \"5000\"\n }\n ]\n}" response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.post("https://integrators.prod.api.tabsplatform.com/v3/performance-obligations/estimates") .header("Authorization", "") .header("Content-Type", "application/json") .body("{\n \"items\": [\n {\n \"performanceObligationId\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"estimatedQuantity\": \"5000\"\n }\n ]\n}") .asString(); ``` ```php request('POST', 'https://integrators.prod.api.tabsplatform.com/v3/performance-obligations/estimates', [ 'body' => '{ "items": [ { "performanceObligationId": "123e4567-e89b-12d3-a456-426614174000", "estimatedQuantity": "5000" } ] }', 'headers' => [ 'Authorization' => '', 'Content-Type' => 'application/json', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://integrators.prod.api.tabsplatform.com/v3/performance-obligations/estimates"); var request = new RestRequest(Method.POST); request.AddHeader("Authorization", ""); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{\n \"items\": [\n {\n \"performanceObligationId\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"estimatedQuantity\": \"5000\"\n }\n ]\n}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = [ "Authorization": "", "Content-Type": "application/json" ] let parameters = ["items": [ [ "performanceObligationId": "123e4567-e89b-12d3-a456-426614174000", "estimatedQuantity": "5000" ] ]] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://integrators.prod.api.tabsplatform.com/v3/performance-obligations/estimates")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "POST" request.allHTTPHeaderFields = headers request.httpBody = postData as Data let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```