Docs
MCP serverAvailable tools

Save employee

Create or update one payroll employee. SAT catalog fields use their public business names and corresponding SAT codes.

MCP toolsave_employee

Purpose

Create or update a payroll employee.

Use when
An employee payroll record must be added or changed.
Do not use when
You need to remove an employee or only read employee data.
Required permissions
employees:manage
Side effects
Writes data
Idempotency
Idempotent

Input schema

JSON Schema
{  "type": "object",  "properties": {    "idempotencyKey": {      "type": "string",      "minLength": 1,      "maxLength": 200,      "description": "Unique retry key for this exact operation. Reuse it only when retrying the same request."    },    "input": {      "oneOf": [        {          "type": "object",          "properties": {            "operation": {              "type": "string",              "const": "create"            },            "name": {              "$ref": "#/definitions/__schema0"            },            "rfc": {              "type": "string"            },            "curp": {              "$ref": "#/definitions/__schema1"            },            "postalCode": {              "$ref": "#/definitions/__schema2"            },            "employeeNumber": {              "$ref": "#/definitions/__schema3"            },            "employmentStartDate": {              "$ref": "#/definitions/__schema4"            },            "taxSystem": {              "$ref": "#/definitions/__schema5"            },            "socialSecurityNumber": {              "$ref": "#/definitions/__schema6"            },            "contractType": {              "$ref": "#/definitions/__schema7"            },            "regimeType": {              "$ref": "#/definitions/__schema8"            },            "paymentFrequency": {              "$ref": "#/definitions/__schema9"            },            "jobTitle": {              "$ref": "#/definitions/__schema10"            },            "department": {              "$ref": "#/definitions/__schema11"            },            "workScheduleType": {              "$ref": "#/definitions/__schema12"            },            "positionRisk": {              "$ref": "#/definitions/__schema13"            },            "federalEntityCode": {              "$ref": "#/definitions/__schema14"            },            "recurringEarnings": {              "$ref": "#/definitions/__schema15"            },            "recurringDeductions": {              "$ref": "#/definitions/__schema16"            },            "recurringOtherPayments": {              "$ref": "#/definitions/__schema17"            }          },          "required": [            "operation",            "name",            "rfc",            "curp",            "postalCode",            "employeeNumber",            "employmentStartDate"          ],          "additionalProperties": false        },        {          "type": "object",          "properties": {            "operation": {              "type": "string",              "const": "update"            },            "employeeId": {              "type": "string"            },            "name": {              "allOf": [                {                  "$ref": "#/definitions/__schema0"                }              ]            },            "curp": {              "allOf": [                {                  "$ref": "#/definitions/__schema1"                }              ]            },            "postalCode": {              "allOf": [                {                  "$ref": "#/definitions/__schema2"                }              ]            },            "employeeNumber": {              "allOf": [                {                  "$ref": "#/definitions/__schema3"                }              ]            },            "employmentStartDate": {              "allOf": [                {                  "$ref": "#/definitions/__schema4"                }              ]            },            "taxSystem": {              "allOf": [                {                  "$ref": "#/definitions/__schema5"                }              ]            },            "socialSecurityNumber": {              "allOf": [                {                  "$ref": "#/definitions/__schema6"                }              ]            },            "contractType": {              "allOf": [                {                  "$ref": "#/definitions/__schema7"                }              ]            },            "regimeType": {              "allOf": [                {                  "$ref": "#/definitions/__schema8"                }              ]            },            "paymentFrequency": {              "allOf": [                {                  "$ref": "#/definitions/__schema9"                }              ]            },            "jobTitle": {              "allOf": [                {                  "$ref": "#/definitions/__schema10"                }              ]            },            "department": {              "allOf": [                {                  "$ref": "#/definitions/__schema11"                }              ]            },            "workScheduleType": {              "allOf": [                {                  "$ref": "#/definitions/__schema12"                }              ]            },            "positionRisk": {              "allOf": [                {                  "$ref": "#/definitions/__schema13"                }              ]            },            "federalEntityCode": {              "allOf": [                {                  "$ref": "#/definitions/__schema14"                }              ]            },            "recurringEarnings": {              "allOf": [                {                  "$ref": "#/definitions/__schema15"                }              ]            },            "recurringDeductions": {              "allOf": [                {                  "$ref": "#/definitions/__schema16"                }              ]            },            "recurringOtherPayments": {              "allOf": [                {                  "$ref": "#/definitions/__schema17"                }              ]            }          },          "required": [            "operation",            "employeeId"          ],          "additionalProperties": false        }      ]    }  },  "required": [    "idempotencyKey",    "input"  ],  "$schema": "http://json-schema.org/draft-07/schema#",  "additionalProperties": false,  "definitions": {    "__schema0": {      "type": "string"    },    "__schema1": {      "type": "string"    },    "__schema2": {      "type": "string"    },    "__schema3": {      "type": "string"    },    "__schema4": {      "type": "string",      "format": "date",      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"    },    "__schema5": {      "type": "string",      "enum": [        "601",        "603",        "605",        "606",        "607",        "608",        "610",        "611",        "612",        "614",        "615",        "616",        "620",        "621",        "622",        "623",        "624",        "625",        "626"      ],      "description": "Active SAT tax-system code.",      "x-exac-sat-catalog": "tax-systems"    },    "__schema6": {      "type": "string"    },    "__schema7": {      "type": "string",      "enum": [        "10",        "99",        "01",        "02",        "03",        "04",        "05",        "06",        "07",        "08",        "09"      ],      "description": "Active SAT payroll contract-type code.",      "x-exac-sat-catalog": "payroll-contract-types"    },    "__schema8": {      "type": "string",      "enum": [        "10",        "11",        "12",        "13",        "99",        "02",        "03",        "04",        "05",        "06",        "07",        "08",        "09"      ],      "description": "Active SAT payroll regime-type code.",      "x-exac-sat-catalog": "payroll-regime-types"    },    "__schema9": {      "type": "string",      "enum": [        "10",        "99",        "01",        "02",        "03",        "04",        "05",        "06",        "07",        "08",        "09"      ],      "description": "Active SAT payroll payment-frequency code.",      "x-exac-sat-catalog": "payroll-payment-frequencies"    },    "__schema10": {      "type": "string"    },    "__schema11": {      "type": "string"    },    "__schema12": {      "type": "string",      "enum": [        "99",        "01",        "02",        "03",        "04",        "05",        "06",        "07",        "08"      ],      "description": "Active SAT payroll work-schedule code.",      "x-exac-sat-catalog": "payroll-work-schedule-types"    },    "__schema13": {      "type": "string",      "enum": [        "1",        "2",        "3",        "4",        "5",        "99"      ],      "description": "Active SAT payroll position-risk code.",      "x-exac-sat-catalog": "payroll-position-risks"    },    "__schema14": {      "type": "string",      "enum": [        "AGU",        "BCN",        "BCS",        "CAM",        "CHP",        "CHH",        "COA",        "COL",        "CMX",        "DUR",        "GUA",        "GRO",        "HID",        "JAL",        "MEX",        "MIC",        "MOR",        "NAY",        "NLE",        "OAX",        "PUE",        "QUE",        "ROO",        "SLP",        "SIN",        "SON",        "TAB",        "TAM",        "TLA",        "VER",        "YUC",        "ZAC"      ],      "description": "Active SAT federal-entity code.",      "x-exac-sat-catalog": "federal-entities"    },    "__schema15": {      "type": "array",      "items": {        "type": "object",        "properties": {          "code": {            "type": "string",            "enum": [              "001",              "002",              "003",              "004",              "005",              "006",              "009",              "010",              "011",              "012",              "013",              "014",              "015",              "019",              "020",              "021",              "022",              "023",              "024",              "025",              "026",              "027",              "028",              "029",              "030",              "031",              "032",              "033",              "034",              "035",              "036",              "037",              "038",              "039",              "044",              "045",              "046",              "047",              "048",              "049",              "050",              "051",              "052",              "053"            ],            "description": "Active SAT payroll earning-type code.",            "x-exac-sat-catalog": "payroll-earning-types"          },          "taxableAmount": {            "type": "number"          },          "exemptAmount": {            "type": "number"          }        },        "required": [          "code",          "taxableAmount",          "exemptAmount"        ],        "additionalProperties": false      }    },    "__schema16": {      "type": "array",      "items": {        "type": "object",        "properties": {          "code": {            "type": "string",            "description": "SAT payroll deduction-type code."          },          "amount": {            "type": "number"          }        },        "required": [          "code",          "amount"        ],        "additionalProperties": false      }    },    "__schema17": {      "type": "array",      "items": {        "type": "object",        "properties": {          "code": {            "type": "string",            "enum": [              "999",              "001",              "002",              "003",              "004",              "005",              "006",              "007",              "008",              "009"            ],            "description": "Active SAT payroll other-payment code.",            "x-exac-sat-catalog": "payroll-other-payment-types"          },          "amount": {            "type": "number"          },          "employmentSubsidy": {            "type": "number"          }        },        "required": [          "code",          "amount"        ],        "additionalProperties": false      }    }  }}

Output schema

JSON Schema
{  "type": "object",  "properties": {    "data": {      "type": "object",      "properties": {        "employeeId": {          "type": "string",          "minLength": 1        },        "name": {          "type": "string"        },        "postalCode": {          "type": "string"        },        "taxSystem": {          "type": "string"        },        "employeeNumber": {          "type": "string"        },        "curp": {          "type": "string"        },        "socialSecurityNumber": {          "type": "string"        },        "jobTitle": {          "type": "string"        },        "department": {          "type": "string"        },        "paymentFrequency": {          "type": "string"        },        "employmentStartDate": {          "type": "string"        },        "contractType": {          "type": "string"        },        "workScheduleType": {          "type": "string"        },        "regimeType": {          "type": "string"        },        "rfc": {          "type": "string"        },        "lastPayrollDate": {          "type": "string",          "format": "date-time"        }      },      "required": [        "employeeId",        "name",        "rfc"      ],      "additionalProperties": false    },    "error": {      "$schema": "http://json-schema.org/draft-07/schema#",      "type": "object",      "properties": {        "code": {          "type": "string",          "enum": [            "validation_error",            "unauthenticated",            "forbidden",            "not_found",            "method_not_allowed",            "conflict",            "idempotency_conflict",            "operation_in_progress",            "recovery_required",            "rate_limited",            "provider_unavailable",            "internal"          ]        },        "message": {          "type": "string"        },        "details": {          "type": "object",          "properties": {            "issues": {              "type": "array",              "items": {                "type": "object",                "properties": {                  "path": {                    "type": "array",                    "items": {                      "anyOf": [                        {                          "type": "string"                        },                        {                          "type": "number"                        }                      ]                    }                  },                  "message": {                    "type": "string"                  },                  "code": {                    "type": "string"                  }                },                "required": [                  "path",                  "message"                ],                "additionalProperties": false              }            },            "retryable": {              "type": "boolean"            },            "retryAfterSeconds": {              "type": "integer",              "exclusiveMinimum": 0,              "maximum": 9007199254740991            }          },          "additionalProperties": false        }      },      "required": [        "code",        "message"      ],      "additionalProperties": false    }  },  "$schema": "http://json-schema.org/draft-07/schema#",  "additionalProperties": false,  "oneOf": [    {      "required": [        "data"      ]    },    {      "required": [        "error"      ]    }  ]}

Related workflow

See the canonical workflows in the introduction

Related tools