← Kết nối trợ lý AI

Công cụ CTAS Work

153 công cụ của máy chủ https://api.ctas.vn/mcp/work. Danh sách sinh từ chính máy chủ. Trợ lý chỉ thấy công cụ hợp với quyền truy cập bạn đã cho phép và vai trò của bạn trong tổ chức. Mô tả viết bằng tiếng Anh vì đó là chữ mô hình AI đọc; tên tiếng Việt là chữ bạn thấy khi trợ lý xin phép.

Đọc chỉ xem, không đổi dữ liệuGhi cần quyền thêm và sửaNhạy cảm xem trước rồi xác nhận

Chung · 7

Gửi yêu cầu hỗ trợ

Opens a support ticket with the CTAS support team for the signed-in user, about the organization of the call: a category (from search_help), a subject and a description of the problem in the user's words. Text only; files and screenshots can be attached in the CTAS Work app. Try search_help first and confirm the text with the user.

Tham số (6)
TênKiểuMô tả
categorybắt buộcstring Giá trị: accountattendancescheduleleavepayrollbillingbugother
subjectbắt buộcstring
bodybắt buộcstringWhat happened, in the user's words.
contact_phonestringOptional phone to call back on (default: the account's).
organization_idstringTổ 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_keystringKhoá chống lặp tuỳ chọn: gọi lại cùng khoá không tạo bản ghi thứ hai.

Xem ngữ cảnh của tôi

Returns the signed-in CTAS user, the current date and time in Vietnam (Asia/Ho_Chi_Minh), the scopes of this connection and, for CTAS Work, every organization in the connection with the user's role, permissions and whether the connection can be used there. Call it once at the start of a conversation and reuse the answer.

Xem thông báo của tôi

Lists the signed-in member's CTAS Work notifications in the organization (newest first): title and text in the user's language, what they are about, and whether each is read, plus the unread counts. Set counts_only for just the unread counts.

Tham số (4)
TênKiểuMô tả
limitintegerRows per page, 1-50 (default 20).
cursorstringnext_cursor from the previous page; leave out for the first page.
counts_onlybooleanOnly the unread counts (default false).
organization_idstringTổ 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 yêu cầu hỗ trợ của tôi

Lists the signed-in user's support tickets with CTAS (latest activity first) with code, subject, category, status and whether there is an unread answer; status=active for the ones still open or answered. With ticket_id it returns that one ticket with the whole conversation, which also marks the answer as read.

Tham số (4)
TênKiểuMô tả
limitintegerRows per page, 1-50 (default 20).
cursorstringnext_cursor from the previous page; leave out for the first page.
statusstringOnly tickets in this state. Giá trị: activeopenansweredresolvedclosed
ticket_idstringOne ticket with its messages instead of the list.

Đánh dấu thông báo đã đọc

Marks the signed-in member's CTAS Work notifications as read: the given notification_ids (up to 50, from list_notifications), or with all=true every unread one in the organization. Returns the unread counts afterwards.

Tham số (4)
TênKiểuMô tả
notification_idsstring[]ids from list_notifications.
allbooleanMark every unread notification in the organization read.
organization_idstringTổ 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_keystringKhoá chống lặp tuỳ chọn: gọi lại cùng khoá không tạo bản ghi thứ hai.

Trả lời yêu cầu hỗ trợ

Adds the signed-in user's reply to one of their support tickets (ticket_id from list_support_tickets), and with close=true closes the ticket afterwards, or closes it without a reply when body is left out. Closed tickets take no replies. Text only.

Tham số (4)
TênKiểuMô tả
ticket_idbắt buộcstringid from list_support_tickets.
bodystringThe reply, in the user's words.
closebooleanClose the ticket (after the reply, if any).
idempotency_keystringKhoá chống lặp tuỳ chọn: gọi lại cùng khoá không tạo bản ghi thứ hai.

Tìm trong trợ giúp

Searches the CTAS Work help centre's frequently asked questions (how to check in, request leave, read a payslip, manage the plan...) and returns matching questions with their answers in the user's language, plus the help categories and the support email. Leave query out to list them all.

Tham số (3)
TênKiểuMô tả
querystringWords to look for, with or without Vietnamese accents.
limitintegerRows per page, 1-50 (default 20).
cursorstringnext_cursor from the previous page; leave out for the first page.

Của tôi · 31

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ênKiểuMô tả
announcement_idbắt buộcstringid from list_my_announcements.
organization_idstringTổ 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_keystringKhoá 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ênKiểuMô tả
payslip_idbắt buộcstringid from list_my_payslips.
reasonbắt buộcstringWhat looks wrong, in the user's words.
payslip_item_idstringThe line in question, from get_my_payslip; leave out for the payslip as a whole.
organization_idstringTổ 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_keystringKhoá chống lặp tuỳ chọn: gọi lại cùng khoá không tạo bản ghi thứ hai.
cancel_advanceGhiXoá / huỷ

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ênKiểuMô tả
advance_idbắt buộcstringid from list_my_advances.
organization_idstringTổ 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_keystringKhoá chống lặp tuỳ chọn: gọi lại cùng khoá không tạo bản ghi thứ hai.
cancel_leave_requestGhiXoá / huỷ

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ênKiểuMô tả
leave_request_idbắt buộcstringid of the request, from list_my_leave.
organization_idstringTổ 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_keystringKhoá 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ênKiểuMô tả
payslip_idbắt buộcstringid from list_my_payslips.
organization_idstringTổ 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_keystringKhoá 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ênKiểuMô tả
typebắt buộcstring Giá trị: late_inearly_outforgotundo_out
datebắt buộcstringThe day, YYYY-MM-DD, today or earlier.
reasonbắt buộcstringWhy, in the user's words.
causestringFor late_in / early_out: permission (agreed beforehand) or mispunch (punched wrong). Giá trị: permissionmispunch
missingstringFor forgot: which punch is missing. Giá trị: inoutboth
actual_instringFor forgot with missing in/both: real arrival HH:MM.
actual_outstringFor forgot with missing out/both: real departure HH:MM.
shift_assignment_idstringWhich shift of the day, when it had several (ids from get_my_schedule).
organization_idstringTổ 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_keystringKhoá 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ênKiểuMô tả
typebắt buộcstringKind 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ộcstringFirst day, YYYY-MM-DD.
date_tobắt buộcstringLast day, YYYY-MM-DD (same as date_from for one day).
reasonbắt buộcstringWhy, in the user's words.
time_fromstringOptional HH:MM start of a part-day leave (one day only, with time_to).
time_tostringOptional HH:MM end of a part-day leave.
organization_idstringTổ 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_keystringKhoá chống lặp tuỳ chọn: gọi lại cùng khoá không tạo bản ghi thứ hai.
delete_my_reminderGhiXoá / huỷ

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ênKiểuMô tả
reminder_idbắt buộcstringid from list_my_reminders.
organization_idstringTổ 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_keystringKhoá 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ênKiểuMô tả
proposal_idbắt buộcstringproposal_id from list_my_schedule_proposals.
organization_idstringTổ 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_keystringKhoá 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ênKiểuMô tả
announcement_idbắt buộcstringid from list_my_announcements.
organization_idstringTổ 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ênKiểuMô tả
occurrence_idstringAn open checklist, from list_my_checklists.
submission_idstringA submitted one, from list_my_checklists with submitted=true.
organization_idstringTổ 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ênKiểuMô tả
monthstringYYYY-MM (default this month).
organization_idstringTổ 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ênKiểuMô tả
with_workplacebooleanAlso return the organization's contacts, colleagues and holidays (default false).
organization_idstringTổ 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ênKiểuMô tả
monthstringYYYY-MM (default this month).
projectedbooleanProject to the end of the month (default false: earned so far).
organization_idstringTổ 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ênKiểuMô tả
payslip_idbắt buộcstringid from list_my_payslips.
organization_idstringTổ 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ênKiểuMô tả
date_fromstringFirst day, YYYY-MM-DD (default today, Vietnam time).
date_tostringLast day, YYYY-MM-DD, at most 62 days after date_from (default date_from + 13 days).
with_workplacesbooleanAlso list the organization's workplaces (default false).
organization_idstringTổ 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ênKiểuMô tả
limitintegerRows per page, 1-50 (default 20).
cursorstringnext_cursor from the previous page; leave out for the first page.
organization_idstringTổ 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ênKiểuMô tả
limitintegerRows per page, 1-50 (default 20).
cursorstringnext_cursor from the previous page; leave out for the first page.
organization_idstringTổ 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ênKiểuMô tả
limitintegerRows per page, 1-50 (default 20).
cursorstringnext_cursor from the previous page; leave out for the first page.
unseen_onlybooleanOnly announcements not seen yet (default false).
organization_idstringTổ 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ênKiểuMô tả
limitintegerRows per page, 1-50 (default 20).
cursorstringnext_cursor from the previous page; leave out for the first page.
daysintegerHow many days ahead to look (default 2).
submittedbooleanList submitted forms instead of open ones (default false).
date_fromstringWith submitted: from this day, YYYY-MM-DD.
date_tostringWith submitted: up to this day, YYYY-MM-DD.
organization_idstringTổ 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ênKiểuMô tả
limitintegerRows per page, 1-50 (default 20).
cursorstringnext_cursor from the previous page; leave out for the first page.
organization_idstringTổ 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ênKiểuMô tả
limitintegerRows per page, 1-50 (default 20).
cursorstringnext_cursor from the previous page; leave out for the first page.
with_ledgerbooleanAlso return the balance history rows (default false).
organization_idstringTổ 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ênKiểuMô tả
limitintegerRows per page, 1-50 (default 20).
cursorstringnext_cursor from the previous page; leave out for the first page.
yearintegerOnly payslips of this year.
organization_idstringTổ 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ênKiểuMô tả
limitintegerRows per page, 1-50 (default 20).
cursorstringnext_cursor from the previous page; leave out for the first page.
monthstringYYYY-MM (default this month).
upcomingbooleanEverything from today on instead of one month (default false).
organization_idstringTổ 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ênKiểuMô tả
limitintegerRows per page, 1-50 (default 20).
cursorstringnext_cursor from the previous page; leave out for the first page.
organization_idstringTổ 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ênKiểuMô tả
limitintegerRows per page, 1-50 (default 20).
cursorstringnext_cursor from the previous page; leave out for the first page.
date_fromstringFirst day, YYYY-MM-DD (default first of this month).
date_tostringLast day, YYYY-MM-DD (default end of this month).
with_optionsbooleanAlso return shift templates and workplaces (default false).
organization_idstringTổ 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ênKiểuMô tả
payslip_idbắt buộcstringid from list_my_payslips.
limitintegerRows per page, 1-50 (default 20).
cursorstringnext_cursor from the previous page; leave out for the first page.
organization_idstringTổ 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ênKiểuMô tả
amountbắt buộcintegerWhole VND.
reasonbắt buộcstringWhy, in the user's words.
payroll_monthstringYYYY-MM from list_my_advances periods (default: the default period).
organization_idstringTổ 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_keystringKhoá 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ênKiểuMô tả
reminder_idstringOnly to change an existing reminder, from list_my_reminders.
titlestringRequired for a new reminder.
datestringYYYY-MM-DD; required for a new reminder.
timestringHH:MM start; leave out for all day.
end_timestringHH:MM end, after time.
notestring
importantboolean
remind_atstringISO 8601 with offset (Vietnam is +07:00) for the phone to notify.
organization_idstringTổ 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_keystringKhoá 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ênKiểuMô tả
datebắt buộcstringThe day, YYYY-MM-DD.
linesbắt buộcobject[]
proposal_idstringOnly to rewrite a pending proposal; leave out to file a new one.
reasonstringWhy, in the user's words.
organization_idstringTổ 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_keystringKhoá 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ênKiểuMô tả
occurrence_idbắt buộcstringid from list_my_checklists.
answersbắt buộcobjectField id => answer, as the questions in get_checklist describe.
organization_idstringTổ 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_keystringKhoá chống lặp tuỳ chọn: gọi lại cùng khoá không tạo bản ghi thứ hai.

Tổng hợp · 2

Tổng quan tổ chức

Returns the organization's management overview in one call: today's staff and attendance figures, the current payroll period, the to-do board (requests waiting, problems to fix, with counts) and seats and departments used against the plan limits. Start here for questions about how the organization is doing today.

Cần quyền: Vào khu quản trị

Tham số (1)
TênKiểuMô tả
organization_idstringTổ 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.

Việc cần giải quyết

Lists what is waiting for the signed-in manager: leave, adjustment and advance requests to decide, join requests, payslips to verify, advances to pay out and similar, each with a count. Only items the caller's role can act on appear.

Cần quyền: Vào khu quản trị

Tham số (3)
TênKiểuMô tả
limitintegerRows per page, 1-50 (default 20).
cursorstringnext_cursor from the previous page; leave out for the first page.
organization_idstringTổ 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.

Nhân sự · 15

Điều chỉnh số ngày phép

Corrects a staff member's remaining leave days as of a date (not in the future): the ledger records the difference and replays the months after it. The first call returns a preview with the current and the new balance; call again with confirmation_id once the user agrees.

Cần quyền: Sửa nhân sự

Tham số (7)
TênKiểuMô tả
member_idbắt buộcstringStaff member id, from search_staff.
balancebắt buộcnumberLeave days remaining on as_of.
as_ofbắt buộcstringDay that figure is true on, YYYY-MM-DD, today or earlier.
notestringWhy, shown in the ledger.
organization_idstringTổ 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_keystringKhoá chống lặp tuỳ chọn: gọi lại cùng khoá không tạo bản ghi thứ hai.
confirmation_idstringMã xác nhận do lần gọi xem trước trả về; gọi lại với mã này mới thực hiện.

Trao huy hiệu

Awards one of the organization's own badges (badge_id from list_badges) to a staff member, with an optional note and period key for repeating badges (e.g. 2026-11). CTAS badges are earned automatically and cannot be awarded by hand. The member is notified.

Cần quyền: Sửa nhân sự

Tham số (6)
TênKiểuMô tả
member_idbắt buộcstringStaff member id, from search_staff.
badge_idbắt buộcstringBadge id, from list_badges.
notestringWhy, shown with the badge.
period_keystringFor a repeating badge: the period it is for, e.g. 2026-11 or 2026-W45.
organization_idstringTổ 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_keystringKhoá chống lặp tuỳ chọn: gọi lại cùng khoá không tạo bản ghi thứ hai.

Thêm nhân sự

Adds a person to the organization by name and phone, with optional role, department, position, join date and opening leave balance. Pay is not set here: use save_member_terms afterwards. The account activation code is shown to managers in the CTAS Work app only. Confirm the details with the user first.

Cần quyền: Sửa nhân sự

Tham số (18)
TênKiểuMô tả
namebắt buộcstringFull name.
phonebắt buộcstringMobile number; an existing CTAS account with it is reused.
rolestringRole key from list_roles (default staff). You can only give a role whose rights you hold.
department_idstringDepartment id from get_org_structure.
position_idstringPosition id from get_org_structure.
employment_typestring Giá trị: probationofficialseasonalcollab
join_datestringFirst working day, YYYY-MM-DD (default today).
term_namestringName of the first employment version.
work_arrangement_idstringWork arrangement id from get_org_structure.
default_shift_template_idstringUsual shift template id from get_org_structure.
leave_policy_idstringLeave template id (default: the department's or the organization's).
leave_appliesbooleanfalse if this person earns no paid leave.
holidays_applybooleanfalse if public holidays are not paid days off for them.
leave_balancenumberLeave days they bring from before CTAS; leave out for a new hire.
leave_balance_as_ofstringDay that balance is true on.
leave_balance_notestring
organization_idstringTổ 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_keystringKhoá chống lặp tuỳ chọn: gọi lại cùng khoá không tạo bản ghi thứ hai.
delete_member_termsNhạy cảmXoá / huỷ

Xoá mốc điều khoản làm việc

Deletes one employment version of a staff member (term_id from list_member_terms); the previous version applies again from that day and open payroll is recomputed. The first call returns a preview of the version; call again with confirmation_id once the user agrees.

Cần quyền: Sửa nhân sự

Tham số (5)
TênKiểuMô tả
member_idbắt buộcstringStaff member id, from search_staff.
term_idbắt buộcstringVersion id, from list_member_terms.
organization_idstringTổ 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_keystringKhoá chống lặp tuỳ chọn: gọi lại cùng khoá không tạo bản ghi thứ hai.
confirmation_idstringMã xác nhận do lần gọi xem trước trả về; gọi lại với mã này mới thực hiện.

Xem tình hình học tập của nhân sự

With member_id: a staff member's assigned courses, progress, overdue items, quiz results and certificates from CTAS Learn. Without member_id: the organization's onboarding status for CTAS Learn (whether training is linked and how many staff are enrolled).

Cần quyền: Xem nhân sự

Tham số (2)
TênKiểuMô tả
member_idstringStaff member id, from search_staff.
organization_idstringTổ 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 hồ sơ nhân sự

Returns one staff member's profile: role, department, position, status, work arrangement, default shift, leave policy, and pay when the caller may set pay. Add include for more: terms (employment versions), leave (balance history), badges, learning (training progress).

Cần quyền: Xem nhân sự

Tham số (3)
TênKiểuMô tả
member_idbắt buộcstringStaff member id, from search_staff.
includestring[]Extra parts: terms, leave, badges, learning. Giá trị: termsleavebadgeslearning
organization_idstringTổ 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.

Tạo lời mời tham gia

Creates an invitation code for someone to join the organization, optionally for a named person and phone, a department and a role (default staff), valid 1-90 days (default 7). The invitee enters the code in the CTAS Work app; their join request then waits for approval.

Cần quyền: Mời nhân sự

Tham số (8)
TênKiểuMô tả
namestringInvitee's name, for the list.
phonestringInvitee's phone, for the list.
department_idstringDepartment the invitee joins (get_org_structure).
rolestringRole key from list_roles (default staff).
notestring
expires_in_daysintegerDays the code stays valid (default 7).
organization_idstringTổ 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_keystringKhoá chống lặp tuỳ chọn: gọi lại cùng khoá không tạo bản ghi thứ hai.

Xem huy hiệu

Lists badges. view=catalog (default): the CTAS and organization badges that can be awarded, with id, name, category, tier and status. view=awards: badges given, filtered by member, badge, status or date range. view=summary: award counts per badge, recent awards and the badge settings.

Cần quyền: Xem nhân sự

Tham số (10)
TênKiểuMô tả
viewstring Giá trị: catalogawardssummary
ownerstringcatalog: only the organization's own badges. Giá trị: organization
member_idstringawards: only this staff member.
badge_idstringawards: only this badge.
statusstringcatalog: draft, active or archived. awards: active, expired or revoked.
date_fromstring
date_tostring
limitintegerRows per page, 1-50 (default 20).
cursorstringnext_cursor from the previous page; leave out for the first page.
organization_idstringTổ 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ời mời tham gia

Lists invitations to join the organization with their code, invitee name and phone, department, role, status (active, used, revoked, expired) and expiry. A code only lets the invitee ask to join; the request still needs approval.

Cần quyền: Mời nhân sự

Tham số (3)
TênKiểuMô tả
limitintegerRows per page, 1-50 (default 20).
cursorstringnext_cursor from the previous page; leave out for the first page.
organization_idstringTổ 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 các mốc điều khoản làm việc

Lists one staff member's employment versions (hire, adjustments, status changes), newest first, with the day each took effect, which one is current, and pay when the caller may set pay. Without member_id, lists versions across the organization whose start day was estimated and should be confirmed.

Cần quyền: Xem nhân sự

Tham số (4)
TênKiểuMô tả
member_idstringStaff member id, from search_staff. Leave out for the estimated-date list.
limitintegerRows per page, 1-50 (default 20).
cursorstringnext_cursor from the previous page; leave out for the first page.
organization_idstringTổ 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.
revoke_badgeGhiXoá / huỷ

Thu hồi huy hiệu

Revokes a badge award (award id from list_badges view=awards or get_staff_member include=badges) from a staff member, with an optional reason. The award stays in the history marked revoked.

Cần quyền: Sửa nhân sự

Tham số (5)
TênKiểuMô tả
member_idbắt buộcstringStaff member id.
award_idbắt buộcstringAward id.
reasonstring
organization_idstringTổ 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_keystringKhoá chống lặp tuỳ chọn: gọi lại cùng khoá không tạo bản ghi thứ hai.
revoke_invitationGhiXoá / huỷ

Thu hồi lời mời

Revokes an unused invitation (id from list_invitations) so its code no longer works. An invitation already used cannot be revoked; decide the resulting join request instead.

Cần quyền: Mời nhân sự

Tham số (3)
TênKiểuMô tả
invitation_idbắt buộcstringInvitation id, from list_invitations.
organization_idstringTổ 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_keystringKhoá chống lặp tuỳ chọn: gọi lại cùng khoá không tạo bản ghi thứ hai.
save_member_termsNhạy cảm

Lưu mốc điều khoản làm việc (lương, vai trò)

Adds a dated employment version for a staff member, or edits one (term_id from list_member_terms): role, managed departments, department, position, status, salary basis and amount, salary template, allowances, insurance, dependants. The first call returns a preview with the version in force and the payroll periods affected; call again with confirmation_id once the user agrees.

Cần quyền: Sửa nhân sự

Tham số (12)
TênKiểuMô tả
member_idbắt buộcstringStaff member id, from search_staff.
term_idstringEdit this version instead of adding one (ids from list_member_terms).
namestringShort name, e.g. "Tăng lương 2026". Required for a new version.
kindstringhire, contract, appendix, adjustment (default) or status. Giá trị: hirecontractappendixadjustmentstatus
effective_fromstringDay it takes effect, YYYY-MM-DD. Required for a new version.
contract_idstringContract this version comes from (list_contracts).
notestring
confirm_datebooleanWhen editing a version whose date CTAS estimated: true marks the date as checked.
fieldsobjectWhat changes from that day. Keys: role, managed_department_ids, department_id, position_id, status, employment_type, salary_template_id, salary_basis (month|day|hour), base_salary, rate (integer VND), components, component_overrides, insurance_enrolled, insurance_base, dependants, work_arrangement_id, default_shift_template_id, leave_policy_id, leave_applies, holidays_apply.
organization_idstringTổ 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_keystringKhoá chống lặp tuỳ chọn: gọi lại cùng khoá không tạo bản ghi thứ hai.
confirmation_idstringMã xác nhận do lần gọi xem trước trả về; gọi lại với mã này mới thực hiện.

Tìm nhân sự

Searches the organization's staff by name, phone or job title, optionally within one department or status. Returns id, name, role, department, position, status and join date per person. People who left are hidden unless status is left or all. A department-scoped role only sees its own departments.

Cần quyền: Xem nhân sự

Tham số (6)
TênKiểuMô tả
querystringPart of a name, phone number or job title.
department_idstringOnly this department (ids from get_org_structure).
statusstringactive (default: active and paused), paused, left, or all. Giá trị: activepausedleftall
limitintegerRows per page, 1-50 (default 20).
cursorstringnext_cursor from the previous page; leave out for the first page.
organization_idstringTổ 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.

Sửa thông tin nhân sự

Changes a staff member's department, position, status (active, paused, left), employment type, work arrangement, default shift, leave template or join date. Give effective_from to date the change; leaving is dated today when no day is given. Role, pay and leave balance changes go through save_member_terms and adjust_leave_balance.

Cần quyền: Sửa nhân sự

Tham số (15)
TênKiểuMô tả
member_idbắt buộcstringStaff member id, from search_staff.
department_idstringNew department id (get_org_structure).
position_idstringNew position id (get_org_structure).
statusstring Giá trị: activepausedleft
employment_typestring Giá trị: probationofficialseasonalcollab
work_arrangement_idstringWork arrangement id.
default_shift_template_idstringUsual shift template id.
leave_policy_idstringLeave template id.
leave_appliesboolean
holidays_applyboolean
join_datestringCorrected first working day, YYYY-MM-DD (not in the future).
effective_fromstringDay the change takes effect, YYYY-MM-DD (default: now).
term_namestringName for the dated version.
organization_idstringTổ 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_keystringKhoá chống lặp tuỳ chọn: gọi lại cùng khoá không tạo bản ghi thứ hai.

Chấm công · 6

discard_attendanceNhạy cảmXoá / huỷ

Xoá ngày chấm công nhầm

Removes one staff member's attendance day that was punched by mistake (wrong phone, test punch, a day not worked). The day is archived before it leaves the sheet, so it can be looked up later, but it stops counting for pay. A reason is required. The first call returns a preview of the day and a confirmation_id.

Cần quyền: Sửa chấm công

Tham số (6)
TênKiểuMô tả
member_idbắt buộcstringStaff member id.
datebắt buộcstringThe day as YYYY-MM-DD.
reasonbắt buộcstringWhy the day is wrong (3-255 characters).
organization_idstringTổ 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_keystringKhoá chống lặp tuỳ chọn: gọi lại cùng khoá không tạo bản ghi thứ hai.
confirmation_idstringMã xác nhận do lần gọi xem trước trả về; gọi lại với mã này mới thực hiện.
edit_attendanceNhạy cảm

Sửa chấm công của nhân sự

Corrects one staff member's attendance day. action=set_times writes the check-in and/or check-out time (a reason is required); action=excuse forgives the day's lateness, early leave, forgotten punch or unverified location (cause and note required); action=reopen erases a check-out tapped by mistake so the shift is open again. Changes reach payroll. The first call returns a preview and confirmation_id.

Cần quyền: Sửa chấm công

Tham số (15)
TênKiểuMô tả
member_idbắt buộcstringStaff member id.
actionbắt buộcstring Giá trị: set_timesexcusereopen
datebắt buộcstringThe day as YYYY-MM-DD.
reasonbắt buộcstringWhy, as the user said it (3-255 characters). Required for set_times, excuse and reopen.
check_instringset_times: HH:MM.
check_outstringset_times: HH:MM.
shift_assignment_idstringexcuse/reopen: the shift on a day with several (from get_member_attendance with date).
latebooleanexcuse: forgive lateness.
earlybooleanexcuse: forgive leaving early.
forgotbooleanexcuse: forgive a forgotten punch.
locationbooleanexcuse: forgive an unverified location.
causestringexcuse: permission = it was allowed beforehand, mispunch = the punch was wrong. Giá trị: permissionmispunch
organization_idstringTổ 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_keystringKhoá chống lặp tuỳ chọn: gọi lại cùng khoá không tạo bản ghi thứ hai.
confirmation_idstringMã xác nhận do lần gọi xem trước trả về; gọi lại với mã này mới thực hiện.

Xem điểm tuân thủ chấm công

Returns attendance compliance scores for a month: each staff member's score out of 100 with the count of lapses (late, early, forgotten punches, absences, location), rated good/fair/poor. Give member_id for one person's month day by day. Set with_settings for the organization's weights and thresholds.

Cần quyền: Xem bảng công

Tham số (7)
TênKiểuMô tả
monthstringMonth as YYYY-MM (default this month).
member_idstringOne staff member instead of everybody.
department_idstringOnly this department (ignored with member_id).
with_settingsbooleanAlso return the weights and the good/fair thresholds (default false).
limitintegerRows per page, 1-50 (default 20).
cursorstringnext_cursor from the previous page; leave out for the first page.
organization_idstringTổ 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 một nhân sự

Returns one staff member's attendance for a month (each day's punches and status, totals of work days, leave, late days, hours, trips). Give date as well to explain that day: the shifts it was judged against, the verdicts and hours, and - for managers who may edit attendance - the violations it holds and which are already forgiven.

