Skip to main content
POST
/
create
/
income
Create income
curl --request POST \
  --url https://staging-api.usetyms.com/v1/adam/create/income \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "date": "2026-03-04",
  "currency": "NGN",
  "document_number": "RCT-881",
  "narration": "Walk-in sale — March 4",
  "customer": "a1b2c3d4e5f6478990a1b2c3d4e5f678",
  "payment_category": "Cash on Hand",
  "amount_paid": 75000,
  "items": [
    {
      "item_name": "Consulting package",
      "quantity": 1,
      "selling_price": 75000,
      "category": "Service Income",
      "tax": 7.5
    }
  ]
}
'
import requests

url = "https://staging-api.usetyms.com/v1/adam/create/income"

payload = {
"date": "2026-03-04",
"currency": "NGN",
"document_number": "RCT-881",
"narration": "Walk-in sale — March 4",
"customer": "a1b2c3d4e5f6478990a1b2c3d4e5f678",
"payment_category": "Cash on Hand",
"amount_paid": 75000,
"items": [
{
"item_name": "Consulting package",
"quantity": 1,
"selling_price": 75000,
"category": "Service Income",
"tax": 7.5
}
]
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
date: '2026-03-04',
currency: 'NGN',
document_number: 'RCT-881',
narration: 'Walk-in sale — March 4',
customer: 'a1b2c3d4e5f6478990a1b2c3d4e5f678',
payment_category: 'Cash on Hand',
amount_paid: 75000,
items: [
{
item_name: 'Consulting package',
quantity: 1,
selling_price: 75000,
category: 'Service Income',
tax: 7.5
}
]
})
};

fetch('https://staging-api.usetyms.com/v1/adam/create/income', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
{
  "status": "success",
  "message": "Income imported successfully",
  "data": [
    {
      "uuid": "d3e4f5a6b7c8428290a1b2c3d4e5f6e4",
      "transaction_type": "sales_receipt",
      "status": "paid",
      "receipt_no": "RCT-881"
    }
  ]
}
{
"status": "failed",
"message": "<string>"
}

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

Response

Income 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.