Skip to content

Create My Service Statement

POST
/marketplace/me/service-statements

Open a draft statement for one of your engagements.

THE PERIOD IS SERVER-DERIVED and any you send is ignored: an active engagement bills the previous complete calendar month, a terminated one bills its earliest unbilled month. The retainer is PRORATED to the days the engagement was actually live, and the meeting lines are generated from the engagement’s own rate, so amount is the sum of the lines and never a typed figure. Add commission / bonus / expense / discount lines, then submit.

409 when a statement already exists for that period. 403 on an agency-managed engagement - the agency authors those.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Open a draft statement for one engagement.

period_start / period_end / amount are accepted for parity with the app model and IGNORED by it. The billing period is derived server-side (the previous complete calendar month, or a terminated engagement’s earliest unbilled month) so nobody can pick a window that mis-prorates the retainer, and the amount is the sum of the statement’s line items. They are documented as ignored rather than dropped from the contract, because dropping a field the app model declares is what makes a proxy 500 on a required one.

object
activities
Any of:
object
key
additional properties
any
amount
Any of:
number
currency
string
default: USD <= 3 characters
engagement_id
required

The hiring/engagement to bill. Must be your own.

string
period_end
Any of:
string format: date
period_start
Any of:
string format: date
summary
Any of:
string

Responses

201

Successful Response

object
data
required

One record, or one action result.

object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string