Cần quyền: Xem bảng công

Tham số (5)
TênKiểuMô tả
member_idbắt buộcstringStaff member id, from search_staff or list_attendance.
monthstringMonth as YYYY-MM (default this month; ignored when date is given).
datestringOne day as YYYY-MM-DD to explain in detail.
with_violationsbooleanWith date: also list what the day holds to forgive (needs attendance.edit). Default false.
organization_idstringTổ 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.
get_monthly_reportĐọcTốn 5 đơn vị

Xem báo cáo tháng

Returns the monthly attendance report for the staff the signed-in manager can see: working days, totals (work days, hours, leave, late minutes, absences), the breakdown per department, the five latest arrivals, and payroll totals when the user may view payroll. Use it for questions about a whole month instead of reading the sheet day by day.

Cần quyền: Xem bảng công

Tham số (2)
TênKiểuMô tả
monthstringMonth as YYYY-MM (default this month).
organization_idstringTổ 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 bảng chấm công trong ngày

Lists the attendance sheet of one day for the staff the signed-in manager can see: each person with state (present, working, late, leave, day_off, upcoming, forgot_checkin, absent, offsite, no_punch), check-in/out, late/early minutes, credit and shifts, plus a summary count per state. Filter by department_id or state. For a month use get_member_attendance or get_monthly_report.

