Skip to content
Trusty Sweep Developers

A revenue discrepancy was opened

POST

Delivered as a CloudEvents 1.0 envelope whose data is a RevenueItem. Batched ≤ 20 per delivery as a JSON array; signed with Sweep-Signature.

Request Body

Section titled “Request Body”
Media typeapplication/json
Array
object
specversion
required
string
Allowed values: 1.0
id
required

Prefixed ULID (evt_…)

string
/^evt_[0-9A-HJKMNP-TV-Z]{26}$/
source
required

Https://api.trustysweep.com

string
type
required

Event type from events.json, e.g. sweep.execution.completed

string
time
required
string format: date-time
subject

Primary resource id

string
datacontenttype
string
Allowed values: application/json
data
required
object
key
additional properties
sweepsimulated

CloudEvents extension: true in developer test mode.

boolean
type
required
Allowed value: sweep.creator.discrepancy.opened
data
required
object
id
required

Prefixed ULID (rev_…)

string
/^rev_[0-9A-HJKMNP-TV-Z]{26}$/
creator_source_id
required

Prefixed ULID (crs_…)

string
/^crs_[0-9A-HJKMNP-TV-Z]{26}$/
period
required
object
start
required
string format: date-time
end
required
string format: date-time
label
string
currency
required
string
gross_cents
One of:
integer
fees_cents
integer
adjustments_cents
integer
withholding_cents
integer
expected_cents
One of:
integer
reported_cents
One of:
integer
scheduled_cents
One of:
integer
settled_cents
One of:
integer
variance_cents
One of:
integer
confidence
required
number
evidence_level
required

CONFIRMED = direct platform/API/settlement evidence; DETECTED = reliable statement/email/invoice evidence; ESTIMATED = calculation from observable rates or incomplete evidence. An estimate is never presented as confirmed.

string
Allowed values: CONFIRMED DETECTED ESTIMATED
evidence
required
Array<object>
object
kind
required
string
Allowed values: email statement api invoice contract receipt user derived
ref
required
string
sourceId
string
observedAt
required
string format: date-time
excerpt
string
<= 300 characters
calculation_version
required
string
state
required
string
Allowed values: OBSERVED_EARNING_SIGNAL NORMALIZED_REVENUE_ITEM EXPECTED_AMOUNT_CALCULATED REPORTED_AMOUNT_RECORDED ADJUSTMENTS_APPLIED PAYOUT_SCHEDULED SETTLEMENT_OBSERVED RECONCILED DISCREPANCY_OPEN EVIDENCE_UPDATED REVIEW_REQUIRED
updated_at
required
string format: date-time

Responses

Section titled “Responses”

200

Section titled “200”

Acknowledge with any 2xx within 10 seconds