Skip to navigation

Replace EBITDA add-back selections

Replaces the add-back selection set for one company scope on the loan; other scopes are untouched. The scope comes from the entity_key query parameter (absent means the whole-loan scope); entity_key in the body is ignored and added_by is null in the response. Limits: at most 100 selections; key and label at most 512 characters; source is stmt_expense, stmt_income or write_in; years is 1 to 24 distinct four-digit labels; write-in amounts are non-zero and at most 9,999,999,999,999 per year. A concurrent write to the same scope answers 409.

Requires the extractions:write scope. Rate limit: 200 requests per minute per key (the api lane).

Authentication

AuthorizationBearer

Bearer token. Use ss_live_… for live data or ss_test_… for the sandbox (test mode). See Authentication.

Path parameters

borrower_idstringRequired
The borrower's id.

Headers

Idempotency-KeystringOptional<=255 characters

Idempotency token. Retries that reuse the key within 24h replay the original response. Up to 255 characters; a UUID is typical. See Idempotency.

SpreadSpace-VersionstringOptionalformat: "^\d{4}-\d{2}-\d{2}$"

Pin the API version, e.g. 2026-10-07. Omit to get the latest. See Versioning.

Query parameters

loan_idstringRequired
The loan's id. Required.
entity_keystringOptional

The company scope (business:<folded name> or person:<folded name>, at most 256 characters). Omit for the whole-loan scope.

Request

This endpoint expects an object.
selectionslist of objectsRequired

Response headers

X-Request-IDstringOptional
Correlation ID for this request. Quote it in support tickets.
Idempotency-Replayboolean

Set to true when the response is replayed from the idempotency cache for a request that re-presented an Idempotency-Key it had already used. Absent on the original (winner) response. A replay repeats the original status and body. When the original could not be stored (an unhandled server fault, or a body over the 1 MiB replay cap) the replay is an error envelope that says so; the operation is never re-run under the same key.

SpreadSpace-VersionstringOptional

The API surface version the server resolved for this request. Always present, regardless of whether the client supplied the request-side SpreadSpace-Version header. Default: 2026-10-07.

RateLimit-Limitinteger

Request budget of the endpoint’s rate-limit policy per 60-second sliding window. See Rate limits.

RateLimit-Remaininginteger

Requests left in the current window. Suppressed on 429 responses produced outside the rate limiter (for example a usage throttle), where a remaining budget would be misleading.

RateLimit-Resetinteger

Seconds until a guaranteed-fresh window.

RateLimit-PolicystringOptional

The active policy in limit;w=window-seconds form.

Response

OK
selectionslist of objects

Errors

400
Bad Request Error
401
Unauthorized Error
402
Payment Required Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
423
Locked Error
429
Too Many Requests Error
500
Internal Server Error