Cần quyền: Xem bảng công

Tham số (6)
TênKiểuMô tả
datestringDay as YYYY-MM-DD (default today, Vietnam time).
department_idstringOnly this department (store), from get_org_structure.
statestringOnly rows in this state. Giá trị: presentworkinglateleaveday_offupcomingforgot_checkinabsentoffsiteno_punchopen
limitintegerRows per page, 1-50 (default 20).
cursorstringnext_cursor from the previous page; leave out for the first page.
organization_idstringTổ 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.

Lịch làm việc · 8

Xếp ca cho nhân sự

Rosters one staff member on a date: adds a shift from a template (or with its own hours), with its kind, overtime, place and note. A date can hold several shifts; set replace_day to make this the only shift of that date. The route refuses overlaps, ordinary shifts on rest days and dates of unpaid status, in its own words.

Cần quyền: Xếp lịch làm

Tham số (25)
TênKiểuMô tả
member_idbắt buộcstringStaff member id.
datebắt buộcstringYYYY-MM-DD.
replace_daybooleanReplace whatever the date holds with this one shift (default false: add).
shift_template_idstringShift template id from get_org_structure. Give it, or starts_at + ends_at for one-off hours.
starts_atstringHH:MM, with ends_at, for hours no template describes.
ends_atstringHH:MM.
kindstringshift (ordinary, default), overtime (every minute is overtime; the only kind allowed on a rest day), trip. Giá trị: shifttripovertime
overtime_minutesintegerOvertime rostered on top of the shift.
overtime_pay_modestringHow an overtime shift is paid when not by the day's band; leave = days of annual leave instead of money. Giá trị: defaulthourly_ratemultiplierextra_per_hourleave
overtime_pay_valueintegerInteger VND (hourly_rate, extra_per_hour) or percent (multiplier).
overtime_leave_daysnumberWith overtime_pay_mode=leave: days in halves, up to 3.
work_sitestringdefault = usual workplace, department = another store (site_department_id), pin/area = a place by coordinates (site_lat, site_lng, site_radius_m, site_name), none = no place check. Giá trị: defaultdepartmentpinareanone
site_department_idstring
site_namestringName of the place for pin/area.
site_addressstring
site_latnumber
site_lngnumber
site_radius_minteger
credit_daybooleanCount the day as worked without a punch (off-site work).
notestringNote shown on the shift (max 500).
makeupbooleanAn ordinary shift on a rest day, paid as ordinary (lam bu).
makeup_forstringThe day it makes up for, YYYY-MM-DD.
pay_itemsobject[]Allowances or deductions for this shift, integer VND; needs payroll.manage. [] removes them.
organization_idstringTổ 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_keystringKhoá chống lặp tuỳ chọn: gọi lại cùng khoá không tạo bản ghi thứ hai.

Chép lịch sang tuần khác

Copies the roster of one week (Monday to Sunday) onto another week, for everybody in reach or only some departments or staff. Days that already hold shifts are kept unless overwrite is true. Set dry_run to get the counts (written, skipped) without writing anything.

Cần quyền: Xếp lịch làm

Tham số (8)
TênKiểuMô tả
from_week_startbắt buộcstringMonday of the week to copy, YYYY-MM-DD.
to_week_startbắt buộcstringMonday of the week to fill, YYYY-MM-DD.
overwritebooleanReplace days that already hold shifts (default false).
dry_runbooleanOnly count what would be written (default false).
department_idsstring[]
member_idsstring[]
organization_idstringTổ 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_keystringKhoá chống lặp tuỳ chọn: gọi lại cùng khoá không tạo bản ghi thứ hai.
get_scheduleĐọcTốn 2 đơn vị

Xem lịch làm việc

Returns the work schedule (roster) between two dates, at most 31 days: for each staff member, each day with its shifts (template, hours, kind, place, note, shift id for update_shift/remove_shift), whether the day is closed (rest day, holiday) and any leave. Filter by department_ids or member_ids; staff are paged with limit/cursor.

Cần quyền: Vào khu quản trị

Tham số (8)
TênKiểuMô tả
date_frombắt buộcstringFirst day, YYYY-MM-DD.
date_tostringLast day, YYYY-MM-DD (at most 31 days in all; default date_from + 6).
department_idsstring[]
member_idsstring[]
only_rosteredbooleanLeave out days with nothing on them (default true).
limitintegerRows per page, 1-50 (default 20).
cursorstringnext_cursor from the previous page; leave out for the first page.
organization_idstringTổ 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.
remove_shiftGhiXoá / huỷ

Gỡ ca khỏi lịch

Removes rostered shifts: give shift_id to remove that one shift and leave the rest of the date, or member_id + date to clear every shift of that person on that date. Punches already made are not touched.

Cần quyền: Xếp lịch làm

Tham số (5)
TênKiểuMô tả
shift_idstringOne shift, from get_schedule.
member_idstringWith date: clear the whole date.
datestringYYYY-MM-DD, with member_id.
organization_idstringTổ 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_keystringKhoá chống lặp tuỳ chọn: gọi lại cùng khoá không tạo bản ghi thứ hai.

Xếp lịch công tác

Rosters a business trip: up to 200 staff away from date_from to date_to (at most 62 days) at one place, each day as a trip shift on the given template. The place is another store (work_site=department + site_department_id) or a named spot (pin/area with coordinates). Days that already hold shifts are skipped unless overwrite is true.

Cần quyền: Xếp lịch làm

Tham số (26)
TênKiểuMô tả
member_idsbắt buộcstring[]
date_frombắt buộcstring
date_tobắt buộcstring
overwritebooleanReplace days that already hold shifts (default false).
shift_template_idstringShift template id from get_org_structure. Give it, or starts_at + ends_at for one-off hours.
starts_atstringHH:MM, with ends_at, for hours no template describes.
ends_atstringHH:MM.
kindstringshift (ordinary, default), overtime (every minute is overtime; the only kind allowed on a rest day), trip. Giá trị: shifttripovertime
overtime_minutesintegerOvertime rostered on top of the shift.
overtime_pay_modestringHow an overtime shift is paid when not by the day's band; leave = days of annual leave instead of money. Giá trị: defaulthourly_ratemultiplierextra_per_hourleave
overtime_pay_valueintegerInteger VND (hourly_rate, extra_per_hour) or percent (multiplier).
overtime_leave_daysnumberWith overtime_pay_mode=leave: days in halves, up to 3.
work_sitestringdefault = usual workplace, department = another store (site_department_id), pin/area = a place by coordinates (site_lat, site_lng, site_radius_m, site_name), none = no place check. Giá trị: defaultdepartmentpinareanone
site_department_idstring
site_namestringName of the place for pin/area.
site_addressstring
site_latnumber
site_lngnumber
site_radius_minteger
credit_daybooleanCount the day as worked without a punch (off-site work).
notestringNote shown on the shift (max 500).
makeupbooleanAn ordinary shift on a rest day, paid as ordinary (lam bu).
makeup_forstringThe day it makes up for, YYYY-MM-DD.
pay_itemsobject[]Allowances or deductions for this shift, integer VND; needs payroll.manage. [] removes them.
organization_idstringTổ 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_keystringKhoá chống lặp tuỳ chọn: gọi lại cùng khoá không tạo bản ghi thứ hai.

Xếp cùng một ca cho nhiều ngày

Sets up to 31 dates of one staff member to the same shift (template or own hours, with kind, place and note), replacing what those dates held. With no shift_template_id and no hours the dates are cleared instead. Returns how many shifts were written and cleared.

Cần quyền: Xếp lịch làm

Tham số (24)
TênKiểuMô tả
member_idbắt buộcstring
datesbắt buộcstring[]
shift_template_idstringShift template id from get_org_structure. Give it, or starts_at + ends_at for one-off hours.
starts_atstringHH:MM, with ends_at, for hours no template describes.
ends_atstringHH:MM.
kindstringshift (ordinary, default), overtime (every minute is overtime; the only kind allowed on a rest day), trip. Giá trị: shifttripovertime
overtime_minutesintegerOvertime rostered on top of the shift.
overtime_pay_modestringHow an overtime shift is paid when not by the day's band; leave = days of annual leave instead of money. Giá trị: defaulthourly_ratemultiplierextra_per_hourleave
overtime_pay_valueintegerInteger VND (hourly_rate, extra_per_hour) or percent (multiplier).
overtime_leave_daysnumberWith overtime_pay_mode=leave: days in halves, up to 3.
work_sitestringdefault = usual workplace, department = another store (site_department_id), pin/area = a place by coordinates (site_lat, site_lng, site_radius_m, site_name), none = no place check. Giá trị: defaultdepartmentpinareanone
site_department_idstring
site_namestringName of the place for pin/area.
site_addressstring
site_latnumber
site_lngnumber
site_radius_minteger
credit_daybooleanCount the day as worked without a punch (off-site work).
notestringNote shown on the shift (max 500).
makeupbooleanAn ordinary shift on a rest day, paid as ordinary (lam bu).
makeup_forstringThe day it makes up for, YYYY-MM-DD.
pay_itemsobject[]Allowances or deductions for this shift, integer VND; needs payroll.manage. [] removes them.
organization_idstringTổ 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_keystringKhoá chống lặp tuỳ chọn: gọi lại cùng khoá không tạo bản ghi thứ hai.

Đổi ca giữa hai nhân sự

Swaps the shifts of two staff members on one date: each takes the other's rostered shifts for that day (an empty day swaps too). The route refuses it when either person could not work the other's shift.

Cần quyền: Xếp lịch làm

Tham số (5)
TênKiểuMô tả
datebắt buộcstringYYYY-MM-DD.
first_member_idbắt buộcstring
second_member_idbắt buộcstring
organization_idstringTổ 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_keystringKhoá chống lặp tuỳ chọn: gọi lại cùng khoá không tạo bản ghi thứ hai.

Sửa ca đã xếp

Changes one rostered shift by its id (from get_schedule): template or own hours, kind, overtime and its pay, place, note, make-up day, pay items, or date (moves it to another day of the same person). Only the fields given are changed; overlaps and rest days are checked on the destination date.

Cần quyền: Xếp lịch làm

