Skip to main content
POST
Sell stock

Authorizations

X-API-Key
string
header
default:your_tyms_sk_or_partner_key
required

Business secret tyms_sk_... for business-scoped routes. Partner secret for register-business and referred-business distributor routes.

Body

application/json
date
string<date>
required
items
object[]
required
Minimum array length: 1
payment_category
string
required

Cash or bank name received into.

amount_paid
number
required
currency
string
customer
string
document_number
string

Returned as receipt_no.

narration
string
is_prepayment
boolean

Set true (or 1) to create a prepaid_income record (unearned revenue). The income is deferred and recognized monthly over prepayment_duration.

prepayment_duration
integer

Number of months to recognize the prepaid income over. Required when is_prepayment is true.

prepayment_account
string

Liability account name (unearned revenue) for the deferred balance. Defaults to the business unearned revenue account.

Response

Sale document created

status
string
required
Example:

"success"

message
string
required
data
any

Single resource, array of resources, statement sections, or async job metadata — see each operation's example.

meta
object

Pagination (page, limit, total) and/or report range (from, to). Cash flow may include previous_period_end.