Xác nhận đã đọc thông báo
Confirms that the signed-in member has read one announcement (announcement_id from list_my_announcements); the sender sees the confirmation. Call it only after the user has read it and agrees to confirm. Repeating it changes nothing.
Tham số (3)
| Tên | Kiểu | Mô tả |
|---|
announcement_idbắt buộc | string | id from list_my_announcements. |
organization_id | string | Tổ chức thực hiện. Bắt buộc khi kết nối có nhiều tổ chức; lấy từ get_my_context. |
idempotency_key | string | Khoá chống lặp tuỳ chọn: gọi lại cùng khoá không tạo bản ghi thứ hai. |
Hỏi về phiếu lương
Raises a question about one of the signed-in member's payslips for whoever runs payroll: optionally which line (payslip_item_id from get_my_payslip) and the reason in the user's words (at least 5 characters). It does not change the payslip and does not stop the member from confirming it.
Tham số (5)
| Tên | Kiểu | Mô tả |
|---|
payslip_idbắt buộc | string | id from list_my_payslips. |
reasonbắt buộc | string | What looks wrong, in the user's words. |
payslip_item_id | string | The line in question, from get_my_payslip; leave out for the payslip as a whole. |
organization_id | string | Tổ chức thực hiện. Bắt buộc khi kết nối có nhiều tổ chức; lấy từ get_my_context. |
idempotency_key | string | Khoá chống lặp tuỳ chọn: gọi lại cùng khoá không tạo bản ghi thứ hai. |
Rút yêu cầu tạm ứng
Withdraws one of the signed-in member's salary advance requests that is still pending (advance_id from list_my_advances); the request is deleted. An advance already approved or paid cannot be withdrawn here.
Tham số (3)
| Tên | Kiểu | Mô tả |
|---|
advance_idbắt buộc | string | id from list_my_advances. |
organization_id | string | Tổ chức thực hiện. Bắt buộc khi kết nối có nhiều tổ chức; lấy từ get_my_context. |
idempotency_key | string | Khoá chống lặp tuỳ chọn: gọi lại cùng khoá không tạo bản ghi thứ hai. |
Rút đơn nghỉ phép
Withdraws one of the signed-in member's leave requests by id (from list_my_leave). A pending request is deleted; an approved request that has not started yet is cancelled and its days go back to the balance. Leave that has already started cannot be withdrawn here.
Tham số (3)
| Tên | Kiểu | Mô tả |
|---|
leave_request_idbắt buộc | string | id of the request, from list_my_leave. |
organization_id | string | Tổ chức thực hiện. Bắt buộc khi kết nối có nhiều tổ chức; lấy từ get_my_context. |
idempotency_key | string | Khoá chống lặp tuỳ chọn: gọi lại cùng khoá không tạo bản ghi thứ hai. |
Xác nhận phiếu lương
Records that the signed-in member agrees with one of their released payslips (payslip_id from list_my_payslips). It can be done once and only by the payslip's owner. Show the user the net pay and lines first and call it only on their explicit agreement; to dispute a line use ask_about_payslip.
Tham số (3)
| Tên | Kiểu | Mô tả |
|---|
payslip_idbắt buộc | string | id from list_my_payslips. |
organization_id | string | Tổ chức thực hiện. Bắt buộc khi kết nối có nhiều tổ chức; lấy từ get_my_context. |
idempotency_key | string | Khoá chống lặp tuỳ chọn: gọi lại cùng khoá không tạo bản ghi thứ hai. |
Gửi đơn điều chỉnh ca
Asks the approver to correct one past day of the signed-in member's attendance: late_in or early_out (with cause permission or mispunch) to excuse it, forgot (missing in, out or both, with the real times) to add a punch, or undo_out to reopen a check-out made by mistake. To ask for a shift on a day use save_schedule_proposal instead.
Tham số (10)
| Tên | Kiểu | Mô tả |
|---|
typebắt buộc | string | Giá trị: late_inearly_outforgotundo_out |
datebắt buộc | string | The day, YYYY-MM-DD, today or earlier. |
reasonbắt buộc | string | Why, in the user's words. |
cause | string | For late_in / early_out: permission (agreed beforehand) or mispunch (punched wrong). Giá trị: permissionmispunch |
missing | string | For forgot: which punch is missing. Giá trị: inoutboth |
actual_in | string | For forgot with missing in/both: real arrival HH:MM. |
actual_out | string | For forgot with missing out/both: real departure HH:MM. |
shift_assignment_id | string | Which shift of the day, when it had several (ids from get_my_schedule). |
organization_id | string | Tổ chức thực hiện. Bắt buộc khi kết nối có nhiều tổ chức; lấy từ get_my_context. |
idempotency_key | string | Khoá chống lặp tuỳ chọn: gọi lại cùng khoá không tạo bản ghi thứ hai. |
Gửi đơn nghỉ phép
Files a leave request for the signed-in member, from date_from to date_to, for whole days or for a time range on one day (time_from + time_to). Only working days count against the balance; the request goes to the usual approver as pending. Confirm the type, dates and reason with the user before calling.
Tham số (8)
| Tên | Kiểu | Mô tả |
|---|
typebắt buộc | string | Kind of leave; annual spends the balance. The types the organization allows are in get_my_overview (leave_options). Giá trị: annualsickunpaidmarriagechild_marriagebereavementmaternitychild_sickcompensatory |
date_frombắt buộc | string | First day, YYYY-MM-DD. |
date_tobắt buộc | string | Last day, YYYY-MM-DD (same as date_from for one day). |
reasonbắt buộc | string | Why, in the user's words. |
time_from | string | Optional HH:MM start of a part-day leave (one day only, with time_to). |
time_to | string | Optional HH:MM end of a part-day leave. |
organization_id | string | Tổ chức thực hiện. Bắt buộc khi kết nối có nhiều tổ chức; lấy từ get_my_context. |
idempotency_key | string | Khoá chống lặp tuỳ chọn: gọi lại cùng khoá không tạo bản ghi thứ hai. |
Xoá lịch trình cá nhân
Deletes one of the signed-in member's personal reminders (reminder_id from list_my_reminders). It cannot be undone.
Tham số (3)
| Tên | Kiểu | Mô tả |
|---|
reminder_idbắt buộc | string | id from list_my_reminders. |
organization_id | string | Tổ chức thực hiện. Bắt buộc khi kết nối có nhiều tổ chức; lấy từ get_my_context. |
idempotency_key | string | Khoá chống lặp tuỳ chọn: gọi lại cùng khoá không tạo bản ghi thứ hai. |
Rút đề xuất lịch ngày
Withdraws one of the signed-in member's schedule proposals that is still pending (proposal_id from list_my_schedule_proposals); all of its lines are cancelled. A proposal already decided cannot be withdrawn.
Tham số (3)
| Tên | Kiểu | Mô tả |
|---|
proposal_idbắt buộc | string | proposal_id from list_my_schedule_proposals. |
organization_id | string | Tổ chức thực hiện. Bắt buộc khi kết nối có nhiều tổ chức; lấy từ get_my_context. |
idempotency_key | string | Khoá chống lặp tuỳ chọn: gọi lại cùng khoá không tạo bản ghi thứ hai. |
Đọc thông báo nội bộ
Returns one announcement sent to the signed-in member (announcement_id from list_my_announcements) with its full text, sender and dates. As in the app, reading it marks it opened, and seen when it asks for no confirmation; a required read confirmation is only given with acknowledge_announcement.
Tham số (2)
| Tên | Kiểu | Mô tả |
|---|
announcement_idbắt buộc | string | id from list_my_announcements. |
organization_id | string | Tổ chức thực hiện. Bắt buộc khi kết nối có nhiều tổ chức; lấy từ get_my_context. |
Xem một checklist
Returns one checklist or form assigned to the signed-in member (occurrence_id from list_my_checklists) with its questions (field ids, types, options, which are required) and who is filling it in, or one already submitted (submission_id) with its answers. Questions that need a photo, file or signature can only be answered in the CTAS Work app.
Tham số (3)
| Tên | Kiểu | Mô tả |
|---|
occurrence_id | string | An open checklist, from list_my_checklists. |
submission_id | string | A submitted one, from list_my_checklists with submitted=true. |
organization_id | string | Tổ chức thực hiện. Bắt buộc khi kết nối có nhiều tổ chức; lấy từ get_my_context. |
Xem chấm công của tôi
Returns the signed-in member's attendance for one month: each day's check-in and check-out, late and early minutes, what was excused, worked minutes and status, plus their attendance compliance score when the organization has it on. Read only; checking in or out is only possible in the CTAS Work app.
Tham số (2)
| Tên | Kiểu | Mô tả |
|---|
month | string | YYYY-MM (default this month). |
organization_id | string | Tổ chức thực hiện. Bắt buộc khi kết nối có nhiều tổ chức; lấy từ get_my_context. |
Xem tổng quan của tôi
Returns the signed-in member's CTAS Work overview for today: shifts today and whether they have checked in, this month's worked days and late count, leave balance, the current pay estimate, their pending requests, upcoming reminders and the organization's plan state. Set with_workplace to also get the organization's contact details, colleagues and holidays this year.
Tham số (2)
| Tên | Kiểu | Mô tả |
|---|
with_workplace | boolean | Also return the organization's contacts, colleagues and holidays (default false). |
organization_id | string | Tổ chức thực hiện. Bắt buộc khi kết nối có nhiều tổ chức; lấy từ get_my_context. |
Xem lương tạm tính
Returns the signed-in member's estimated pay in VND for a month whose payslip has not been released yet (default this month): gross, net and the lines behind them, as earned so far, or with projected=true as it would be if every remaining scheduled day is worked. Once the payslip is released this answers NOT_FOUND; use get_my_payslip then.
Tham số (3)
| Tên | Kiểu | Mô tả |
|---|
month | string | YYYY-MM (default this month). |
projected | boolean | Project to the end of the month (default false: earned so far). |
organization_id | string | Tổ chức thực hiện. Bắt buộc khi kết nối có nhiều tổ chức; lấy từ get_my_context. |
Xem chi tiết phiếu lương
Returns one of the signed-in member's payslips by id (from list_my_payslips): every line (earnings, allowances, overtime, deductions, insurance, tax, advances) with its amount in VND, the net pay, the period and the timeline of closing, confirmation, approval and payment.
Tham số (2)
| Tên | Kiểu | Mô tả |
|---|
payslip_idbắt buộc | string | id from list_my_payslips. |
organization_id | string | Tổ chức thực hiện. Bắt buộc khi kết nối có nhiều tổ chức; lấy từ get_my_context. |
Xem lịch làm việc của tôi
Returns the signed-in member's own work calendar from date_from to date_to (at most 62 days, default the next 14 days): for each day the status (worked, late, leave, absent, upcoming shift, day off), the rostered shifts, approved leave and the work credit. A single-day range also returns the expected start and end time of that day. Set with_workplaces for the organization's workplaces.
Tham số (4)
| Tên | Kiểu | Mô tả |
|---|
date_from | string | First day, YYYY-MM-DD (default today, Vietnam time). |
date_to | string | Last day, YYYY-MM-DD, at most 62 days after date_from (default date_from + 13 days). |
with_workplaces | boolean | Also list the organization's workplaces (default false). |
organization_id | string | Tổ chức thực hiện. Bắt buộc khi kết nối có nhiều tổ chức; lấy từ get_my_context. |
Xem đơn điều chỉnh ca của tôi
Lists the signed-in member's attendance adjustment requests (newest first): asking to excuse a late arrival or early leave, a forgotten check-in or check-out, undoing a check-out, or a shift sign-up, with the date, times asked for, reason, status and the approver's note.
Tham số (3)
| Tên | Kiểu | Mô tả |
|---|
limit | integer | Rows per page, 1-50 (default 20). |
cursor | string | next_cursor from the previous page; leave out for the first page. |
organization_id | string | Tổ chức thực hiện. Bắt buộc khi kết nối có nhiều tổ chức; lấy từ get_my_context. |
Xem tạm ứng của tôi
Lists the signed-in member's salary advance requests (newest first) with amount and approved amount in VND, payroll month, status and note, plus the payroll months an advance can be requested against right now and how much is still available on each under the organization's policy.
Tham số (3)
| Tên | Kiểu | Mô tả |
|---|
limit | integer | Rows per page, 1-50 (default 20). |
cursor | string | next_cursor from the previous page; leave out for the first page. |
organization_id | string | Tổ chức thực hiện. Bắt buộc khi kết nối có nhiều tổ chức; lấy từ get_my_context. |
Xem thông báo nội bộ của tôi
Lists announcements the organization has sent to the signed-in member (newest first) with title, summary, sender, sent time, whether a read confirmation is required and whether the member has opened, seen or acknowledged each. Set unseen_only for those not seen yet. Use get_announcement for the full text.
Tham số (4)
| Tên | Kiểu | Mô tả |
|---|
limit | integer | Rows per page, 1-50 (default 20). |
cursor | string | next_cursor from the previous page; leave out for the first page. |
unseen_only | boolean | Only announcements not seen yet (default false). |
organization_id | string | Tổ chức thực hiện. Bắt buộc khi kết nối có nhiều tổ chức; lấy từ get_my_context. |
Xem việc checklist của tôi
Lists the checklists and forms assigned to the signed-in member that are open or open within the next days (default 2, at most 7), ordered by due time, with the form name, opening, due and closing times, status and who is filling it in. With submitted=true it lists what the member has already submitted instead (optionally from date_from to date_to). Use get_checklist for the questions.
Tham số (7)
| Tên | Kiểu | Mô tả |
|---|
limit | integer | Rows per page, 1-50 (default 20). |
cursor | string | next_cursor from the previous page; leave out for the first page. |
days | integer | How many days ahead to look (default 2). |
submitted | boolean | List submitted forms instead of open ones (default false). |
date_from | string | With submitted: from this day, YYYY-MM-DD. |
date_to | string | With submitted: up to this day, YYYY-MM-DD. |
organization_id | string | Tổ chức thực hiện. Bắt buộc khi kết nối có nhiều tổ chức; lấy từ get_my_context. |
Xem việc học của tôi
Lists what the organization has assigned the signed-in member to learn on CTAS Learn: courses with status, progress percent and due date, and topic lessons still to do (with overdue ones), plus counts. Studying happens in CTAS Learn; this only reports where the member stands.
Tham số (3)
| Tên | Kiểu | Mô tả |
|---|
limit | integer | Rows per page, 1-50 (default 20). |
cursor | string | next_cursor from the previous page; leave out for the first page. |
organization_id | string | Tổ chức thực hiện. Bắt buộc khi kết nối có nhiều tổ chức; lấy từ get_my_context. |
Xem đơn nghỉ phép của tôi
Lists the signed-in member's leave requests (newest first) with type, dates, days or hours, status and the approver's note, plus their remaining leave balance and the leave policy that applies to them. Set with_ledger for the balance history (accruals, usage, adjustments).
Tham số (4)
| Tên | Kiểu | Mô tả |
|---|
limit | integer | Rows per page, 1-50 (default 20). |
cursor | string | next_cursor from the previous page; leave out for the first page. |
with_ledger | boolean | Also return the balance history rows (default false). |
organization_id | string | Tổ chức thực hiện. Bắt buộc khi kết nối có nhiều tổ chức; lấy từ get_my_context. |
Xem phiếu lương của tôi
Lists the signed-in member's payslips that have been released to them (newest first) with the month, net pay in VND and status (closed, confirmed, approved, paid), plus the payroll months available to them. Use get_my_payslip for the lines of one payslip and get_my_pay_estimate for the current month.
Tham số (4)
| Tên | Kiểu | Mô tả |
|---|
limit | integer | Rows per page, 1-50 (default 20). |
cursor | string | next_cursor from the previous page; leave out for the first page. |
year | integer | Only payslips of this year. |
organization_id | string | Tổ chức thực hiện. Bắt buộc khi kết nối có nhiều tổ chức; lấy từ get_my_context. |
Xem lịch trình cá nhân
Lists the signed-in member's personal reminders in CTAS Work, ordered by date and time: those of one month (default this month), or with upcoming=true everything from today on. Each has a title, note, date, optional start and end time, whether it is important and when the phone notifies.
Tham số (5)
| Tên | Kiểu | Mô tả |
|---|
limit | integer | Rows per page, 1-50 (default 20). |
cursor | string | next_cursor from the previous page; leave out for the first page. |
month | string | YYYY-MM (default this month). |
upcoming | boolean | Everything from today on instead of one month (default false). |
organization_id | string | Tổ chức thực hiện. Bắt buộc khi kết nối có nhiều tổ chức; lấy từ get_my_context. |
Xem thưởng của tôi
Lists the bonuses the signed-in member has earned under the organization's reward rules (newest first): label, what earned it, amount in VND, payroll month it is paid with and status, plus the total and this month's total.
Tham số (3)
| Tên | Kiểu | Mô tả |
|---|
limit | integer | Rows per page, 1-50 (default 20). |
cursor | string | next_cursor from the previous page; leave out for the first page. |
organization_id | string | Tổ chức thực hiện. Bắt buộc khi kết nối có nhiều tổ chức; lấy từ get_my_context. |
Xem đề xuất lịch của tôi
Lists the signed-in member's schedule proposals (asking to add, replace or remove shifts on a day) for days from date_from to date_to (default this month, at most 93 days): pending ones and those decided in the last 60 days, with each line, status and approver note. Set with_options to get the shift templates and workplaces a proposal can use.
Tham số (6)
| Tên | Kiểu | Mô tả |
|---|
limit | integer | Rows per page, 1-50 (default 20). |
cursor | string | next_cursor from the previous page; leave out for the first page. |
date_from | string | First day, YYYY-MM-DD (default first of this month). |
date_to | string | Last day, YYYY-MM-DD (default end of this month). |
with_options | boolean | Also return shift templates and workplaces (default false). |
organization_id | string | Tổ chức thực hiện. Bắt buộc khi kết nối có nhiều tổ chức; lấy từ get_my_context. |
Xem thắc mắc về phiếu lương
Lists the questions the signed-in member has raised about one of their payslips (payslip_id from list_my_payslips): which line, the reason given, whether it is open or resolved and the resolution note from whoever runs payroll.
Tham số (4)
| Tên | Kiểu | Mô tả |
|---|
payslip_idbắt buộc | string | id from list_my_payslips. |
limit | integer | Rows per page, 1-50 (default 20). |
cursor | string | next_cursor from the previous page; leave out for the first page. |
organization_id | string | Tổ chức thực hiện. Bắt buộc khi kết nối có nhiều tổ chức; lấy từ get_my_context. |
Xin tạm ứng lương
Files a salary advance request for the signed-in member: amount in whole VND, the reason, and optionally the payroll month (YYYY-MM) it is taken against, one of the periods from list_my_advances. The organization's limits are checked; the request goes to approvers as pending. It does not transfer any money.
Tham số (5)
| Tên | Kiểu | Mô tả |
|---|
amountbắt buộc | integer | Whole VND. |
reasonbắt buộc | string | Why, in the user's words. |
payroll_month | string | YYYY-MM from list_my_advances periods (default: the default period). |
organization_id | string | Tổ chức thực hiện. Bắt buộc khi kết nối có nhiều tổ chức; lấy từ get_my_context. |
idempotency_key | string | Khoá chống lặp tuỳ chọn: gọi lại cùng khoá không tạo bản ghi thứ hai. |
Lưu lịch trình cá nhân
Adds a personal reminder for the signed-in member in CTAS Work, or changes one when reminder_id is given (only the fields passed change). A reminder has a title, a date, an optional start and end time (HH:MM), an optional note, an important flag and an optional remind_at instant for the phone to notify. Private to the member.
Tham số (10)
| Tên | Kiểu | Mô tả |
|---|
reminder_id | string | Only to change an existing reminder, from list_my_reminders. |
title | string | Required for a new reminder. |
date | string | YYYY-MM-DD; required for a new reminder. |
time | string | HH:MM start; leave out for all day. |
end_time | string | HH:MM end, after time. |
note | string | |
important | boolean | |
remind_at | string | ISO 8601 with offset (Vietnam is +07:00) for the phone to notify. |
organization_id | string | Tổ chức thực hiện. Bắt buộc khi kết nối có nhiều tổ chức; lấy từ get_my_context. |
idempotency_key | string | Khoá chống lặp tuỳ chọn: gọi lại cùng khoá không tạo bản ghi thứ hai. |
Gửi đề xuất lịch ngày
Files the signed-in member's schedule proposal for one day (up to 62 days ahead) as a list of lines: add a shift (a shift_template_id or starts_at/ends_at), replace or remove a rostered shift (replaces_assignment_id from get_my_schedule). Pass proposal_id to rewrite a proposal that is still pending. Shift templates and workplaces come from list_my_schedule_proposals with with_options.
Tham số (6)
| Tên | Kiểu | Mô tả |
|---|
datebắt buộc | string | The day, YYYY-MM-DD. |
linesbắt buộc | object[] | |
proposal_id | string | Only to rewrite a pending proposal; leave out to file a new one. |
reason | string | Why, in the user's words. |
organization_id | string | Tổ chức thực hiện. Bắt buộc khi kết nối có nhiều tổ chức; lấy từ get_my_context. |
idempotency_key | string | Khoá chống lặp tuỳ chọn: gọi lại cùng khoá không tạo bản ghi thứ hai. |
Nộp checklist
Submits the signed-in member's answers to one open checklist (occurrence_id from list_my_checklists). answers maps each field id from get_checklist to its value. Fails with CONFLICT when a colleague is filling it in; questions needing a photo, file or signature, and checklists that must be filed on site, can only be done in the CTAS Work app.
Tham số (4)
| Tên | Kiểu | Mô tả |
|---|
occurrence_idbắt buộc | string | id from list_my_checklists. |
answersbắt buộc | object | Field id => answer, as the questions in get_checklist describe. |
organization_id | string | Tổ chức thực hiện. Bắt buộc khi kết nối có nhiều tổ chức; lấy từ get_my_context. |
idempotency_key | string | Khoá chống lặp tuỳ chọn: gọi lại cùng khoá không tạo bản ghi thứ hai. |