Tham số (24)
TênKiểuMô tả
shift_idbắt buộcstringThe shift id, from get_schedule.
datestringMove to this date (YYYY-MM-DD).
shift_template_idstringShift template id from get_org_structure. Give it, or starts_at + ends_at for one-off hours.
starts_atstringHH:MM, with ends_at, for hours no template describes.
ends_atstringHH:MM.
kindstringshift (ordinary, default), overtime (every minute is overtime; the only kind allowed on a rest day), trip. Giá trị: shifttripovertime
overtime_minutesintegerOvertime rostered on top of the shift.
overtime_pay_modestringHow an overtime shift is paid when not by the day's band; leave = days of annual leave instead of money. Giá trị: defaulthourly_ratemultiplierextra_per_hourleave
overtime_pay_valueintegerInteger VND (hourly_rate, extra_per_hour) or percent (multiplier).
overtime_leave_daysnumberWith overtime_pay_mode=leave: days in halves, up to 3.
work_sitestringdefault = usual workplace, department = another store (site_department_id), pin/area = a place by coordinates (site_lat, site_lng, site_radius_m, site_name), none = no place check. Giá trị: defaultdepartmentpinareanone
site_department_idstring
site_namestringName of the place for pin/area.
site_addressstring
site_latnumber
site_lngnumber
site_radius_minteger
credit_daybooleanCount the day as worked without a punch (off-site work).
notestringNote shown on the shift (max 500).
makeupbooleanAn ordinary shift on a rest day, paid as ordinary (lam bu).
makeup_forstringThe day it makes up for, YYYY-MM-DD.
pay_itemsobject[]Allowances or deductions for this shift, integer VND; needs payroll.manage. [] removes them.
organization_idstringTổ 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_keystringKhoá chống lặp tuỳ chọn: gọi lại cùng khoá không tạo bản ghi thứ hai.

Đơn từ và tạm ứng · 9

Cho nhân sự nghỉ phép

Puts a staff member on leave as an already approved request: type, date_from to date_to (or half a day), and a note the member reads. It spends their annual leave balance when the type does, and the member is notified. If they already punched on those days the route refuses and lists the dates; set discard_attendance to archive those punches and give the leave anyway.

Cần quyền: Duyệt đơn từ

Tham số (9)
TênKiểuMô tả
member_idbắt buộcstring
typebắt buộcstring Giá trị: annualsickunpaidmarriagechild_marriagebereavementmaternitychild_sickcompensatory
date_frombắt buộcstring
date_tobắt buộcstring
half_day_partstringHalf a day (date_from = date_to). Giá trị: morningafternoon
notestringShown to the member (max 300).
discard_attendancebooleanArchive punches already made on those days (only after the user agreed).
organization_idstringTổ 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_keystringKhoá chống lặp tuỳ chọn: gọi lại cùng khoá không tạo bản ghi thứ hai.

Duyệt yêu cầu gia nhập

Approves or rejects pending join requests (ids from list_join_requests, up to 50). Approving adds the person to the organization as staff, or the role and department they were invited to; for a single request you may set role, department_id and position_id. Returns which ids were done and why any failed. Confirm with the user first.

Cần quyền: Duyệt đơn từ

Tham số (8)
TênKiểuMô tả
idsbắt buộcstring[]Join request ids.
actionbắt buộcstring Giá trị: approvereject
notestringReason, shown to the applicant on reject.
rolestringSingle approval only: role key from list_roles.
department_idstringSingle approval only: department id.
position_idstringSingle approval only: position id.
organization_idstringTổ 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_keystringKhoá chống lặp tuỳ chọn: gọi lại cùng khoá không tạo bản ghi thứ hai.

Duyệt hoặc từ chối đơn

Approves or rejects pending requests of one kind (leave, adjustment, schedule_proposal, advance, join), up to 50 ids at once; or, action=revoke, takes back approved leave (days return to the balance). Options for a single id: leave_type settles leave as annual or unpaid, approved_amount approves a smaller advance (integer VND), excuse/replace_clashes for adjustments. Rejecting a schedule proposal needs a note. Returns the ids done and those refused with the reason.

Cần quyền: Duyệt đơn từ

Tham số (10)
TênKiểuMô tả
kindbắt buộcstring Giá trị: leaveadjustmentschedule_proposaladvancejoin
actionbắt buộcstringrevoke: approved leave only. Giá trị: approverejectrevoke
idsbắt buộcstring[]Request ids from list_requests (proposal_id for schedule_proposal), 1-50.
notestringWhat the requester reads (max 300). Required to reject a schedule proposal.
leave_typestringApprove one leave request as this type instead. Giá trị: annualunpaid
approved_amountintegerApprove one advance for this amount (integer VND) instead of the amount asked.
excusebooleanApprove one forgotten-punch adjustment and also forgive its lateness.
replace_clashesbooleanApprove one schedule adjustment and take clashing shifts off the roster.
organization_idstringTổ 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_keystringKhoá chống lặp tuỳ chọn: gọi lại cùng khoá không tạo bản ghi thứ hai.

Xem chi tiết một đơn

Returns one request in full, in any state: kind=leave (dates, days or hours, type, reason, decision), kind=adjustment (what is asked, the punches, the shifts a schedule request would clash with), kind=schedule_proposal (the day before and after, every line, warnings). Advance and join rows from list_requests are already complete.

Cần quyền: Vào khu quản trị

Tham số (3)
TênKiểuMô tả
kindbắt buộcstring Giá trị: leaveadjustmentschedule_proposal
idbắt buộcstringThe request id (for schedule_proposal: the proposal_id).
organization_idstringTổ 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 yêu cầu gia nhập

Lists pending requests to join the organization: applicant name and phone, the department and role they were invited to, and when they asked. Department-scoped roles see none, since joining is decided for the whole organization.

Cần quyền: Vào khu quản trị

Tham số (3)
TênKiểuMô tả
limitintegerRows per page, 1-50 (default 20).
cursorstringnext_cursor from the previous page; leave out for the first page.
organization_idstringTổ 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 hộp đơn từ cần duyệt

Lists requests waiting for (or past) a manager's decision, for the staff the user can see. kind: leave, adjustment (late/early/forgotten punch, schedule requests; rows with proposal_id are day proposals - decide them as kind=schedule_proposal with that proposal_id), advance (salary advances), join (people asking to join). Without kind returns the first pending rows of every kind with their totals. Status defaults to pending.

Cần quyền: Vào khu quản trị

Tham số (8)
TênKiểuMô tả
kindstringOne queue, paged. Leave out for an overview of all queues. Giá trị: leaveadjustmentadvancejoin
statusstringDefault pending. cancelled: leave only; paid/processing/done: advance only; join lists pending only. Giá trị: pendingapprovedrejectedcancelledpaidprocessingdone
department_idstringadvance: only this department.
searchstringadvance: name or phone.
payroll_monthstringadvance: the payroll month it is recovered in, YYYY-MM.
limitintegerRows per page, 1-50 (default 20).
cursorstringnext_cursor from the previous page; leave out for the first page.
organization_idstringTổ 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.
record_advance_payoutNhạy cảmTạm tắt

Ghi nhận đã chi tạm ứng

Records that an approved salary advance was already handed to the staff member outside CTAS (cash or the company's own bank transfer). It moves no money; it only marks the advance as paid so payroll deducts it. The first call returns a preview and a confirmation_id.

Cần quyền: Chi tiền tạm ứng

Tham số (4)
TênKiểuMô tả
advance_idbắt buộcstringAn approved advance, from list_requests kind=advance status=approved.
organization_idstringTổ 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_keystringKhoá chống lặp tuỳ chọn: gọi lại cùng khoá không tạo bản ghi thứ hai.
confirmation_idstringMã xác nhận do lần gọi xem trước trả về; gọi lại với mã này mới thực hiện.

Dời ngày nghỉ phép đã duyệt

Moves an approved leave request (id from list_requests kind=leave status=approved) to new dates, and optionally changes its type. Days given back return to the balance, extra days are checked against it, and the member is told. Hourly leave stays on one date. If the new days hold punches the route lists them; set discard_attendance to archive them.

Cần quyền: Duyệt đơn từ

Tham số (8)
TênKiểuMô tả
leave_request_idbắt buộcstring
date_frombắt buộcstring
date_tobắt buộcstring
typestring Giá trị: annualsickunpaidmarriagechild_marriagebereavementmaternitychild_sickcompensatory
notestringShown to the member (max 300).
discard_attendanceboolean
organization_idstringTổ 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_keystringKhoá chống lặp tuỳ chọn: gọi lại cùng khoá không tạo bản ghi thứ hai.

Đổi kỳ trừ tạm ứng

Moves a salary advance (id from list_requests kind=advance) to another payroll month, the month whose payroll deducts it. Works while the advance is pending, approved or paid and no closed payroll has deducted it yet; the target month must be open. The member is told when the month changes.

Cần quyền: Vào khu quản trị

Tham số (4)
TênKiểuMô tả
advance_idbắt buộcstring
payroll_monthbắt buộcstringYYYY-MM.
organization_idstringTổ 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_keystringKhoá chống lặp tuỳ chọn: gọi lại cùng khoá không tạo bản ghi thứ hai.

Lương và thưởng · 24

adjust_payslipNhạy cảmXoá / huỷTốn 2 đơn vị

Điều chỉnh lương

Changes one person's pay. On open pay (period_id + member_id): add_extra, update_extra or remove_extra a hand-added line (kind income or deduction), or override_line a computed line by its key from get_payroll_board with_lines (enabled false, a new amount, or reset). On a closed payslip (payslip_id): add_payslip_item a bonus or penalty. Amounts are VND. Two steps: preview with a confirmation_id first, then call again with it.

Cần quyền: Chốt lương

Tham số (15)
TênKiểuMô tả
actionbắt buộcstringWhat to change. Giá trị: add_extraupdate_extraremove_extraoverride_lineadd_payslip_item
period_idstringPayroll period id (open-pay actions).
member_idstringMember id (open-pay actions).
payslip_idstringClosed payslip id (add_payslip_item).
keystringExtra line key (update_extra, remove_extra) or computed line key (override_line).
kindstringincome or deduction for extras; bonus or penalty for add_payslip_item. Giá trị: incomedeductionbonuspenalty
labelstringThe line's name as the member will read it.
amountintegerVND, a positive whole number (override_line: the new amount).
notestringWhy, for the record (extras only).
enabledbooleanoverride_line: false switches the computed line off.
resetbooleanoverride_line: put the computed line back as the software computes it.
acknowledge_mismatchbooleanoverride_line: accept an override whose computed figure has changed since.
organization_idstringTổ 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_keystringKhoá chống lặp tuỳ chọn: gọi lại cùng khoá không tạo bản ghi thứ hai.
confirmation_idstringMã xác nhận do lần gọi xem trước trả về; gọi lại với mã này mới thực hiện.
backfill_reward_ruleNhạy cảmTốn 10 đơn vị

Thưởng bù theo quy tắc

Pays an active reward rule to the people who already earned its badge or certificate before the rule existed. Two steps: the first call returns the dry run (who would be paid and the total in VND) with a confirmation_id; calling again with it creates those rewards for the next payroll. Organization-wide roles only.

Cần quyền: Chốt lương

Tham số (4)
TênKiểuMô tả
rule_idbắt buộcstringRule id, from list_reward_rules.
organization_idstringTổ 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_keystringKhoá chống lặp tuỳ chọn: gọi lại cùng khoá không tạo bản ghi thứ hai.
confirmation_idstringMã xác nhận do lần gọi xem trước trả về; gọi lại với mã này mới thực hiện.
close_payrollNhạy cảmTốn 5 đơn vị

Chốt lương

Closes pay for a payroll period: freezes each person's payslip as computed and sends it to them. Pass member_ids (at most 50) to close those people, or leave it out to close the whole period. Two steps: the first call returns a preview (people, net per person, total in VND, blocking problems) and a confirmation_id; call again with it once the user agrees. force closes despite blocking problems such as a missing wage.

Cần quyền: Chốt lương

Tham số (6)
TênKiểuMô tả
period_idbắt buộcstringPayroll period id, from list_payroll_periods.
member_idsstring[]Member ids (from get_payroll_board), at most 50. Leave out to close the whole period.
forcebooleanClose even people held by a blocking readiness check. Only when the user explicitly accepts it.
organization_idstringTổ 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_keystringKhoá chống lặp tuỳ chọn: gọi lại cùng khoá không tạo bản ghi thứ hai.
confirmation_idstringMã xác nhận do lần gọi xem trước trả về; gọi lại với mã này mới thực hiện.

Mở kỳ lương

Opens the payroll period for a month so its pay can be reviewed and closed. With no month it opens the month the organization's cut-off day says is current; a named month must already be over. Opening a month that already has a period returns that period (created: false). Nothing is paid or frozen.

Cần quyền: Chốt lương

Tham số (3)
TênKiểuMô tả
monthstringYYYY-MM; leave out for the current payroll month.
organization_idstringTổ 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_keystringKhoá chống lặp tuỳ chọn: gọi lại cùng khoá không tạo bản ghi thứ hai.
decide_rewardNhạy cảm

Duyệt hoặc huỷ thưởng

Approves (decision approve) a learning reward waiting for approval, or cancels it (decision cancel, optional reason) while it is not on a payslip yet. Approved rewards are paid on the payslip of their payroll month. Two steps: the first call previews the reward (who, why, amount in VND) with a confirmation_id; call again with it once the user agrees.

Cần quyền: Chốt lương

Tham số (6)
TênKiểuMô tả
reward_idbắt buộcstringReward id, from list_rewards.
decisionbắt buộcstring Giá trị: approvecancel
reasonstringWhy it is canceled (cancel only).
organization_idstringTổ 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_keystringKhoá chống lặp tuỳ chọn: gọi lại cùng khoá không tạo bản ghi thứ hai.
confirmation_idstringMã xác nhận do lần gọi xem trước trả về; gọi lại với mã này mới thực hiện.
delete_reward_ruleNhạy cảmXoá / huỷ

Xoá quy tắc thưởng

Deletes a learning reward rule (rule_id from list_reward_rules) so nobody earns it from now on; rewards it already paid stay on the payslips. To stop it for a while use save_reward_rule with status paused instead. Two steps: preview with a confirmation_id, then call again with it.

Cần quyền: Chốt lương

Tham số (4)
TênKiểuMô tả
rule_idbắt buộcstringRule id.
organization_idstringTổ 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_keystringKhoá chống lặp tuỳ chọn: gọi lại cùng khoá không tạo bản ghi thứ hai.
confirmation_idstringMã xác nhận do lần gọi xem trước trả về; gọi lại với mã này mới thực hiện.

Xem phiếu lương của nhân sự

Reads one closed payslip of a person the user manages (payslip_id from list_period_payslips or get_payroll_board): net pay and company insurance in VND, every line (income, deduction, bonus, penalty), status and the timeline of who closed, confirmed, approved and paid it.

Cần quyền: Xem bảng lương

Tham số (2)
TênKiểuMô tả
payslip_idbắt buộcstringPayslip id.
organization_idstringTổ 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.
get_member_pay_estimateĐọcTốn 2 đơn vị

Xem lương tạm tính của nhân sự

Reads one managed person's estimated pay for a month (this month by default): gross, deductions, net in VND and the lines, so far or projected to month end. When their payslip is already released it returns status released with payslip_id and net instead.

Cần quyền: Xem bảng lương

Tham số (4)
TênKiểuMô tả
member_idbắt buộcstringMember id, from list_pay_estimates.
monthstringYYYY-MM; this month when left out.
projectedbooleanProject to the end of the month from the roster instead of counting only days so far.
organization_idstringTổ 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.
get_member_pay_shiftsĐọcTốn 2 đơn vị

Xem ca tính lương của nhân sự

Reads one person's payroll period shift by shift (what was rostered, worked, missed and paid for each day) to explain their figure on get_payroll_board. Takes period_id and member_id; only people the user manages.

Cần quyền: Xem bảng lương

Tham số (3)
TênKiểuMô tả
period_idbắt buộcstringPayroll period id, from list_payroll_periods.
member_idbắt buộcstringMember id, from get_payroll_board.
organization_idstringTổ 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.
get_payroll_boardĐọcTốn 5 đơn vị

Xem bảng lương

Reads the payroll board of one period a page at a time: for each person their state (open, sent, confirmed, queried), net, gross and deductions in VND, issues and payslip status, plus counts and totals for the whole board. Filter by department_id or state. with_lines adds pay lines and hand changes (the keys adjust_payslip needs). Totals of open rows are as last worked out.

Cần quyền: Xem bảng lương

Tham số (8)
TênKiểuMô tả
period_idbắt buộcstringPayroll period id, from list_payroll_periods.
department_idstringOnly this department or store.
statestringOnly rows in this state: open (not closed yet), sent (closed, waiting for the member), confirmed, queried (the member asked a question). Giá trị: opensentconfirmedqueried
member_idsstring[]Only these people.
with_linesbooleanInclude each row's pay lines, extras and overrides (larger answer).
limitintegerRows per page, 1-50 (default 20).
cursorstringnext_cursor from the previous page; leave out for the first page.
organization_idstringTổ 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.
get_payroll_readinessĐọcTốn 2 đơn vị

Kiểm tra trước khi chốt lương

Checks a payroll period before closing, for the people the user manages: each check has a key, a severity (block or warn), a count and the people it names. blocking is true when closing everyone would be refused (for example someone has no wage set). Read-only.

Cần quyền: Xem bảng lương

Tham số (2)
TênKiểuMô tả
period_idbắt buộcstringPayroll period id, from list_payroll_periods.
organization_idstringTổ 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

Lists the people on a month's payroll that the user manages (this month by default) and, for each, whether their payslip is already released (with net pay in VND) or still an estimate. Use get_member_pay_estimate for one person's estimated pay in full.

Cần quyền: Xem bảng lương

Tham số (5)
TênKiểuMô tả
limitintegerRows per page, 1-50 (default 20).
cursorstringnext_cursor from the previous page; leave out for the first page.
monthstringYYYY-MM; this month when left out.
department_idstringOnly this department or store.
organization_idstringTổ 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 các kỳ lương

Lists the organization's payroll periods, newest first, with month, year, status (open, closed, confirmed, verified, paid), pay date and which departments have signed off. Use the id with get_payroll_board, get_payroll_readiness and the other payroll tools.

Cần quyền: Xem bảng lương

Tham số (4)
TênKiểuMô tả
limitintegerRows per page, 1-50 (default 20).
cursorstringnext_cursor from the previous page; leave out for the first page.
statusstringOnly periods in this status. Giá trị: openclosedconfirmedverifiedpaid
organization_idstringTổ 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 câu hỏi về phiếu lương

Lists the questions staff raised about their payslips (open first) for the people the user manages: who asked, which month and line, the reason in their words, and the answer once resolved. Answer one with resolve_payslip_query.

Cần quyền: Xem bảng lương

Tham số (4)
TênKiểuMô tả
limitintegerRows per page, 1-50 (default 20).
cursorstringnext_cursor from the previous page; leave out for the first page.
statusstringOnly open or only resolved questions. Giá trị: openresolved
organization_idstringTổ 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 một tháng

Lists the closed payslips of one payroll month (the latest when month is left out) for the people the user manages: member, net pay in VND and status (closed, confirmed, verified, paid), plus how many of them the staff have confirmed. Open pay that is not closed yet is on get_payroll_board instead.

Cần quyền: Xem bảng lương

Tham số (4)
TênKiểuMô tả
limitintegerRows per page, 1-50 (default 20).
cursorstringnext_cursor from the previous page; leave out for the first page.
monthstringPayroll month as YYYY-MM; leave out for the latest period.
organization_idstringTổ 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 quy tắc thưởng

Lists the organization's learning reward rules: trigger (badge, certificate, milestone), target, amount in VND, status and how many people each has paid so far, plus whether rewards need approval. with_options adds the badges and courses a rule can name (their ids for save_reward_rule).

Cần quyền: Chốt lương

Tham số (4)
TênKiểuMô tả
limitintegerRows per page, 1-50 (default 20).
cursorstringnext_cursor from the previous page; leave out for the first page.
with_optionsbooleanAlso list the badges and courses a rule can reward.
organization_idstringTổ 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 học tập

Lists learning rewards staff earned (for a badge, a course certificate or a milestone) for the people the user manages, newest first: who, why, amount in VND, payroll month and stage (pending approval, scheduled, on_payslip, canceled). Filter by payroll month, member or status. Decide pending ones with decide_reward.

Cần quyền: Chốt lương

Tham số (6)
TênKiểuMô tả
limitintegerRows per page, 1-50 (default 20).
cursorstringnext_cursor from the previous page; leave out for the first page.
monthstringPayroll month YYYY-MM.
member_idstringOnly this member.
statusstringOnly rewards in this status. Giá trị: pendingapprovedcanceled
organization_idstringTổ 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.
record_payroll_payoutNhạy cảmTốn 2 đơn vịTạm tắt

Ghi nhận đã chi lương

Records that approved pay of a payroll period was already paid outside CTAS, for the people in member_ids (at most 50) or the whole verified period. It does not transfer or send any money; it only marks payslips as paid, which is final. Two steps: the first call previews who and the total net in VND with a confirmation_id; call again with it once the user agrees.

Cần quyền: Chốt lương

Tham số (5)
TênKiểuMô tả
period_idbắt buộcstringPayroll period id, from list_payroll_periods.
member_idsstring[]Member ids (from get_payroll_board), at most 50. Leave out to record the whole verified period as paid.
organization_idstringTổ 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_keystringKhoá chống lặp tuỳ chọn: gọi lại cùng khoá không tạo bản ghi thứ hai.
confirmation_idstringMã xác nhận do lần gọi xem trước trả về; gọi lại với mã này mới thực hiện.
reopen_payrollNhạy cảmTốn 2 đơn vị

Mở lại lương đã chốt

Reopens closed pay for up to 50 people of a payroll period so it can be corrected and closed again; their sent payslips are withdrawn until then. Pay already recorded as paid cannot be reopened. Two steps: the first call previews who and their current net in VND with a confirmation_id; call again with it once the user agrees.

Cần quyền: Chốt lương

Tham số (5)
TênKiểuMô tả
period_idbắt buộcstringPayroll period id, from list_payroll_periods.
member_idsbắt buộcstring[]Member ids (from get_payroll_board), at most 50. Required.
organization_idstringTổ 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_keystringKhoá chống lặp tuỳ chọn: gọi lại cùng khoá không tạo bản ghi thứ hai.
confirmation_idstringMã xác nhận do lần gọi xem trước trả về; gọi lại với mã này mới thực hiện.

Trả lời câu hỏi phiếu lương

Answers a staff member's payslip question (query_id from list_payslip_queries) with a note of at least 5 characters, marks it resolved and notifies the member. It does not change the payslip; use adjust_payslip for that.

Cần quyền: Chốt lương

Tham số (4)
TênKiểuMô tả
query_idbắt buộcstringQuestion id.
notebắt buộcstringThe answer the member will read.
organization_idstringTổ 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_keystringKhoá chống lặp tuỳ chọn: gọi lại cùng khoá không tạo bản ghi thứ hai.
save_reward_ruleNhạy cảm

Lưu quy tắc thưởng

Creates a learning reward rule, or updates one when rule_id is given: trigger badge (badge_id), certificate (course_id, or none for any course) or milestone (milestone.count of badges or certificates), amount in VND (1,000 or more), optional label, and status active or paused. Only achievements from now on earn; organization-wide roles only. Two steps: preview with a confirmation_id, then call again with it.

Cần quyền: Chốt lương

Tham số (12)
TênKiểuMô tả
rule_idstringThe rule to change; leave out to create one.
triggerstringRequired when creating. Giá trị: badgecertificatemilestone
badge_idstringBadge (trigger badge), from list_reward_rules with_options.
course_idstringCourse whose certificate pays (trigger certificate); leave out for any course.
milestoneobjectTrigger milestone: pay at the count-th badge or certificate.
amountintegerVND. Required when creating.
labelobjectCustom name shown on the payslip; generated from the target when left out.
show_to_learnerbooleanTell learners the reward exists.
statusstring Giá trị: activepaused
organization_idstringTổ 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_keystringKhoá chống lặp tuỳ chọn: gọi lại cùng khoá không tạo bản ghi thứ hai.
confirmation_idstringMã xác nhận do lần gọi xem trước trả về; gọi lại với mã này mới thực hiện.

Bật/tắt duyệt thưởng

Sets whether learning rewards need a manager's approval (decide_reward) before they are paid, or go straight onto the payslip of their payroll month. Organization-wide roles only. Two steps: preview with a confirmation_id, then call again with it.

Cần quyền: Chốt lương

Tham số (4)
TênKiểuMô tả
require_approvalbắt buộcbooleantrue: rewards wait for approval.
organization_idstringTổ 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_keystringKhoá chống lặp tuỳ chọn: gọi lại cùng khoá không tạo bản ghi thứ hai.
confirmation_idstringMã xác nhận do lần gọi xem trước trả về; gọi lại với mã này mới thực hiện.
signoff_department_payrollNhạy cảmTốn 2 đơn vị

Ký duyệt lương phòng ban

Signs off (action sign) or takes back the sign-off (action unsign) of one department or store on a closed payroll period. Taking a sign-off back is for organization-wide roles only. Two steps: the first call previews the department's people, payslip counts and total net in VND with a confirmation_id; call again with it once the user agrees.

Cần quyền: Chốt lương

Tham số (6)
TênKiểuMô tả
period_idbắt buộcstringPayroll period id, from list_payroll_periods.
department_idbắt buộcstringDepartment or store id.
actionbắt buộcstringsign, or unsign to take a sign-off back. Giá trị: signunsign
organization_idstringTổ 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_keystringKhoá chống lặp tuỳ chọn: gọi lại cùng khoá không tạo bản ghi thứ hai.
confirmation_idstringMã xác nhận do lần gọi xem trước trả về; gọi lại với mã này mới thực hiện.
verify_payrollNhạy cảmTốn 2 đơn vị

Duyệt lương

Approves closed pay of a payroll period: the people in member_ids (at most 50), or the whole period when left out (every payslip must be closed). Organization-wide payroll managers only. Two steps: the first call previews who would be approved and the total net in VND with a confirmation_id; call again with it once the user agrees.

Cần quyền: Chốt lương

Tham số (5)
TênKiểuMô tả
period_idbắt buộcstringPayroll period id, from list_payroll_periods.
member_idsstring[]Member ids (from get_payroll_board), at most 50. Leave out to approve the whole closed period.
organization_idstringTổ 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_keystringKhoá chống lặp tuỳ chọn: gọi lại cùng khoá không tạo bản ghi thứ hai.
confirmation_idstringMã xác nhận do lần gọi xem trước trả về; gọi lại với mã này mới thực hiện.

Thông báo · 6

Huỷ hẹn giờ thông báo

Takes a scheduled announcement (announcement_id, status scheduled) off the schedule so it is not sent; it is kept as a draft and can be edited with draft_announcement or sent later with send_announcement. Fails for a notice that is not scheduled.

Cần quyền: Gửi thông báo

Tham số (3)
TênKiểuMô tả
announcement_idbắt buộcstringid of the scheduled notice.
organization_idstringTổ 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_keystringKhoá chống lặp tuỳ chọn: gọi lại cùng khoá không tạo bản ghi thứ hai.
delete_announcementGhiXoá / huỷ

Xoá hoặc thu hồi thông báo

Deletes a draft or scheduled announcement (announcement_id), pictures included. For one already sent it recalls it instead: it disappears from every recipient's app and the record stays as recalled; the monthly send it used is not returned. A recalled notice is left as it is.

Cần quyền: Gửi thông báo

Tham số (3)
TênKiểuMô tả
announcement_idbắt buộcstringid from list_org_announcements.
organization_idstringTổ 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_keystringKhoá chống lặp tuỳ chọn: gọi lại cùng khoá không tạo bản ghi thứ hai.

Soạn nháp thông báo

Creates an announcement draft, or changes a draft or scheduled one when announcement_id is given (only the fields passed change; a scheduled notice goes back to draft). Body is plain text. Audience: all, or any mix of member_ids, department_ids, position_ids and role keys (from list_org_announcements with_options). Nothing is sent; the answer says how many people the audience reaches today. Send it with send_announcement.

Cần quyền: Gửi thông báo

Tham số (9)
TênKiểuMô tả
announcement_idstringOnly to change an existing draft or scheduled notice.
titlestringRequired before sending.
summarystringOne line shown in the list and the push.
bodystringPlain text; required before sending.
require_ackbooleanAsk every recipient to confirm they have read it.
emailbooleanAlso email recipients who have an address.
audienceobjectWho receives it; replaces the previous audience when given.
organization_idstringTổ 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_keystringKhoá chống lặp tuỳ chọn: gọi lại cùng khoá không tạo bản ghi thứ hai.

Xem chi tiết thông báo của tổ chức

Returns one of the organization's announcements (announcement_id from list_org_announcements) as its sender sees it: text, audience, channels, status, schedule and delivery numbers. Set recipients to also page through who received it: all, unopened, unseen, unacknowledged or unreachable (no phone that can take a push). Reading here does not mark anything as read.

Cần quyền: Gửi thông báo

Tham số (5)
TênKiểuMô tả
announcement_idbắt buộcstringid from list_org_announcements.
recipientsstringAlso list recipients, filtered this way. Leave out for the notice alone. Giá trị: allunopenedunseenunacknowledgedunreachable
limitintegerRows per page, 1-50 (default 20).
cursorstringnext_cursor from the previous page; leave out for the first page.
organization_idstringTổ 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 đã gửi của tổ chức

Lists the organization's announcements the signed-in sender can see: status sent (default, newest first, recalled ones included), scheduled or draft, with title, summary, audience, recipient count and read/acknowledge numbers, plus the month's quota and the count per status. Set with_options to also get the departments, job titles and roles the sender may address (ids for draft_announcement).

Cần quyền: Gửi thông báo

Tham số (5)
TênKiểuMô tả
limitintegerRows per page, 1-50 (default 20).
cursorstringnext_cursor from the previous page; leave out for the first page.
statusstringWhich tab: sent (default), scheduled or draft. Giá trị: sentscheduleddraft
with_optionsbooleanAlso return who the sender may address and how long notices are kept (default false).
organization_idstringTổ 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.
send_announcementNhạy cảm

Gửi thông báo cho nhân sự

Sends a drafted announcement (announcement_id from draft_announcement) to its audience now, or schedules it when scheduled_at is given (up to 60 days ahead). Recipients get a push they cannot mute and it counts against the monthly quota; once sent it can be recalled but not unsent. The first call returns a preview (title, how many people it reaches, how many have no phone or push turned off, quota left) and a confirmation_id.

Cần quyền: Gửi thông báo

Tham số (5)
TênKiểuMô tả
announcement_idbắt buộcstringid of the draft to send.
scheduled_atstringISO 8601 with offset (Vietnam is +07:00) to send later instead of now.
organization_idstringTổ 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_keystringKhoá chống lặp tuỳ chọn: gọi lại cùng khoá không tạo bản ghi thứ hai.
confirmation_idstringMã xác nhận do lần gọi xem trước trả về; gọi lại với mã này mới thực hiện.

Quy trình · 14

Xoá phân công quy trình

Deletes a process assignment (assignment_id): its rounds that have not opened are withdrawn, while open, submitted and missed rounds and their submissions stay on record. To stop it for a while instead, use set_process_assignment_state with paused.

Cần quyền: Giao quy trình cho nhân sự

Tham số (3)
TênKiểuMô tả
assignment_idbắt buộcstringid of the assignment to delete.
organization_idstringTổ 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_keystringKhoá chống lặp tuỳ chọn: gọi lại cùng khoá không tạo bản ghi thứ hai.
delete_process_formGhiXoá / huỷ

Xoá biểu mẫu quy trình

Deletes a process form (form_id). Submissions already filed keep their own snapshot of the questions; to stop new work, pause or delete the assignments that use the form. Setting status archived with save_process_form is the gentler alternative.

Cần quyền: Soạn biểu mẫu quy trình

Tham số (3)
TênKiểuMô tả
form_idbắt buộcstringid of the form to delete.
organization_idstringTổ 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_keystringKhoá chống lặp tuỳ chọn: gọi lại cùng khoá không tạo bản ghi thứ hai.

Nhân bản biểu mẫu quy trình

Copies a process form (form_id) with all its questions into a new draft at version 1 (its name gets a copy suffix), to adapt for another shop or shift without touching the original. Counts against the plan's number of forms.

Cần quyền: Soạn biểu mẫu quy trình

Tham số (3)
TênKiểuMô tả
form_idbắt buộcstringid of the form to copy.
organization_idstringTổ 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_keystringKhoá chống lặp tuỳ chọn: gọi lại cùng khoá không tạo bản ghi thứ hai.

Xem một phân công quy trình

Returns one process assignment (assignment_id) with all its settings, whether the caller is among its recipients, and who it reaches on audience_date (default today: a count and up to 50 names). Set with_occurrences to also page through its rounds of work, filtered by status (scheduled, open, submitted, accepted, rejected, missed, skipped, canceled) and an opening-date range of at most 62 days.

Cần quyền: Giao quy trình cho nhân sự

Tham số (9)
TênKiểuMô tả
assignment_idbắt buộcstringid from list_process_assignments.
audience_datestringYYYY-MM-DD to resolve the audience on (shift audiences depend on the day).
with_occurrencesbooleanAlso list rounds of work (default false).
occurrence_statusstring Giá trị: scheduledopensubmittedacceptedrejectedmissedskippedcanceled
date_fromstringRounds opening on or after this day.
date_tostringRounds opening on or before this day.
limitintegerRows per page, 1-50 (default 20).
cursorstringnext_cursor from the previous page; leave out for the first page.
organization_idstringTổ 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.
get_process_complianceĐọcTốn 2 đơn vị

Báo cáo tuân thủ quy trình

Returns the process compliance report for a date range of at most 92 days (default the last 30): per department, member or assignment (group_by), how many rounds were due, done on time, late and missed, and the completion rate, worst first. Skipped rounds are left out of the rate. History older than the plan keeps is refused.

Cần quyền: Xem & duyệt kết quả quy trình

Tham số (4)
TênKiểuMô tả
group_bystringDefault department. Giá trị: departmentmemberassignment
date_fromstringYYYY-MM-DD; default 30 days before date_to.
date_tostringYYYY-MM-DD; default today.
organization_idstringTổ 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 biểu mẫu quy trình

Returns one process form (form_id from list_process_forms) with its full question tree: keys, types, labels, required flags, conditions and repeats. Pass test_answers (an object keyed by question key) to check a sample fill-in with the same rules as a real submission; the answer says what would be accepted or which questions fail. Nothing is saved.

Cần quyền: Soạn biểu mẫu quy trình

Tham số (3)
TênKiểuMô tả
form_idbắt buộcstringid from list_process_forms.
test_answersobjectOptional sample answers keyed by question key, to validate without saving.
organization_idstringTổ 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 phân công quy trình

Lists the organization's process assignments (a form handed to an audience on a schedule) newest first, with form name, audience, completion mode (per member, per place, per organization), recurrence, time window, review mode, status (active, paused, ended) and how many upcoming or open rounds each has. Filter by status. get_process_assignment shows one with its audience and rounds.

Cần quyền: Giao quy trình cho nhân sự

Tham số (4)
TênKiểuMô tả
limitintegerRows per page, 1-50 (default 20).
cursorstringnext_cursor from the previous page; leave out for the first page.
statusstring Giá trị: activepausedended
organization_idstringTổ 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 biểu mẫu quy trình

Lists the organization's process forms (checklists) newest first with name, status (draft, active, archived), tags, version and question count, without the questions themselves (use get_process_form). Filter by status or one tag. Set with_templates to also get the built-in templates (key, name, question count) that save_process_form can start a new form from.

Cần quyền: Soạn biểu mẫu quy trình

Tham số (6)
TênKiểuMô tả
limitintegerRows per page, 1-50 (default 20).
cursorstringnext_cursor from the previous page; leave out for the first page.
statusstring Giá trị: draftactivearchived
tagstringOnly forms carrying this tag.
with_templatesbooleanAlso list the built-in templates (default false).
organization_idstringTổ 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 quy trình đã nộp

Lists submitted process checklists newest first: who filed it (and who helped), when, whether it was late or outside the store, the answers with a short summary, and the review state (pending, accepted, rejected). Filter by assignment_id and a submission-date range of at most 31 days (default the last 7 days). Photos are not included.

Cần quyền: Xem & duyệt kết quả quy trình

Tham số (6)
TênKiểuMô tả
limitintegerRows per page, 1-50 (default 20).
cursorstringnext_cursor from the previous page; leave out for the first page.
assignment_idstringOnly submissions of this assignment.
date_fromstringYYYY-MM-DD, first submission day.
date_tostringYYYY-MM-DD, last submission day (default today).
organization_idstringTổ 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.

Duyệt phiếu quy trình

Reviews a submitted process checklist (submission_id from list_process_submissions): accepted, or rejected with a note saying what to fix. Rejecting reopens the same round so the person can submit again and they are notified. The note is required when rejecting.

Cần quyền: Xem & duyệt kết quả quy trình

Tham số (5)
TênKiểuMô tả
submission_idbắt buộcstring
statusbắt buộcstring Giá trị: acceptedrejected
notestringRequired when rejecting.
organization_idstringTổ 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_keystringKhoá chống lặp tuỳ chọn: gọi lại cùng khoá không tạo bản ghi thứ hai.

Giao quy trình

Creates a process assignment (form_id + audience + recurrence are required), or changes one when assignment_id is given (only the parts passed change). Today's rounds of work are created at once and rounds not yet open are rebuilt on change. audience.mode: all, manual (org_member_ids), department (department_ids), position, role, shift, expression or union. recurrence.mode: once (date), daily, weekly (weekdays 1-7), monthly (day_of_month or last_day), per_shift, on_demand.

Cần quyền: Giao quy trình cho nhân sự

Tham số (14)
TênKiểuMô tả
assignment_idstringOnly to change an existing assignment.
form_idstringForm to hand out (an active one from list_process_forms).
namestringOptional label; the form name is used otherwise.
audienceobject{mode, org_member_ids?, department_ids?, position_ids?, role_keys?, shift_template_ids?, exclude_member_ids?, include_paused?, expression?}.
completion_modestringper_member: everyone fills one in; per_place: one per store; per_org: one for the whole organization. Giá trị: per_memberper_placeper_org
place_scopeobject{department_ids} for per_place.
recurrenceobject{mode, date?, weekdays?, day_of_month?, last_day?, skip_days_off?, shift_template_ids?}.
windowobject{opens_at, due_at, closes_at: {anchor: day_start|fixed|shift_start|shift_end|check_in, offset_min?, time? HH:MM}, allow_late?}.
remindersobject[]Up to 5 of {at: {anchor: opens_at|due_at|closes_at, offset_min}, channels: [push, inapp], to: assignee|manager|both}.
review_modestringreview: a manager accepts or returns each submission. Giá trị: nonereview
require_geofencebooleanRefuse submissions made away from the store.
statusstring Giá trị: activepausedended
organization_idstringTổ 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_keystringKhoá 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 biểu mẫu quy trình

Creates a process form, or changes one when form_id is given (only the fields passed change). A new form can start from a built-in template key (list_process_forms with_templates) and/or a questions tree; the server cleans and validates the tree and refuses features the plan does not include (conditions). Status draft forms can be edited freely; set active to let assignments use it.

Cần quyền: Soạn biểu mẫu quy trình

Tham số (11)
TênKiểuMô tả
form_idstringOnly to change an existing form.
templatestringNew forms only: built-in template key to start from.
namestring
descriptionstring
tagsstring[]
statusstring Giá trị: draftactivearchived
allow_nabooleanLet people answer "not applicable" (default true).
na_requires_notebooleanA "not applicable" answer needs a reason.
schemaobject[]The questions, as a list of nodes like the one get_process_form returns: each has key, type (section, text, number, choice, checkbox, photo, signature, date, time, repeat, heading, instruction...), label {vi, en?}, required, and children for section/repeat. Replaces the whole tree.
organization_idstringTổ 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_keystringKhoá chống lặp tuỳ chọn: gọi lại cùng khoá không tạo bản ghi thứ hai.

Tạm dừng hoặc tiếp tục phân công

Pauses or resumes a process assignment (assignment_id). paused: rounds that have not opened are cancelled, open and filed ones stay. active: rounds are generated again from today. Setting the state it already has changes nothing.

Cần quyền: Giao quy trình cho nhân sự

Tham số (4)
TênKiểuMô tả
assignment_idbắt buộcstringid from list_process_assignments.
statebắt buộcstring Giá trị: pausedactive
organization_idstringTổ 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_keystringKhoá chống lặp tuỳ chọn: gọi lại cùng khoá không tạo bản ghi thứ hai.

Mở một lượt quy trình ngay

Opens one round of work of an active process assignment right now (typically recurrence on_demand), for the whole organization or one department or member (scope), with an optional due_at and context values shown prefilled on the checklist. external_ref makes it safe to repeat: the same ref returns the round already opened. Needs the plan's process API feature.

Cần quyền: Giao quy trình cho nhân sự

Tham số (7)
TênKiểuMô tả
assignment_idbắt buộcstringid of an active assignment.
scopeobjectWho the round is for (default the whole organization).
due_atstringISO 8601 with offset; default from the assignment window.
external_refstringYour reference (order no., delivery no.); repeats return the same round.
contextobjectValues shown prefilled, e.g. expected quantities.
organization_idstringTổ 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_keystringKhoá chống lặp tuỳ chọn: gọi lại cùng khoá không tạo bản ghi thứ hai.

Danh mục · 13

delete_departmentGhiXoá / huỷ

Xoá phòng ban / cửa hàng

Deletes a department or store (department_id from get_org_structure). Staff still in it are left without a department, so check search_staff department_id first and move them with update_staff_member.

Cần quyền: Quản lý dữ liệu chủ

Tham số (3)
TênKiểuMô tả
department_idbắt buộcstringDepartment id, from get_org_structure.
organization_idstringTổ 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_keystringKhoá chống lặp tuỳ chọn: gọi lại cùng khoá không tạo bản ghi thứ hai.
delete_holidayGhiXoá / huỷ

Xoá ngày lễ

Deletes one holiday (holiday_id from get_org_structure parts=holidays). The day counts as an ordinary day again in open payroll periods.

Cần quyền: Quản lý dữ liệu chủ

Tham số (3)
TênKiểuMô tả
holiday_idbắt buộcstringHoliday id, from get_org_structure (holidays).
organization_idstringTổ 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_keystringKhoá chống lặp tuỳ chọn: gọi lại cùng khoá không tạo bản ghi thứ hai.
delete_positionGhiXoá / huỷ

Xoá vị trí công việc

Deletes a job position (position_id from get_org_structure). Refused while somebody holds it or a training rule uses it; archive it instead with save_position status=archived.

Cần quyền: Quản lý dữ liệu chủ

Tham số (3)
TênKiểuMô tả
position_idbắt buộcstringPosition id, from get_org_structure.
organization_idstringTổ 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_keystringKhoá chống lặp tuỳ chọn: gọi lại cùng khoá không tạo bản ghi thứ hai.
delete_shift_templateGhiXoá / huỷ

Xoá mẫu ca

Deletes a shift template (shift_template_id from get_org_structure). Shifts already on the schedule keep the times they were given.

Cần quyền: Quản lý dữ liệu chủ

Tham số (3)
TênKiểuMô tả
shift_template_idbắt buộcstringShift template id, from get_org_structure.
organization_idstringTổ 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_keystringKhoá chống lặp tuỳ chọn: gọi lại cùng khoá không tạo bản ghi thứ hai.

Xoá chế độ làm việc

Deletes a work arrangement (work_arrangement_id from get_org_structure). Staff on it fall back to the organization defaults for shifts and days off.

Cần quyền: Quản lý dữ liệu chủ

Tham số (3)
TênKiểuMô tả
work_arrangement_idbắt buộcstringWork arrangement id, from get_org_structure.
organization_idstringTổ 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_keystringKhoá chống lặp tuỳ chọn: gọi lại cùng khoá không tạo bản ghi thứ hai.

Xem cơ cấu tổ chức

Returns the organization's departments (stores, offices, with head count and opening hours), positions, shift templates (times, breaks, pay mode), work arrangements (fixed or rostered shifts, days off, pay cycle) and public holidays of a year, in one call. Use parts to fetch only some.

Cần quyền: Vào khu quản trị

Tham số (4)
TênKiểuMô tả
partsstring[]Which lists (default all): departments, positions, shift_templates, work_arrangements, holidays. Giá trị: departmentspositionsshift_templateswork_arrangementsholidays
holiday_yearintegerYear of the holidays (default this year).
include_archived_positionsboolean
organization_idstringTổ 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.

Sắp xếp phòng ban

Sets the order departments and stores are listed in across CTAS Work: pass every department id (from get_org_structure) in the new order. Returns the reordered list.

Cần quyền: Quản lý dữ liệu chủ

Tham số (3)
TênKiểuMô tả
department_idsbắt buộcstring[]All department ids, first to last.
organization_idstringTổ 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_keystringKhoá 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 phòng ban / cửa hàng

Creates a department or store, or edits one when department_id is given: name, kind (office, store, warehouse...), head of department, leave template, address and opening hours. The map pin and WiFi used for check-in are set in the CTAS Work app. The plan may limit how many departments an organization has.

Cần quyền: Quản lý dữ liệu chủ

Tham số (13)
TênKiểuMô tả
department_idstringEdit this department (get_org_structure); leave out to create.
namestringRequired when creating.
kindstring Giá trị: officestorewarehousefactorykitchensiteother
colorstring
iconstring
lead_member_idstringHead of the department (staff id from search_staff).
leave_policy_idstringLeave template for its staff.
location_namestring
addressstring
opens_atstringHH:MM, with closes_at.
closes_atstringHH:MM, with opens_at.
organization_idstringTổ 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_keystringKhoá 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 ngày lễ

Adds a holiday, or edits one when holiday_id is given: date, name, and who it is for. Leave department_ids and member_ids empty for the whole organization; otherwise only those departments plus those people get the day off. A date can hold one holiday.

Cần quyền: Quản lý dữ liệu chủ

Tham số (9)
TênKiểuMô tả
holiday_idstringEdit this holiday (get_org_structure parts=holidays); leave out to add.
datestringYYYY-MM-DD. Required when adding.
namestringRequired when adding.
department_idsstring[]Only these departments (empty = everyone).
member_idsstring[]And these staff members.
iconstring
colorstring
organization_idstringTổ 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_keystringKhoá 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 vị trí công việc

Creates a job position, or edits one when position_id is given: name, description, the department it belongs to (none for organization-wide), level 1-20, and status (active or archived). Names must be unique in the organization.

Cần quyền: Quản lý dữ liệu chủ

Tham số (10)
TênKiểuMô tả
position_idstringEdit this position (get_org_structure); leave out to create.
namestringRequired when creating.
descriptionstring
department_idstringDepartment it belongs to; null for organization-wide.
levelinteger
iconstring
colorstring
statusstring Giá trị: activearchived
organization_idstringTổ 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_keystringKhoá 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 mẫu ca

Creates a shift template, or edits one when shift_template_id is given: label, start and end time (HH:MM; an end before the start runs past midnight), up to 4 breaks, short code and colour tone for the roster, and pay mode (base, hourly_rate with pay_rate VND, or multiplier with pay_multiplier as a percent, e.g. 130).

Cần quyền: Quản lý dữ liệu chủ

Tham số (13)
TênKiểuMô tả
shift_template_idstringEdit this template (get_org_structure); leave out to create.
labelstringRequired when creating, e.g. "Ca sáng".
starts_atstringHH:MM. Required when creating.
ends_atstringHH:MM. Required when creating.
breaksobject[]Unpaid breaks inside the shift.
short_codestring1-2 letters/digits shown on the roster grid.
tonestring Giá trị: greenorangeviolettealpinkindigobrownolive
colorstring
pay_modestring Giá trị: basehourly_ratemultiplier
pay_rateintegerVND per hour when pay_mode is hourly_rate.
pay_multiplierintegerPercent of the member's own hourly pay when pay_mode is multiplier (130 = 130%).
organization_idstringTổ 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_keystringKhoá 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 chế độ làm việc

Creates a work arrangement, or edits one when work_arrangement_id is given: shift mode (fixed shift, rostered, none), attendance mode (punch, scheduled_punch, schedule = paid by the roster without clocking), full-day hours, weekly and alternating days off, standard days per month and pay cycle. Unset fields follow the organization defaults.

Cần quyền: Quản lý dữ liệu chủ

Tham số (17)
TênKiểuMô tả
work_arrangement_idstringEdit this arrangement (get_org_structure); leave out to create.
namestringRequired when creating.
shift_modestringRequired when creating. Giá trị: fixedrosterednone
shift_template_idstringThe fixed shift, when shift_mode is fixed.
attendance_modestring Giá trị: punchscheduled_punchschedule
full_day_hoursnumber
work_basisstring Giá trị: dayhour
standard_days_modestring Giá trị: fixedcalendar
standard_days_per_monthinteger
weekly_days_offinteger[]Days off every week, 0 = Sunday … 6 = Saturday.
alternate_days_offinteger[]Days off every other week, counted from alternate_anchor.
alternate_anchorstringA week that has the alternate days off, YYYY-MM-DD.
pay_cyclestring Giá trị: monthlysemi_monthly
cutoff_dayinteger
paydayinteger
organization_idstringTổ 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_keystringKhoá chống lặp tuỳ chọn: gọi lại cùng khoá không tạo bản ghi thứ hai.

Thêm ngày lễ theo luật

Adds Vietnam's statutory public holidays for a year (default this year) to the organization's holiday list, skipping dates it already has. Returns the days added and the days skipped.

Cần quyền: Quản lý dữ liệu chủ

Tham số (3)
TênKiểuMô tả
yearintegerYear to fill (default this year).
organization_idstringTổ 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_keystringKhoá chống lặp tuỳ chọn: gọi lại cùng khoá không tạo bản ghi thứ hai.

Vai trò · 5

delete_roleNhạy cảmXoá / huỷ

Xoá vai trò tự tạo

Deletes a custom role (role_id from list_roles) that no active staff member holds; move its holders to another role first with save_member_terms. Built-in roles cannot be deleted. The first call returns a preview; call again with confirmation_id once the user agrees.

Cần quyền: Quản lý vai trò

Tham số (4)
TênKiểuMô tả
role_idbắt buộcstringCustom role id, from list_roles.
organization_idstringTổ 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_keystringKhoá chống lặp tuỳ chọn: gọi lại cùng khoá không tạo bản ghi thứ hai.
confirmation_idstringMã xác nhận do lần gọi xem trước trả về; gọi lại với mã này mới thực hiện.

Xem quyền mở rộng của vai trò có sẵn

Shows the CTAS Learn rights the organization has added to the built-in manager and lead roles (extended) and the ones it may add (allowed: manager may get learn.manage, learn.assign, learn.report; lead only learn.report).

Cần quyền: Quản lý vai trò

Tham số (1)
TênKiểuMô tả
organization_idstringTổ 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 vai trò và quyền

Lists the organization's roles: built-in (admin, manager, lead, trainer, staff) and its own, each with key, name, permissions, scope (org or department) and how many active staff hold it. Set with_catalogue for every CTAS Work permission key with its name and meaning, to build or edit a role.

Cần quyền: Vào khu quản trị

Tham số (4)
TênKiểuMô tả
with_cataloguebooleanAlso return the permission catalogue (default false).
limitintegerRows per page, 1-50 (default 20).
cursorstringnext_cursor from the previous page; leave out for the first page.
organization_idstringTổ 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.
save_roleNhạy cảm

Lưu vai trò tự tạo

Creates a custom role, or edits one when role_id is given: name, description, colour, scope (org-wide or only the holder's departments) and its CTAS Work permissions (keys from list_roles with_catalogue). Rights in other CTAS products are kept. The first call returns a preview of rights added and removed; call again with confirmation_id once the user agrees.

Cần quyền: Quản lý vai trò

Tham số (9)
TênKiểuMô tả
role_idstringEdit this custom role (id from list_roles); leave out to create. Built-in roles cannot be edited.
namestringRequired when creating.
descriptionstring
colorstring
scopestringdepartment: the holder only reaches their own departments. Giá trị: orgdepartment
permissionsstring[]The role's full set of CTAS Work permission keys. Required when creating.
organization_idstringTổ 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_keystringKhoá chống lặp tuỳ chọn: gọi lại cùng khoá không tạo bản ghi thứ hai.
confirmation_idstringMã xác nhận do lần gọi xem trước trả về; gọi lại với mã này mới thực hiện.

Sửa quyền mở rộng của vai trò có sẵn

Sets which CTAS Learn rights the built-in manager and lead roles get on top of their CTAS Work rights (see get_role_extensions for what is allowed). Each role sent is replaced; a role left out keeps its current rights. The first call returns a preview; call again with confirmation_id once the user agrees.

Cần quyền: Quản lý vai trò

Tham số (5)
TênKiểuMô tả
managerstring[]Rights the HR manager role gets. Giá trị: learn.managelearn.assignlearn.report
leadstring[]Rights the department lead role gets (a subset of the manager's). Giá trị: learn.report
organization_idstringTổ 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_keystringKhoá chống lặp tuỳ chọn: gọi lại cùng khoá không tạo bản ghi thứ hai.
confirmation_idstringMã xác nhận do lần gọi xem trước trả về; gọi lại với mã này mới thực hiện.

Cài đặt và tổ chức · 11

delete_setting_itemNhạy cảmXoá / huỷ

Xoá một mục cài đặt

Deletes one item of a list settings section: leave_policies (not the default, nor one people are on), advance_policies, payroll_settings (the department or member inherits again), salary_templates or notification_policies. item_id comes from get_settings. The first call shows the item and returns a confirmation_id; the second deletes it.

Cần quyền: Sửa cài đặt nghiệp vụ

Tham số (5)
TênKiểuMô tả
sectionbắt buộcstring Giá trị: leave_policiesadvance_policiespayroll_settingssalary_templatesnotification_policies
item_idbắt buộcstringid of the item, from get_settings.
organization_idstringTổ 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_keystringKhoá chống lặp tuỳ chọn: gọi lại cùng khoá không tạo bản ghi thứ hai.
confirmation_idstringMã xác nhận do lần gọi xem trước trả về; gọi lại với mã này mới thực hiện.

Xem thông tin tổ chức

Returns the organization's profile and defaults: name, sector, contact, business verification status, pay cycle (cutoff day, payday), standard working days, weekly days off, check-in rules (location check, web punch, punch window) and currency. Set with_location_check for how last month's punches were verified (GPS, WiFi, both, none).

Cần quyền: Vào khu quản trị

Tham số (2)
TênKiểuMô tả
with_location_checkbooleanAlso count last month's punches by how they were verified.
organization_idstringTổ 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 gói CTAS Work của tổ chức

Returns the organization's CTAS Work plan: tier, state (trial, active, expired), source, expiry date, each limit with how much is used (staff, admins, departments, roles...), which features are on, add-ons held, and the prepaid periods bought. Read-only; purchases are made outside this connection.

Cần quyền: Vào khu quản trị

Tham số (2)
TênKiểuMô tả
with_addonsbooleanAlso list the CTAS Work add-ons and which ones the organization holds.
organization_idstringTổ 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 cài đặt tổ chức

Returns one settings section of the organization: overtime, tax, insurance, leave_policy (default leave template), leave_policies, advance_policies, payroll_settings, salary_templates, notification_policies, approval_settings, todo_digest or attendance_compliance, with a hint of the fields update_settings takes. List sections return their items with ids. For payroll_settings, pass scope (org, group, member) + scope_ref_id + month to get the effective settings and standard days.

Cần quyền: Vào khu quản trị

Tham số (5)
TênKiểuMô tả
sectionbắt buộcstring Giá trị: overtimetaxinsuranceleave_policyapproval_settingstodo_digestattendance_complianceleave_policiesadvance_policiespayroll_settingssalary_templatesnotification_policies
scopestringpayroll_settings only: whose effective settings (group = department). Giá trị: orggroupmember
scope_ref_idstringDepartment or staff member id for scope group/member.
monthstringYYYY-MM for the standard-days preview (default this month).
organization_idstringTổ 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 hợp đồng lao động

Lists labour contracts: who, type (probation, official, seasonal, collab), start and end date or no end, and status (active, expiring, expired, draft). Filter by member_id. Scanned contract files are not returned, only whether one is attached.

Cần quyền: Vào khu quản trị

Tham số (4)
TênKiểuMô tả
member_idstringOnly this staff member's contracts.
limitintegerRows per page, 1-50 (default 20).
cursorstringnext_cursor from the previous page; leave out for the first page.
organization_idstringTổ 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ử mẫu lương

Works out what salary components would pay one staff member (member_id) in one month (YYYY-MM), from the member's real attendance, without saving anything. Give components as a draft list, or salary_template_id to try a saved template's components; member_components and component_overrides add the person's own lines and per-line switches. Returns each line with its amount and the totals.

Cần quyền: Vào khu quản trị

Tham số (7)
TênKiểuMô tả
member_idbắt buộcstringStaff member id (search_staff).
monthbắt buộcstringYYYY-MM.
salary_template_idstringUse this saved template's components when components is left out.
componentsobject[]Draft lines: {key?, label, kind allowance|deduction, calc fixed|conditional, amount, measure?, condition?}.
member_componentsobject[]Lines of this person alone, same shape.
component_overridesobject[]{key, enabled, amount?} per template line.
organization_idstringTổ 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.
rerun_leave_grantsNhạy cảmTốn 5 đơn vị

Tính lại phép đã cộng theo tháng

Recomputes the monthly annual-leave grants of past months under the leave policies now in force, for everybody in reach or some departments or staff, and returns whose balance changed (before and after). Use it after a policy or a person's policy changed retroactively. Balances change, so the first call returns a preview and a confirmation_id.

Cần quyền: Sửa cài đặt nghiệp vụ

Tham số (6)
TênKiểuMô tả
monthsbắt buộcstring[]Months as YYYY-MM, not in the future.
member_idsstring[]
department_idsstring[]
organization_idstringTổ 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_keystringKhoá chống lặp tuỳ chọn: gọi lại cùng khoá không tạo bản ghi thứ hai.
confirmation_idstringMã xác nhận do lần gọi xem trước trả về; gọi lại với mã này mới thực hiện.

Lưu huy hiệu của tổ chức

Creates an organization badge, or edits one when badge_id is given: name and description (Vietnamese, optional English), criteria, category, tier, whether it repeats, visibility and status (draft, active, archived). allow_hiding alone changes the organization setting that lets staff hide badges on their profile.

Cần quyền: Vào khu quản trị

Tham số (16)
TênKiểuMô tả
badge_idstringEdit this badge (ids from list_badges); leave out to create.
keystringOptional stable key, lowercase.
nameobject{vi, en} name; vi required when creating (max 120).
descriptionobject{vi, en} what the badge means.
criteria_textobject{vi, en} how to earn it.
categorystring Giá trị: profilelearningprocessattendancetenurecustom
tierstring Giá trị: bronzesilvergoldplatinumdiamond
claim_modestring Giá trị: automanual
repeatstring Giá trị: noneweeklymonthlyyearly
visibilitystring Giá trị: publicprivate
sort_orderinteger
statusstring Giá trị: draftactivearchived
artworkobjectBuilt-in icon and colours (hex without #); uploaded images are made in the app.
allow_hidingbooleanOrganization setting: may staff hide badges on their profile. Send it alone.
organization_idstringTổ 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_keystringKhoá chống lặp tuỳ chọn: gọi lại cùng khoá không tạo bản ghi thứ hai.
save_contractNhạy cảm

Lưu hợp đồng lao động

Records a labour contract for a staff member, or edits one when contract_id is given: type, start and end date (or no_term), status. With create_term the contract also adds the employment version it brings from its start date (term.name, term.fields such as salary or employment type). The first call returns a preview; call again with confirmation_id once the user agrees.

Cần quyền: Vào khu quản trị

Tham số (12)
TênKiểuMô tả
contract_idstringEdit this contract (list_contracts); leave out to record a new one.
member_idstringStaff member the new contract is for. Required when creating.
typestringRequired when creating. Giá trị: probationofficialseasonalcollab
no_termbooleantrue for an open-ended contract.
start_datestring
end_datestring
statusstring Giá trị: activeexpiringexpireddraft
create_termbooleanAlso write the employment version this contract brings, from start_date.
termobject
organization_idstringTổ 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_keystringKhoá chống lặp tuỳ chọn: gọi lại cùng khoá không tạo bản ghi thứ hai.
confirmation_idstringMã xác nhận do lần gọi xem trước trả về; gọi lại với mã này mới thực hiện.

Sửa thông tin tổ chức

Changes the organization's name, contact details, sector, brand colour, pay cycle (monthly or semi_monthly, cutoff day, payday), work basis, standard days, weekly and alternate days off, check-in rules (location_check, location_match, web_punch, punch window) or currency format. The first call previews each field before and after; call again with confirmation_id once the user agrees.

Cần quyền: Cài đặt tổ chức

Tham số (31)
TênKiểuMô tả
namestring
brand_colorstringHex without #, upper case.
sectorstring
sizestring
phonestring
emailstring
addressstring
pay_cyclestring Giá trị: monthlysemi_monthly
cutoff_dayinteger
paydayinteger
work_basisstring Giá trị: dayhour
standard_days_per_monthinteger
standard_days_modestring Giá trị: fixedcalendar
weekly_days_offinteger[]0 = Sunday … 6 = Saturday.
alternate_days_offinteger[]Days off every other week.
alternate_anchorstring
location_checkstringoff, record (log where punches came from) or enforce (refuse punches off site). Giá trị: offrecordenforce
location_matchstringany: GPS or WiFi is enough; both: needs both. Giá trị: anyboth
web_punchstringWhether staff may clock in from a browser. Giá trị: allowgps_onlydeny
punch_windowstringLimit clocking to a window around the shift. Giá trị: offwarnenforce
punch_window_beforeintegerMinutes before the shift.
punch_window_afterintegerMinutes after the shift.
currency_codestring
currency_symbolstring
currency_symbol_positionstring Giá trị: prefixsuffix
currency_decimalsinteger
currency_group_separatorstring
currency_decimal_separatorstring
organization_idstringTổ 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_keystringKhoá chống lặp tuỳ chọn: gọi lại cùng khoá không tạo bản ghi thứ hai.
confirmation_idstringMã xác nhận do lần gọi xem trước trả về; gọi lại với mã này mới thực hiện.
update_settingsNhạy cảm

Sửa cài đặt tổ chức

Changes one settings section (same names as get_settings; read it first). values holds only the fields to change; get_settings write_hint says which. For list sections give item_id to change an item or leave it out to add one; leave_policies also takes action make_default. payroll_settings saves the override named by values.scope + scope_ref_id. The first call previews current against new values and returns a confirmation_id.

Cần quyền: Sửa cài đặt nghiệp vụ

Tham số (7)
TênKiểuMô tả
sectionbắt buộcstring Giá trị: overtimetaxinsuranceleave_policyapproval_settingstodo_digestattendance_complianceleave_policiesadvance_policiespayroll_settingssalary_templatesnotification_policies
valuesobjectOnly the fields to change, as get_settings shows them.
item_idstringList sections: the item to change; leave out to add one.
actionstringleave_policies only: make item_id the default template. Giá trị: make_default
organization_idstringTổ 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_keystringKhoá chống lặp tuỳ chọn: gọi lại cùng khoá không tạo bản ghi thứ hai.
confirmation_idstringMã xác nhận do lần gọi xem trước trả về; gọi lại với mã này mới thực hiện.

Khác · 2

delete_badgeGhiXoá / huỷ

Xoá huy hiệu của tổ chức

Deletes one of the organization's own badges (badge_id from list_badges) that has never been awarded. A badge already awarded cannot be deleted; archive it with save_badge status=archived.

Cần quyền: Vào khu quản trị

Tham số (3)
TênKiểuMô tả
badge_idbắt buộcstringBadge id, from list_badges.
organization_idstringTổ 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_keystringKhoá chống lặp tuỳ chọn: gọi lại cùng khoá không tạo bản ghi thứ hai.
export_reportĐọcTốn 10 đơn vị

Xuất báo cáo

Makes a download link (valid 10 minutes) for a CTAS Work file, built when the user opens it: attendance_csv (month), payroll_csv or payroll_xlsx (period_id; xlsx takes department_id), schedule_pdf (from, to, at most 31 days), monthly_report_pdf (month; department_id or member_id narrows it), payslip_pdf (period_id, member_id). Give the link to the user; the file is not returned here. Limited to 20 exports a day per organization.

Cần quyền: Vào khu quản trị

Tham số (9)
TênKiểuMô tả
kindbắt buộcstringWhich file. Giá trị: attendance_csvpayroll_csvpayroll_xlsxschedule_pdfmonthly_report_pdfpayslip_pdf
monthstringYYYY-MM for attendance_csv and monthly_report_pdf; this month when left out.
period_idstringPayroll period id for payroll_csv, payroll_xlsx and payslip_pdf.
member_idstringThe person, for payslip_pdf, or to narrow monthly_report_pdf to one person.
department_idstringNarrow payroll_xlsx, schedule_pdf or monthly_report_pdf to one department or store.
fromstringschedule_pdf: first day, YYYY-MM-DD.
tostringschedule_pdf: last day, YYYY-MM-DD.
layoutstringschedule_pdf: printable pages (default) or one tall page. Giá trị: pagesimage
organization_idstringTổ 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.