{ "components": { "schemas": { "OutputRestApiActivityLogEvent62bcfbdf6086": { "description": "One visible Activity Log event retained from the last 90 days.", "properties": { "actor_type": { "description": "The kind of actor that initiated the event. WORKER is a Rippling worker; INTERNAL_BY_WORKER is an internal API request triggered by a worker; SYSTEM is an automated Rippling system process; EXTERNAL is an external system or integration; RIPPLING_MDM is Rippling MDM; PARTNER is a Rippling partner, but the partner identity is not returned; and PROXY is Rippling staff or support acting through proxy. Null when no actor type was recorded.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "event_type": { "description": "The open UPPER_SNAKE_CASE Activity Log code, such as USER_LOGIN_SUCCESS. New codes can appear over time.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "occurred_at": { "description": "The activity occurrence time as an ISO 8601 UTC timestamp. Unlike created_at, which records when the Activity Log record was persisted, occurred_at records when the underlying activity happened.", "type": "string" }, "reason": { "description": "Why the activity occurred. Null when no reason was recorded.", "properties": { "code": { "description": "The machine-readable reason code recorded for the event. Null when no reason was recorded.", "type": "string" }, "message": { "description": "The human-readable meaning of the reason code. Null when no reason was recorded.", "type": "string" } }, "title": "ActivityLogReason", "type": "object" }, "request_context": { "description": "Request and approximate location details captured for the activity. Null for non-request events.", "properties": { "accuracy_radius": { "anyOf": [ { "description": "The accuracy radius of the IP-derived location in kilometers. Null without the activity-log.sensitive-data.read scope or when geolocation is unresolved.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "browser": { "description": "The browser family parsed from the request user agent. Returned with the activity-log.read scope. Null when unavailable.", "type": "string" }, "city": { "description": "The city resolved from the request IP address. Null without the activity-log.sensitive-data.read scope or when geolocation is unresolved.", "type": "string" }, "country": { "description": "The country resolved from the request IP address. Null without the activity-log.sensitive-data.read scope or when geolocation is unresolved.", "type": "string" }, "device": { "description": "The device family parsed from the request user agent. Returned with the activity-log.read scope. Null when unavailable.", "type": "string" }, "ip_address": { "description": "The IPv4 or IPv6 address associated with the request. Null without the activity-log.sensitive-data.read scope.", "type": "string" }, "latitude": { "anyOf": [ { "description": "The approximate latitude in decimal degrees resolved from the request IP address. Null without the activity-log.sensitive-data.read scope or when geolocation is unresolved.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "longitude": { "anyOf": [ { "description": "The approximate longitude in decimal degrees resolved from the request IP address. Null without the activity-log.sensitive-data.read scope or when geolocation is unresolved.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "operating_system": { "description": "The operating system parsed from the request user agent. Returned with the activity-log.read scope. Null when unavailable.", "type": "string" }, "state": { "description": "The state or region resolved from the request IP address. Null without the activity-log.sensitive-data.read scope or when geolocation is unresolved.", "type": "string" } }, "title": "ActivityLogRequestContext", "type": "object" }, "source_app_handle": { "description": "The public app handle used by GET /app-users/ for the Rippling app associated with the activity. Null when the activity is not app-specific.", "type": "string" }, "status": { "description": "The outcome of the activity. SUCCESS means the activity completed successfully; FAILURE means the activity failed. Null when no outcome was recorded.", "type": "string" }, "targets": { "description": "The resources affected by the activity. Empty when no targets were recorded.", "items": { "$ref": "#/components/schemas/OutputRestApiActivityLogTargetd0dee037923e" }, "type": "array" }, "updated_at": { "description": "Record update date", "type": "string" }, "worker": { "description": "The worker who initiated the activity. Request with expand=worker and the workers.read OAuth scope to return the Worker resource.\n\nExpandable field", "properties": { "business_partners": { "description": "Worker's assigned business partners. This field is only populated when explicitly requested via the expand parameter (e.g., ?expand=business_partners). When expanded, returns an empty list ([]) if the worker has no business partners.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiBusinessPartner77b00a069c32" }, "type": "array" }, "business_partners_id": { "description": "Worker's assigned business partners unique identifiers. Returns an empty list ([]) if the worker has no business partners.", "items": { "type": "string" }, "type": "array" }, "citizenship": { "description": "The countries that the worker has citizenship in.", "type": "string" }, "compensation": { "description": "The compensation package for the worker.\n\nExpandable field", "properties": { "annual_compensation": { "description": "The worker's annual compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "annual_salary_equivalent": { "description": "The worker's annual salary equivalent, for insurance purposes. It will be equal to the worker's annual compensation, except for owners that are receiving no cashcompensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "bonus_schedule": { "description": "The worker's bonus schedule.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "hourly_wage": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "id": { "description": "Identifier field", "type": "string" }, "monthly_compensation": { "description": "The worker's monthly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "on_target_commission": { "description": "The worker's on-target commission.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "payment_terms": { "description": "The payment terms for an worker's compensation.", "type": "string" }, "payment_type": { "description": "The payment type for an worker's compensation.", "type": "string" }, "relocation_reimbursement": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "salary_effective_date": { "description": "Salary effective date", "type": "string" }, "signing_bonus": { "description": "The worker's signing bonus.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus": { "description": "The worker's target annual bonus amount.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus_percent": { "anyOf": [ { "description": "The worker's target annual bonus as a percent of annual compensation.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" }, "weekly_compensation": { "description": "The worker's weekly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "worker": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's details.\n\nExpandable field", "type": "object" }, "worker_id": { "description": "The worker's ID.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Compensation", "type": "object" }, "compensation_grade": { "description": "The compensation grade assigned to the worker, if any.", "properties": { "id": { "description": "The compensation grade's unique identifier.", "type": "string" }, "label": { "description": "The compensation grade's label.", "type": "string" } }, "title": "WorkerCompensationGrade", "type": "object" }, "compensation_id": { "description": "The compensation package for the worker.", "type": "string" }, "country": { "description": "The worker's country.", "type": "string" }, "country_fields": { "description": "Country level fields for the worker.", "properties": { "ca": { "description": "Country-wise regional fields for Canada", "properties": { "sin": { "description": "Social Insurance Number (SIN) for Canada employees.", "type": "string" } }, "title": "CanadaFields", "type": "object" }, "nz": { "description": "Country-wise regional fields for New Zealand", "properties": { "ird_number": { "description": "Inland Revenue Department (IRD) number for New Zealand employees.", "type": "string" } }, "title": "NewZealandFields", "type": "object" }, "us": { "description": "Country-wise regional fields for USA", "properties": { "ssn": { "description": "Social Security Number (SSN) for US employees.", "type": "string" } }, "title": "USFields", "type": "object" } }, "title": "CountryFields", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "custom_fields": { "description": "Custom field values defined on the Employee object for this worker\n\nExpandable field", "items": { "additionalProperties": {} }, "type": "array" }, "date_of_birth": { "description": "The worker's date of birth.", "type": "string" }, "department": { "description": "The worker's assigned department.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "department_hierarchy": { "description": "List of departments in the department hierarchy. Refer department_hierarchy_ids for department hierarchy order.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestDepartment" }, "type": "array" }, "department_hierarchy_id": { "description": "The identifier of departments in the department hierarchy ordered from parent department to child department.", "items": { "type": "string" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the department.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestDepartment", "description": "The parent department.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent department.", "type": "string" }, "reference_code": { "description": "Reference code of the department.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Department", "type": "object" }, "department_id": { "description": "The worker's assigned department.", "type": "string" }, "employment_type": { "description": "The worker's employment type.\n\nExpandable field", "properties": { "amount_worked": { "description": "The amount worked for the employment type. * `FULL-TIME`: Full-time is at least 30 hours per week. Full-time workers will typically be eligible for benefits. * `PART-TIME`: Part-time is less than 30 hours per week. These workers may be eligible for benefits, depending on company settings and hours worked. * `TEMPORARY`: These workers are hired on a temporary basis. You can specify how each worker with this employment type will be paid individually.", "type": "string" }, "compensation_time_period": { "description": "The compensation period for the employment type. * `SALARIED`: Employees that are paid a fixed amount per year. * `HOURLY`: Employees that are paid a wage per hour worked.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "label": { "description": "The display label of the employment type.", "type": "string" }, "name": { "description": "The name of the employment type for non-custom employment types.", "type": "string" }, "type": { "description": "The classification of the worker by the company. * `CONTRACTOR`: Contractors are self-employed workers who provide services on a short-term or per-project basis and are not eligible for tax-withholding or benefits. * `EMPLOYEE`: Employees are hired and managed by an employer, work under the employer's direct supervision and control, and are protected by law for wages and employment rights.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "label", "updated_at" ], "title": "CompanyEmploymentType", "type": "object" }, "employment_type_id": { "description": "The worker's employment type.", "type": "string" }, "end_date": { "description": "The end date of the worker.", "type": "string" }, "ethnicity": { "description": "The identified ethnicity of the worker, if specified.", "type": "string" }, "gender": { "description": "The gender of the worker, if specified.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_manager": { "description": "Whether the worker is a manager", "type": "boolean" }, "job_function": { "description": "The worker's job function. When expanded, this field requires `job-functions.read`.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "Displayed name of the job function", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "JobFunction", "type": "object" }, "job_function_id": { "description": "ID of the worker's job function.", "type": "string" }, "legal_entity": { "description": "The worker's associated legal entity.\n\nExpandable field", "properties": { "company": { "description": "The company or organization associated with the legal entity\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "doing_business_as_name": { "description": "The doing business as name for the company.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_entities": { "description": "A list of the company's entities.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestLegalEntity" }, "type": "array" }, "legal_entities_id": { "description": "A list of the company's entities.", "items": { "type": "string" }, "type": "array" }, "legal_name": { "description": "The legal name of the company.", "type": "string" }, "name": { "description": "The name of the company.", "type": "string" }, "parent_legal_entity": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The company's ultimate holding entity.\n\nExpandable field", "type": "object" }, "parent_legal_entity_id": { "description": "The company's ultimate holding entity.", "type": "string" }, "phone": { "description": "The phone number for the company.", "type": "string" }, "physical_address": { "description": "The physical address of the holding entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "primary_email": { "description": "The email address used when registering this company.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "legal_entities", "legal_entities_id", "name", "updated_at" ], "title": "Company", "type": "object" }, "company_id": { "description": "The company or organization associated with the legal entity", "type": "string" }, "country": { "description": "The country the legal entity is based in.", "properties": { "code": { "description": "The code of the country.", "type": "string" } }, "required": [ "code" ], "title": "Country", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "entity_level": { "description": "The legal entity's level in a hierarchy. * `PARENT`: The legal entity is considered the ultimate holding entity. * `SUBSIDIARY`: The legal entity is considered a subsidiary, fully or partially held by another. * `BRANCH`: The legal entity is considered a branch, associated with a parent legal entity.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_name": { "description": "The legal name of the legal entity.", "type": "string" }, "mailing_address": { "description": "The mailing address of the legal entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "management_type": { "description": "The legal entity management type in the case of an employer of record (EOR) or professional employment organization (PEO). * `PEO`: The legal entity is considered a Professional Employment Organization (PEO). * `EOR`: The legal entity is considered an Employer of Record (EOR).", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The parent legal entity.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent legal entity.", "type": "string" }, "physical_address": { "description": "The physical address of the legal entity, if it differs from the mailing address.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "registration_date": { "description": "The registration date of the entity.", "type": "string" }, "tax_identifier": { "description": "The tax identifier for the legal entity.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "LegalEntity", "type": "object" }, "legal_entity_id": { "description": "The worker's associated legal entity.", "type": "string" }, "level": { "description": "The level of the worker.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "description": { "description": "The description of the level.", "type": "string" }, "experience_requirements": { "description": "The experience requirements for the level.", "type": "string" }, "global_level": { "anyOf": [ { "description": "Global level is used to track the seniority of levels. The higher up a level is placed on the page, the more senior and higher-ranked the level. Global level is used in workflows, policies, and reports that use the level attribute (e.g., you can use Level Lookup to set up a workflow that notifies the nearest person in an worker's management chain at or above the specified level).", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the level. Must be unique within the company or organization.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLevel", "description": "The parent level.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent level.", "type": "string" }, "rank": { "anyOf": [ { "description": "The rank of the level within its track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "scope_of_responsibilities": { "description": "The scope of responsibilities for the level.", "type": "string" }, "track": { "description": "The track associated with the level, if it's not a global level.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_default": { "description": "Whether this is the company's default track.", "type": "boolean" }, "name": { "description": "The name of the track. Must be unique within the company or organization.", "type": "string" }, "order": { "anyOf": [ { "description": "The one-based horizontal display order of the track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "start_global_level": { "anyOf": [ { "description": "The highest global level occupied by this track. Empty tracks return null.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Track", "type": "object" }, "track_id": { "description": "The track associated with the level. Required during creation. Include global_level when changing it.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Level", "type": "object" }, "level_id": { "description": "The level of the worker.", "type": "string" }, "location": { "description": "The location that the worker is mapped to for tax purposes. In the case that a worker is remote, the location's type is remote.", "properties": { "type": { "description": "The type of location.", "type": "string" }, "work_location_id": { "description": "The work location, if the worker isn't remote.", "type": "string" } }, "required": [ "type", "work_location_id" ], "title": "WorkerLocation", "type": "object" }, "manager": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's manager.\n\nExpandable field", "type": "object" }, "manager_id": { "description": "The worker's manager.", "type": "string" }, "number": { "anyOf": [ { "description": "The worker's number within the organization.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "original_start_date": { "description": "The worker's earliest start date across their employment history, excluding INIT roles.", "type": "string" }, "overtime_exemption": { "description": "The worker's overtime exemption status.", "type": "string" }, "pay_schedule_id": { "description": "The ID of the pay schedule currently associated with the worker.", "type": "string" }, "personal_email": { "description": "The worker's associated personal email address.", "type": "string" }, "race": { "description": "The identified race of the worker, if specified.", "type": "string" }, "start_date": { "description": "The start date of the worker.", "type": "string" }, "status": { "description": "The worker's status within the organization.", "type": "string" }, "teams": { "description": "The worker's assigned teams.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiTeamcb26bc28f32f" }, "type": "array" }, "teams_id": { "description": "The worker's assigned teams.", "items": { "type": "string" }, "type": "array" }, "termination_details": { "description": "The details of the worker's termination, if applicable.", "properties": { "reason": { "description": "This is a description that will be custom to each Rippling company.", "type": "string" }, "type": { "description": "The termination type indicates whether the termination was voluntary or involuntary.", "type": "string" } }, "title": "TerminationDetails", "type": "object" }, "title": { "description": "The worker's title.", "type": "string" }, "title_effective_date": { "description": "Title effective date", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "user": { "description": "The worker's associated user.\n\nExpandable field", "properties": { "active": { "description": "Whether the user is able to access company resources, typically when they are in actively engaged with the company and not after off-boarding.", "type": "boolean" }, "addresses": { "description": "The user's addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiUserAddressedd59b9ba9a1" }, "type": "array" }, "created_at": { "description": "Record creation date", "type": "string" }, "display_name": { "description": "The display name of the user using either the concatenated preferred given and family name or username depending on availability.", "type": "string" }, "emails": { "description": "The user's email addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiEmail5284c8258dc3" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "locale": { "description": "The User's default location for purposes of localization of currency, date time format, or numerical representations pursuant to RFC5646.", "type": "string" }, "name": { "description": "The user's name.", "properties": { "family_name": { "description": "The legal family name of the user, or last name in most Western languages.", "type": "string" }, "formatted": { "description": "The user's full name.", "type": "string" }, "given_name": { "description": "The given legal name of the user, or first name in most Western languages.", "type": "string" }, "middle_name": { "description": "The middle name(s) of the user.", "type": "string" }, "preferred_family_name": { "description": "The preferred family name, or last name in most Western languages, by the user.", "type": "string" }, "preferred_given_name": { "description": "The preferred given name, or first name in most Western languages, by the user.", "type": "string" } }, "title": "UserName", "type": "object" }, "number": { "description": "The permanent profile number of the user.", "type": "string" }, "phone_numbers": { "description": "The user's phone numbers.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoneNumber12060c61ecf5" }, "type": "array" }, "photos": { "description": "The user's photos.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoto2be7c3ae3f39" }, "type": "array" }, "preferred_language": { "description": "The User's preferred written or spoken language in the same format of the HTTP Accept-Language header, pursuant to Section 5.3.5 of RFC7231.", "type": "string" }, "timezone": { "description": "The User's current time zone in IANA database Olson format", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "username": { "description": "The unique identifier across Rippling used by the User for direct authentication into their associated company. Globally unique.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "User", "type": "object" }, "user_id": { "description": "The worker's associated user.", "type": "string" }, "work_email": { "description": "The worker's associated work email address.", "type": "string" }, "work_schedule": { "additionalProperties": { "$ref": "#/components/schemas/OutputRestApiWorkScheduleDay938f88d94f20" }, "description": "The worker's scheduled working hours for each day of the week.", "type": "object" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Worker", "type": "object" }, "worker_id": { "description": "The Platform worker ID from GET /workers/{id}/ when the actor is a worker. Null when the actor is not a worker.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "ActivityLogEvent", "type": "object" }, "OutputRestApiActivityLogTargetd0dee037923e": { "description": "A resource or internal entity affected by an Activity Log event.", "properties": { "id": { "description": "The ID of the resource affected by the event. Null when the event target has no referenced resource. Filtering by targets.id is not supported for GROUP or SPOKE_USER targets.", "type": "string" }, "type": { "description": "The kind of target. WORKER uses the worker ID from GET /workers/{id}/; DEVICE uses the device ID from GET /devices/{id}/; GROUP uses the group ID from GET /supergroups/{id}/; SPOKE_USER uses the app-user ID from GET /app-users/{id}/. COMPUTER is deprecated in favor of DEVICE and its ID is not a Platform resource ID. IDs for SPOKE, RPASS_ITEM, RPASS_FOLDER, SCHEDULED_CHANGE, BDR_POLICY, AUTH_RULE, COMPANY_AUTH_RULE, USER_ACCOUNT, HARDWARE_SCRIPT, HARDWARE_CONFIGURATION, SOFTWARE_UPDATE, OS_SOFTWARE_UPDATE, WORK_EMAIL_POLICY, OFFBOARDING_POLICY, REMOTE_ACCESS_SESSION_OPTIONS, and REMOTE_ACCESS_SESSION_ERROR_DETAILS are not Platform resource IDs.", "type": "string" } }, "title": "ActivityLogTarget", "type": "object" }, "OutputRestApiAgentDeployment83bdbd46d523": { "description": "", "properties": { "deployment_id": { "description": "The ID of the deployment", "type": "string" }, "diagnostics": { "description": "Diagnostics emitted while creating the deployment", "items": { "$ref": "#/components/schemas/OutputRestApiAgentDeploymentDiagnosticfd2356ca2aee" }, "type": "array" }, "is_active": { "description": "Whether the deployment is active", "type": "boolean" }, "outcome": { "description": "The deployment outcome", "type": "string" }, "source_digest": { "description": "The digest of the deployed source revision", "type": "string" }, "source_revision_version": { "anyOf": [ { "description": "The source revision version deployed by the control plane", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "stage": { "description": "The deployment stage", "type": "string" } }, "title": "AgentDeployment", "type": "object" }, "OutputRestApiAgentDeploymentDiagnosticfd2356ca2aee": { "description": "", "properties": { "message": { "description": "The diagnostic message", "type": "string" }, "path": { "description": "The source path for the diagnostic", "type": "string" }, "severity": { "description": "The diagnostic severity", "type": "string" } }, "title": "AgentDeploymentDiagnostic", "type": "object" }, "OutputRestApiAgentSessionEvent49db40ed2ff2": { "description": "", "properties": { "created_at": { "description": "When the event was created", "type": "string" }, "event_id": { "description": "The ID of the session event", "type": "string" }, "event_type": { "description": "The event type", "type": "string" }, "fields": { "description": "Structured event fields", "type": "object" }, "level": { "description": "The event severity level", "type": "string" }, "message": { "description": "The event message", "type": "string" }, "sequence": { "anyOf": [ { "description": "The event sequence number", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "AgentSessionEvent", "type": "object" }, "OutputRestApiAgentSessiona0888e12eb01": { "description": "", "properties": { "agent_id": { "description": "The ID of the agent to run", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "error_message": { "description": "The session error message", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "langsmith_thread_id": { "description": "The stable LangSmith thread identifier for this session", "type": "string" }, "output": { "description": "The output of the session", "type": "object" }, "prompt": { "description": "The prompt to send to the agent", "type": "string" }, "session_resume_receipt": { "description": "Receipt that ACP restored the requested session resume state", "properties": { "status": { "description": "The session resume state restore status", "type": "string" } }, "title": "SessionResumeReceipt", "type": "object" }, "status": { "description": "The status of the session", "type": "string" }, "submission_id": { "description": "Receipt for correlating agent.submission.settled events after create or append-message writes", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "agent_id", "created_at", "id", "prompt", "updated_at" ], "title": "AgentSession", "type": "object" }, "OutputRestApiAgentSourceFile075f135fe768": { "description": "", "properties": { "content": { "description": "The contents of the source file", "type": "string" }, "kind": { "description": "The source file language or format", "type": "string" }, "path": { "description": "The path of the source file", "type": "string" } }, "required": [ "content", "kind", "path" ], "title": "AgentSourceFile", "type": "object" }, "OutputRestApiAgentSourceRevisionSummary9e198b8dc6d6": { "description": "List representation of an agent source revision without source contents.", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "source_digest": { "description": "The digest of the source revision", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "version": { "anyOf": [ { "description": "The version number of the source revision", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "required": [ "created_at", "id", "updated_at" ], "title": "AgentSourceRevisionSummary", "type": "object" }, "OutputRestApiAgentbe24c139b1b5": { "description": "", "properties": { "api_name": { "description": "The API name of the agent", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "description": { "description": "The description of the agent", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_for_evals": { "description": "Whether the agent is used for evaluations", "type": "boolean" }, "name": { "description": "The display name of the agent", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "api_name", "created_at", "id", "name", "updated_at" ], "title": "Agent", "type": "object" }, "OutputRestApiAnnualScheduleTrigger9e9c8bf96230": { "additionalProperties": false, "properties": { "day_of_month": { "anyOf": [ { "maximum": 31, "minimum": 1, "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "hour": { "anyOf": [ { "maximum": 23, "minimum": 0, "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "kind": { "type": "string" }, "minute": { "anyOf": [ { "default": 0, "maximum": 59, "minimum": 0, "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "month_of_year": { "anyOf": [ { "maximum": 12, "minimum": 1, "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "timezone": { "type": "string" } }, "required": [ "day_of_month", "hour", "kind", "month_of_year", "timezone" ], "title": "AnnualScheduleTrigger", "type": "object" }, "OutputRestApiAppUser1e982a4b9d56": { "description": "\n Maps a Rippling worker (if any) to their user account in a third-party\n app (e.g. Slack, Jira, GitHub). Sourced from SpokeUser records.\n\n Includes orphan accounts — third-party app accounts with no matching\n Rippling worker (`worker_id=None`, `match_state=NOT_MATCHED`). These are\n the primary signal for IT-admin triage. Uses `BaseResourceDTO` rather\n than `BaseEmployeeResourceDTO` so the platform's role-based auto-filter\n does not silently drop orphans for non-admin tokens. Company scoping is\n enforced explicitly in `AppUsersAPIViewSet.get_queryset`; the `app-users.read`\n scope is the access gate.\n\n Resource name aligns with how the product surfaces these in the UI\n (\"Slack account\", \"GitHub account\") and matches the equivalent concept\n in Okta's IAM API (AppUser).\n\n Designed for point lookups: list endpoint requires at least one filter\n on `worker_id` or `spoke_user_identifier` to prevent bulk enumeration of the\n org's identity graph across connected apps.\n\n `spoke_user_identifier` reads `SpokeUser.spokeId` — the user identifier\n stored for the third-party account. Depending on the integration, this may\n be an email, username, account handle, or app-specific user id.\n ", "properties": { "app_display_name": { "description": "Human-readable display name for the third-party app (e.g. 'Slack', 'GitHub'). Sourced from the customer-configured SpokeOwner.app_display_name; falls back to a title-cased app handle when the customer hasn't set one.", "type": "string" }, "app_handle": { "description": "Machine-readable identifier for the third-party app (e.g. 'slack', 'jira', 'asana'). Stable across the App Shop catalog.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "external_email": { "description": "The user's email address in the third-party app, if known. Null when the app does not expose an email or Rippling did not capture one.", "type": "string" }, "external_username": { "description": "The user's display name in the third-party app, if known. Null when the app does not surface a separate username.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "match_state": { "description": "Whether this third-party account has been matched to a Rippling worker.", "type": "string" }, "push_state": { "description": "Provisioning lifecycle state of this account in the third-party app.", "type": "string" }, "spoke_user_identifier": { "description": "Identifier for the user's account in the third-party app workspace. Depending on the integration, this may be an email, username, account handle, or app-specific user id.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "worker": { "description": "The Rippling worker associated with this external app account. Expanding this field requires both `app-users.read` and `workers.read` scopes.\n\nExpandable field", "properties": { "business_partners": { "description": "Worker's assigned business partners. This field is only populated when explicitly requested via the expand parameter (e.g., ?expand=business_partners). When expanded, returns an empty list ([]) if the worker has no business partners.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiBusinessPartner77b00a069c32" }, "type": "array" }, "business_partners_id": { "description": "Worker's assigned business partners unique identifiers. Returns an empty list ([]) if the worker has no business partners.", "items": { "type": "string" }, "type": "array" }, "citizenship": { "description": "The countries that the worker has citizenship in.", "type": "string" }, "compensation": { "description": "The compensation package for the worker.\n\nExpandable field", "properties": { "annual_compensation": { "description": "The worker's annual compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "annual_salary_equivalent": { "description": "The worker's annual salary equivalent, for insurance purposes. It will be equal to the worker's annual compensation, except for owners that are receiving no cashcompensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "bonus_schedule": { "description": "The worker's bonus schedule.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "hourly_wage": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "id": { "description": "Identifier field", "type": "string" }, "monthly_compensation": { "description": "The worker's monthly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "on_target_commission": { "description": "The worker's on-target commission.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "payment_terms": { "description": "The payment terms for an worker's compensation.", "type": "string" }, "payment_type": { "description": "The payment type for an worker's compensation.", "type": "string" }, "relocation_reimbursement": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "salary_effective_date": { "description": "Salary effective date", "type": "string" }, "signing_bonus": { "description": "The worker's signing bonus.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus": { "description": "The worker's target annual bonus amount.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus_percent": { "anyOf": [ { "description": "The worker's target annual bonus as a percent of annual compensation.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" }, "weekly_compensation": { "description": "The worker's weekly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "worker": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's details.\n\nExpandable field", "type": "object" }, "worker_id": { "description": "The worker's ID.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Compensation", "type": "object" }, "compensation_grade": { "description": "The compensation grade assigned to the worker, if any.", "properties": { "id": { "description": "The compensation grade's unique identifier.", "type": "string" }, "label": { "description": "The compensation grade's label.", "type": "string" } }, "title": "WorkerCompensationGrade", "type": "object" }, "compensation_id": { "description": "The compensation package for the worker.", "type": "string" }, "country": { "description": "The worker's country.", "type": "string" }, "country_fields": { "description": "Country level fields for the worker.", "properties": { "ca": { "description": "Country-wise regional fields for Canada", "properties": { "sin": { "description": "Social Insurance Number (SIN) for Canada employees.", "type": "string" } }, "title": "CanadaFields", "type": "object" }, "nz": { "description": "Country-wise regional fields for New Zealand", "properties": { "ird_number": { "description": "Inland Revenue Department (IRD) number for New Zealand employees.", "type": "string" } }, "title": "NewZealandFields", "type": "object" }, "us": { "description": "Country-wise regional fields for USA", "properties": { "ssn": { "description": "Social Security Number (SSN) for US employees.", "type": "string" } }, "title": "USFields", "type": "object" } }, "title": "CountryFields", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "custom_fields": { "description": "Custom field values defined on the Employee object for this worker\n\nExpandable field", "items": { "additionalProperties": {} }, "type": "array" }, "date_of_birth": { "description": "The worker's date of birth.", "type": "string" }, "department": { "description": "The worker's assigned department.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "department_hierarchy": { "description": "List of departments in the department hierarchy. Refer department_hierarchy_ids for department hierarchy order.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestDepartment" }, "type": "array" }, "department_hierarchy_id": { "description": "The identifier of departments in the department hierarchy ordered from parent department to child department.", "items": { "type": "string" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the department.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestDepartment", "description": "The parent department.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent department.", "type": "string" }, "reference_code": { "description": "Reference code of the department.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Department", "type": "object" }, "department_id": { "description": "The worker's assigned department.", "type": "string" }, "employment_type": { "description": "The worker's employment type.\n\nExpandable field", "properties": { "amount_worked": { "description": "The amount worked for the employment type. * `FULL-TIME`: Full-time is at least 30 hours per week. Full-time workers will typically be eligible for benefits. * `PART-TIME`: Part-time is less than 30 hours per week. These workers may be eligible for benefits, depending on company settings and hours worked. * `TEMPORARY`: These workers are hired on a temporary basis. You can specify how each worker with this employment type will be paid individually.", "type": "string" }, "compensation_time_period": { "description": "The compensation period for the employment type. * `SALARIED`: Employees that are paid a fixed amount per year. * `HOURLY`: Employees that are paid a wage per hour worked.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "label": { "description": "The display label of the employment type.", "type": "string" }, "name": { "description": "The name of the employment type for non-custom employment types.", "type": "string" }, "type": { "description": "The classification of the worker by the company. * `CONTRACTOR`: Contractors are self-employed workers who provide services on a short-term or per-project basis and are not eligible for tax-withholding or benefits. * `EMPLOYEE`: Employees are hired and managed by an employer, work under the employer's direct supervision and control, and are protected by law for wages and employment rights.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "label", "updated_at" ], "title": "CompanyEmploymentType", "type": "object" }, "employment_type_id": { "description": "The worker's employment type.", "type": "string" }, "end_date": { "description": "The end date of the worker.", "type": "string" }, "ethnicity": { "description": "The identified ethnicity of the worker, if specified.", "type": "string" }, "gender": { "description": "The gender of the worker, if specified.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_manager": { "description": "Whether the worker is a manager", "type": "boolean" }, "job_function": { "description": "The worker's job function. When expanded, this field requires `job-functions.read`.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "Displayed name of the job function", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "JobFunction", "type": "object" }, "job_function_id": { "description": "ID of the worker's job function.", "type": "string" }, "legal_entity": { "description": "The worker's associated legal entity.\n\nExpandable field", "properties": { "company": { "description": "The company or organization associated with the legal entity\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "doing_business_as_name": { "description": "The doing business as name for the company.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_entities": { "description": "A list of the company's entities.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestLegalEntity" }, "type": "array" }, "legal_entities_id": { "description": "A list of the company's entities.", "items": { "type": "string" }, "type": "array" }, "legal_name": { "description": "The legal name of the company.", "type": "string" }, "name": { "description": "The name of the company.", "type": "string" }, "parent_legal_entity": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The company's ultimate holding entity.\n\nExpandable field", "type": "object" }, "parent_legal_entity_id": { "description": "The company's ultimate holding entity.", "type": "string" }, "phone": { "description": "The phone number for the company.", "type": "string" }, "physical_address": { "description": "The physical address of the holding entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "primary_email": { "description": "The email address used when registering this company.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "legal_entities", "legal_entities_id", "name", "updated_at" ], "title": "Company", "type": "object" }, "company_id": { "description": "The company or organization associated with the legal entity", "type": "string" }, "country": { "description": "The country the legal entity is based in.", "properties": { "code": { "description": "The code of the country.", "type": "string" } }, "required": [ "code" ], "title": "Country", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "entity_level": { "description": "The legal entity's level in a hierarchy. * `PARENT`: The legal entity is considered the ultimate holding entity. * `SUBSIDIARY`: The legal entity is considered a subsidiary, fully or partially held by another. * `BRANCH`: The legal entity is considered a branch, associated with a parent legal entity.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_name": { "description": "The legal name of the legal entity.", "type": "string" }, "mailing_address": { "description": "The mailing address of the legal entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "management_type": { "description": "The legal entity management type in the case of an employer of record (EOR) or professional employment organization (PEO). * `PEO`: The legal entity is considered a Professional Employment Organization (PEO). * `EOR`: The legal entity is considered an Employer of Record (EOR).", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The parent legal entity.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent legal entity.", "type": "string" }, "physical_address": { "description": "The physical address of the legal entity, if it differs from the mailing address.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "registration_date": { "description": "The registration date of the entity.", "type": "string" }, "tax_identifier": { "description": "The tax identifier for the legal entity.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "LegalEntity", "type": "object" }, "legal_entity_id": { "description": "The worker's associated legal entity.", "type": "string" }, "level": { "description": "The level of the worker.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "description": { "description": "The description of the level.", "type": "string" }, "experience_requirements": { "description": "The experience requirements for the level.", "type": "string" }, "global_level": { "anyOf": [ { "description": "Global level is used to track the seniority of levels. The higher up a level is placed on the page, the more senior and higher-ranked the level. Global level is used in workflows, policies, and reports that use the level attribute (e.g., you can use Level Lookup to set up a workflow that notifies the nearest person in an worker's management chain at or above the specified level).", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the level. Must be unique within the company or organization.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLevel", "description": "The parent level.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent level.", "type": "string" }, "rank": { "anyOf": [ { "description": "The rank of the level within its track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "scope_of_responsibilities": { "description": "The scope of responsibilities for the level.", "type": "string" }, "track": { "description": "The track associated with the level, if it's not a global level.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_default": { "description": "Whether this is the company's default track.", "type": "boolean" }, "name": { "description": "The name of the track. Must be unique within the company or organization.", "type": "string" }, "order": { "anyOf": [ { "description": "The one-based horizontal display order of the track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "start_global_level": { "anyOf": [ { "description": "The highest global level occupied by this track. Empty tracks return null.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Track", "type": "object" }, "track_id": { "description": "The track associated with the level. Required during creation. Include global_level when changing it.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Level", "type": "object" }, "level_id": { "description": "The level of the worker.", "type": "string" }, "location": { "description": "The location that the worker is mapped to for tax purposes. In the case that a worker is remote, the location's type is remote.", "properties": { "type": { "description": "The type of location.", "type": "string" }, "work_location_id": { "description": "The work location, if the worker isn't remote.", "type": "string" } }, "required": [ "type", "work_location_id" ], "title": "WorkerLocation", "type": "object" }, "manager": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's manager.\n\nExpandable field", "type": "object" }, "manager_id": { "description": "The worker's manager.", "type": "string" }, "number": { "anyOf": [ { "description": "The worker's number within the organization.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "original_start_date": { "description": "The worker's earliest start date across their employment history, excluding INIT roles.", "type": "string" }, "overtime_exemption": { "description": "The worker's overtime exemption status.", "type": "string" }, "pay_schedule_id": { "description": "The ID of the pay schedule currently associated with the worker.", "type": "string" }, "personal_email": { "description": "The worker's associated personal email address.", "type": "string" }, "race": { "description": "The identified race of the worker, if specified.", "type": "string" }, "start_date": { "description": "The start date of the worker.", "type": "string" }, "status": { "description": "The worker's status within the organization.", "type": "string" }, "teams": { "description": "The worker's assigned teams.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiTeamcb26bc28f32f" }, "type": "array" }, "teams_id": { "description": "The worker's assigned teams.", "items": { "type": "string" }, "type": "array" }, "termination_details": { "description": "The details of the worker's termination, if applicable.", "properties": { "reason": { "description": "This is a description that will be custom to each Rippling company.", "type": "string" }, "type": { "description": "The termination type indicates whether the termination was voluntary or involuntary.", "type": "string" } }, "title": "TerminationDetails", "type": "object" }, "title": { "description": "The worker's title.", "type": "string" }, "title_effective_date": { "description": "Title effective date", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "user": { "description": "The worker's associated user.\n\nExpandable field", "properties": { "active": { "description": "Whether the user is able to access company resources, typically when they are in actively engaged with the company and not after off-boarding.", "type": "boolean" }, "addresses": { "description": "The user's addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiUserAddressedd59b9ba9a1" }, "type": "array" }, "created_at": { "description": "Record creation date", "type": "string" }, "display_name": { "description": "The display name of the user using either the concatenated preferred given and family name or username depending on availability.", "type": "string" }, "emails": { "description": "The user's email addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiEmail5284c8258dc3" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "locale": { "description": "The User's default location for purposes of localization of currency, date time format, or numerical representations pursuant to RFC5646.", "type": "string" }, "name": { "description": "The user's name.", "properties": { "family_name": { "description": "The legal family name of the user, or last name in most Western languages.", "type": "string" }, "formatted": { "description": "The user's full name.", "type": "string" }, "given_name": { "description": "The given legal name of the user, or first name in most Western languages.", "type": "string" }, "middle_name": { "description": "The middle name(s) of the user.", "type": "string" }, "preferred_family_name": { "description": "The preferred family name, or last name in most Western languages, by the user.", "type": "string" }, "preferred_given_name": { "description": "The preferred given name, or first name in most Western languages, by the user.", "type": "string" } }, "title": "UserName", "type": "object" }, "number": { "description": "The permanent profile number of the user.", "type": "string" }, "phone_numbers": { "description": "The user's phone numbers.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoneNumber12060c61ecf5" }, "type": "array" }, "photos": { "description": "The user's photos.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoto2be7c3ae3f39" }, "type": "array" }, "preferred_language": { "description": "The User's preferred written or spoken language in the same format of the HTTP Accept-Language header, pursuant to Section 5.3.5 of RFC7231.", "type": "string" }, "timezone": { "description": "The User's current time zone in IANA database Olson format", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "username": { "description": "The unique identifier across Rippling used by the User for direct authentication into their associated company. Globally unique.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "User", "type": "object" }, "user_id": { "description": "The worker's associated user.", "type": "string" }, "work_email": { "description": "The worker's associated work email address.", "type": "string" }, "work_schedule": { "additionalProperties": { "$ref": "#/components/schemas/OutputRestApiWorkScheduleDay938f88d94f20" }, "description": "The worker's scheduled working hours for each day of the week.", "type": "object" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Worker", "type": "object" }, "worker_id": { "description": "ID of the Rippling worker associated with this external app account.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "AppUser", "type": "object" }, "OutputRestApiApplication37f1c9a97e1a": { "description": "", "properties": { "applied_at": { "description": "Application creation date", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "job": { "description": "Job requisition\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "Job requisition name", "type": "string" }, "status": { "description": "Job requisition status", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "status", "updated_at" ], "title": "JobRequisition", "type": "object" }, "job_id": { "description": "Job requisition ID", "type": "string" }, "stage": { "description": "Application stage", "type": "string" }, "status": { "description": "Application status", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "url": { "description": "Application url", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Application", "type": "object" }, "OutputRestApiAttributeChangeDetails97f04b441f25": { "description": "", "properties": { "attribute_changes": { "description": "List of attributes that were modified as part of the change.", "items": { "$ref": "#/components/schemas/OutputRestApiAttributeChangea2d1197745d6" }, "type": "array" }, "changed_by_worker": { "description": "Worker who made the change\n\nExpandable field", "properties": { "business_partners": { "description": "Worker's assigned business partners. This field is only populated when explicitly requested via the expand parameter (e.g., ?expand=business_partners). When expanded, returns an empty list ([]) if the worker has no business partners.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiBusinessPartner77b00a069c32" }, "type": "array" }, "business_partners_id": { "description": "Worker's assigned business partners unique identifiers. Returns an empty list ([]) if the worker has no business partners.", "items": { "type": "string" }, "type": "array" }, "citizenship": { "description": "The countries that the worker has citizenship in.", "type": "string" }, "compensation": { "description": "The compensation package for the worker.\n\nExpandable field", "properties": { "annual_compensation": { "description": "The worker's annual compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "annual_salary_equivalent": { "description": "The worker's annual salary equivalent, for insurance purposes. It will be equal to the worker's annual compensation, except for owners that are receiving no cashcompensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "bonus_schedule": { "description": "The worker's bonus schedule.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "hourly_wage": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "id": { "description": "Identifier field", "type": "string" }, "monthly_compensation": { "description": "The worker's monthly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "on_target_commission": { "description": "The worker's on-target commission.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "payment_terms": { "description": "The payment terms for an worker's compensation.", "type": "string" }, "payment_type": { "description": "The payment type for an worker's compensation.", "type": "string" }, "relocation_reimbursement": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "salary_effective_date": { "description": "Salary effective date", "type": "string" }, "signing_bonus": { "description": "The worker's signing bonus.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus": { "description": "The worker's target annual bonus amount.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus_percent": { "anyOf": [ { "description": "The worker's target annual bonus as a percent of annual compensation.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" }, "weekly_compensation": { "description": "The worker's weekly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "worker": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's details.\n\nExpandable field", "type": "object" }, "worker_id": { "description": "The worker's ID.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Compensation", "type": "object" }, "compensation_grade": { "description": "The compensation grade assigned to the worker, if any.", "properties": { "id": { "description": "The compensation grade's unique identifier.", "type": "string" }, "label": { "description": "The compensation grade's label.", "type": "string" } }, "title": "WorkerCompensationGrade", "type": "object" }, "compensation_id": { "description": "The compensation package for the worker.", "type": "string" }, "country": { "description": "The worker's country.", "type": "string" }, "country_fields": { "description": "Country level fields for the worker.", "properties": { "ca": { "description": "Country-wise regional fields for Canada", "properties": { "sin": { "description": "Social Insurance Number (SIN) for Canada employees.", "type": "string" } }, "title": "CanadaFields", "type": "object" }, "nz": { "description": "Country-wise regional fields for New Zealand", "properties": { "ird_number": { "description": "Inland Revenue Department (IRD) number for New Zealand employees.", "type": "string" } }, "title": "NewZealandFields", "type": "object" }, "us": { "description": "Country-wise regional fields for USA", "properties": { "ssn": { "description": "Social Security Number (SSN) for US employees.", "type": "string" } }, "title": "USFields", "type": "object" } }, "title": "CountryFields", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "custom_fields": { "description": "Custom field values defined on the Employee object for this worker\n\nExpandable field", "items": { "additionalProperties": {} }, "type": "array" }, "date_of_birth": { "description": "The worker's date of birth.", "type": "string" }, "department": { "description": "The worker's assigned department.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "department_hierarchy": { "description": "List of departments in the department hierarchy. Refer department_hierarchy_ids for department hierarchy order.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestDepartment" }, "type": "array" }, "department_hierarchy_id": { "description": "The identifier of departments in the department hierarchy ordered from parent department to child department.", "items": { "type": "string" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the department.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestDepartment", "description": "The parent department.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent department.", "type": "string" }, "reference_code": { "description": "Reference code of the department.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Department", "type": "object" }, "department_id": { "description": "The worker's assigned department.", "type": "string" }, "employment_type": { "description": "The worker's employment type.\n\nExpandable field", "properties": { "amount_worked": { "description": "The amount worked for the employment type. * `FULL-TIME`: Full-time is at least 30 hours per week. Full-time workers will typically be eligible for benefits. * `PART-TIME`: Part-time is less than 30 hours per week. These workers may be eligible for benefits, depending on company settings and hours worked. * `TEMPORARY`: These workers are hired on a temporary basis. You can specify how each worker with this employment type will be paid individually.", "type": "string" }, "compensation_time_period": { "description": "The compensation period for the employment type. * `SALARIED`: Employees that are paid a fixed amount per year. * `HOURLY`: Employees that are paid a wage per hour worked.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "label": { "description": "The display label of the employment type.", "type": "string" }, "name": { "description": "The name of the employment type for non-custom employment types.", "type": "string" }, "type": { "description": "The classification of the worker by the company. * `CONTRACTOR`: Contractors are self-employed workers who provide services on a short-term or per-project basis and are not eligible for tax-withholding or benefits. * `EMPLOYEE`: Employees are hired and managed by an employer, work under the employer's direct supervision and control, and are protected by law for wages and employment rights.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "label", "updated_at" ], "title": "CompanyEmploymentType", "type": "object" }, "employment_type_id": { "description": "The worker's employment type.", "type": "string" }, "end_date": { "description": "The end date of the worker.", "type": "string" }, "ethnicity": { "description": "The identified ethnicity of the worker, if specified.", "type": "string" }, "gender": { "description": "The gender of the worker, if specified.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_manager": { "description": "Whether the worker is a manager", "type": "boolean" }, "job_function": { "description": "The worker's job function. When expanded, this field requires `job-functions.read`.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "Displayed name of the job function", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "JobFunction", "type": "object" }, "job_function_id": { "description": "ID of the worker's job function.", "type": "string" }, "legal_entity": { "description": "The worker's associated legal entity.\n\nExpandable field", "properties": { "company": { "description": "The company or organization associated with the legal entity\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "doing_business_as_name": { "description": "The doing business as name for the company.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_entities": { "description": "A list of the company's entities.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestLegalEntity" }, "type": "array" }, "legal_entities_id": { "description": "A list of the company's entities.", "items": { "type": "string" }, "type": "array" }, "legal_name": { "description": "The legal name of the company.", "type": "string" }, "name": { "description": "The name of the company.", "type": "string" }, "parent_legal_entity": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The company's ultimate holding entity.\n\nExpandable field", "type": "object" }, "parent_legal_entity_id": { "description": "The company's ultimate holding entity.", "type": "string" }, "phone": { "description": "The phone number for the company.", "type": "string" }, "physical_address": { "description": "The physical address of the holding entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "primary_email": { "description": "The email address used when registering this company.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "legal_entities", "legal_entities_id", "name", "updated_at" ], "title": "Company", "type": "object" }, "company_id": { "description": "The company or organization associated with the legal entity", "type": "string" }, "country": { "description": "The country the legal entity is based in.", "properties": { "code": { "description": "The code of the country.", "type": "string" } }, "required": [ "code" ], "title": "Country", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "entity_level": { "description": "The legal entity's level in a hierarchy. * `PARENT`: The legal entity is considered the ultimate holding entity. * `SUBSIDIARY`: The legal entity is considered a subsidiary, fully or partially held by another. * `BRANCH`: The legal entity is considered a branch, associated with a parent legal entity.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_name": { "description": "The legal name of the legal entity.", "type": "string" }, "mailing_address": { "description": "The mailing address of the legal entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "management_type": { "description": "The legal entity management type in the case of an employer of record (EOR) or professional employment organization (PEO). * `PEO`: The legal entity is considered a Professional Employment Organization (PEO). * `EOR`: The legal entity is considered an Employer of Record (EOR).", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The parent legal entity.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent legal entity.", "type": "string" }, "physical_address": { "description": "The physical address of the legal entity, if it differs from the mailing address.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "registration_date": { "description": "The registration date of the entity.", "type": "string" }, "tax_identifier": { "description": "The tax identifier for the legal entity.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "LegalEntity", "type": "object" }, "legal_entity_id": { "description": "The worker's associated legal entity.", "type": "string" }, "level": { "description": "The level of the worker.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "description": { "description": "The description of the level.", "type": "string" }, "experience_requirements": { "description": "The experience requirements for the level.", "type": "string" }, "global_level": { "anyOf": [ { "description": "Global level is used to track the seniority of levels. The higher up a level is placed on the page, the more senior and higher-ranked the level. Global level is used in workflows, policies, and reports that use the level attribute (e.g., you can use Level Lookup to set up a workflow that notifies the nearest person in an worker's management chain at or above the specified level).", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the level. Must be unique within the company or organization.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLevel", "description": "The parent level.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent level.", "type": "string" }, "rank": { "anyOf": [ { "description": "The rank of the level within its track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "scope_of_responsibilities": { "description": "The scope of responsibilities for the level.", "type": "string" }, "track": { "description": "The track associated with the level, if it's not a global level.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_default": { "description": "Whether this is the company's default track.", "type": "boolean" }, "name": { "description": "The name of the track. Must be unique within the company or organization.", "type": "string" }, "order": { "anyOf": [ { "description": "The one-based horizontal display order of the track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "start_global_level": { "anyOf": [ { "description": "The highest global level occupied by this track. Empty tracks return null.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Track", "type": "object" }, "track_id": { "description": "The track associated with the level. Required during creation. Include global_level when changing it.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Level", "type": "object" }, "level_id": { "description": "The level of the worker.", "type": "string" }, "location": { "description": "The location that the worker is mapped to for tax purposes. In the case that a worker is remote, the location's type is remote.", "properties": { "type": { "description": "The type of location.", "type": "string" }, "work_location_id": { "description": "The work location, if the worker isn't remote.", "type": "string" } }, "required": [ "type", "work_location_id" ], "title": "WorkerLocation", "type": "object" }, "manager": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's manager.\n\nExpandable field", "type": "object" }, "manager_id": { "description": "The worker's manager.", "type": "string" }, "number": { "anyOf": [ { "description": "The worker's number within the organization.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "original_start_date": { "description": "The worker's earliest start date across their employment history, excluding INIT roles.", "type": "string" }, "overtime_exemption": { "description": "The worker's overtime exemption status.", "type": "string" }, "pay_schedule_id": { "description": "The ID of the pay schedule currently associated with the worker.", "type": "string" }, "personal_email": { "description": "The worker's associated personal email address.", "type": "string" }, "race": { "description": "The identified race of the worker, if specified.", "type": "string" }, "start_date": { "description": "The start date of the worker.", "type": "string" }, "status": { "description": "The worker's status within the organization.", "type": "string" }, "teams": { "description": "The worker's assigned teams.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiTeamcb26bc28f32f" }, "type": "array" }, "teams_id": { "description": "The worker's assigned teams.", "items": { "type": "string" }, "type": "array" }, "termination_details": { "description": "The details of the worker's termination, if applicable.", "properties": { "reason": { "description": "This is a description that will be custom to each Rippling company.", "type": "string" }, "type": { "description": "The termination type indicates whether the termination was voluntary or involuntary.", "type": "string" } }, "title": "TerminationDetails", "type": "object" }, "title": { "description": "The worker's title.", "type": "string" }, "title_effective_date": { "description": "Title effective date", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "user": { "description": "The worker's associated user.\n\nExpandable field", "properties": { "active": { "description": "Whether the user is able to access company resources, typically when they are in actively engaged with the company and not after off-boarding.", "type": "boolean" }, "addresses": { "description": "The user's addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiUserAddressedd59b9ba9a1" }, "type": "array" }, "created_at": { "description": "Record creation date", "type": "string" }, "display_name": { "description": "The display name of the user using either the concatenated preferred given and family name or username depending on availability.", "type": "string" }, "emails": { "description": "The user's email addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiEmail5284c8258dc3" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "locale": { "description": "The User's default location for purposes of localization of currency, date time format, or numerical representations pursuant to RFC5646.", "type": "string" }, "name": { "description": "The user's name.", "properties": { "family_name": { "description": "The legal family name of the user, or last name in most Western languages.", "type": "string" }, "formatted": { "description": "The user's full name.", "type": "string" }, "given_name": { "description": "The given legal name of the user, or first name in most Western languages.", "type": "string" }, "middle_name": { "description": "The middle name(s) of the user.", "type": "string" }, "preferred_family_name": { "description": "The preferred family name, or last name in most Western languages, by the user.", "type": "string" }, "preferred_given_name": { "description": "The preferred given name, or first name in most Western languages, by the user.", "type": "string" } }, "title": "UserName", "type": "object" }, "number": { "description": "The permanent profile number of the user.", "type": "string" }, "phone_numbers": { "description": "The user's phone numbers.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoneNumber12060c61ecf5" }, "type": "array" }, "photos": { "description": "The user's photos.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoto2be7c3ae3f39" }, "type": "array" }, "preferred_language": { "description": "The User's preferred written or spoken language in the same format of the HTTP Accept-Language header, pursuant to Section 5.3.5 of RFC7231.", "type": "string" }, "timezone": { "description": "The User's current time zone in IANA database Olson format", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "username": { "description": "The unique identifier across Rippling used by the User for direct authentication into their associated company. Globally unique.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "User", "type": "object" }, "user_id": { "description": "The worker's associated user.", "type": "string" }, "work_email": { "description": "The worker's associated work email address.", "type": "string" }, "work_schedule": { "additionalProperties": { "$ref": "#/components/schemas/OutputRestApiWorkScheduleDay938f88d94f20" }, "description": "The worker's scheduled working hours for each day of the week.", "type": "object" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Worker", "type": "object" }, "changed_by_worker_id": { "description": "Identifier of worker who made the change", "type": "string" }, "created_at": { "description": "The time the change was requested by worker", "type": "string" }, "effective_from_date": { "description": "The time the change was scheduled to take effect on", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "reason": { "description": "Reason provided by worker for making the change", "type": "string" }, "updated_at": { "description": "The time the change was applied", "type": "string" } }, "required": [ "id" ], "title": "AttributeChangeDetails", "type": "object" }, "OutputRestApiAttributeChangea2d1197745d6": { "description": "", "properties": { "attribute_name": { "description": "The name of attribute changed.", "type": "string" }, "new_attribute_value": { "description": "New value of attribute, after the change", "type": "object" }, "old_attribute_value": { "description": "Old value of attribute, before the change.", "type": "object" } }, "title": "AttributeChange", "type": "object" }, "OutputRestApiBackgroundCheckCandidatec01e79007528": { "description": "\n Background Check Candidate DTO.\n\n Represents a candidate who has been submitted for background check screening.\n\n Required on Create (but nullable on read for legacy rows):\n - email: Required for new candidates, but may be null on read for legacy rows\n - external_id: Required for new candidates, but may be null on read for legacy rows\n\n Optional Fields:\n - owner_id: May be null if no provider is associated\n - first_name: May be null if name is not available\n - last_name: May be null if name is not available\n - middle_name: May be null if not provided\n\n Sensitive Fields:\n - first_name, last_name, middle_name: Name fields are PII marked as sensitive in the model\n - These do not require separate OAuth scopes beyond the resource-level scopes\n (background-check-candidates.read / .read-write) because they are not updating\n role or worker data, only storing candidate names for background check processing\n\n Note: first_name, last_name, and middle_name are NOT filterable.\n Only external_id, email, created_at, and updated_at support filtering.\n ", "properties": { "created_at": { "description": "The timestamp when the candidate was created.", "type": "string" }, "email": { "description": "The email address of the candidate. Required on create, but may be null on read for legacy rows.", "type": "string" }, "external_id": { "description": "The provider's unique identifier for the candidate. Required on create, but may be null on read for legacy rows. Can only be set once (during creation or when null). Cannot be changed after being set.", "type": "string" }, "first_name": { "description": "The first name of the candidate.", "type": "string" }, "id": { "description": "The unique identifier of the background check candidate.", "type": "string" }, "last_name": { "description": "The last name of the candidate.", "type": "string" }, "middle_name": { "description": "The middle name of the candidate.", "type": "string" }, "owner_id": { "description": "The ID of the background check provider (OAuth spoke owner).", "type": "string" }, "updated_at": { "description": "The timestamp when the candidate was last updated.", "type": "string" } }, "required": [ "email", "external_id" ], "title": "BackgroundCheckCandidate", "type": "object" }, "OutputRestApiBalanceAdjustmentInputab4e8d80def3": { "description": "", "properties": { "accrual_type": { "description": "Accrual type to use when applying the adjustment.", "type": "string" }, "amount": { "description": "Adjustment amount serialized as a decimal string.", "type": "string" }, "leave_type": { "description": "Leave type to adjust if applying the evaluation.", "type": "string" }, "unit": { "description": "Unit for the adjustment amount, such as WEEKS, DAYS, or HOURS.", "type": "string" } }, "required": [ "amount", "leave_type", "unit" ], "title": "BalanceAdjustmentInput", "type": "object" }, "OutputRestApiBillPaymentLineItem3bf57be649fb": { "description": "", "properties": { "amortization_status": { "description": "Amortization state. Null when not set.", "type": "string" }, "amortized": { "description": "Whether this line is amortized.", "type": "boolean" }, "amount": { "description": "Amount of this split, in the merchant currency. The `value` is a decimal string.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "category_id": { "description": "ID of the Spend category assigned to this split. No public API is currently available to retrieve this category; its name is in `category_name`.", "type": "string" }, "category_name": { "description": "Name of the spend category.", "type": "string" }, "dimension_choices": { "additionalProperties": { "$ref": "#/components/schemas/OutputRestApiDimensionChoice299d74541a33" }, "description": "Selected dimension values, keyed by dimension ID. Includes department and work location.", "type": "object" }, "discount": { "description": "Discount on the item as a percentage (`10.00` means 10%), as a decimal string. Null when not set.", "type": "string" }, "end_date": { "description": "Amortization end date. Null when not set.", "type": "string" }, "gl_amortization_schedule": { "description": "ID of the amortization schedule in the connected accounting integration. No public API is currently available to retrieve it. Null when not set.", "type": "string" }, "gl_amortization_template": { "description": "ID of the amortization template in the connected accounting integration. No public API is currently available to retrieve it. Null when not set.", "type": "string" }, "gl_billable": { "description": "Whether this split is billed to `gl_customer` in the accounting system. `BILLABLE` means it is billed, `NOT_BILLABLE` means it is not. Null when not set.", "type": "string" }, "gl_customer": { "description": "ID of the customer record in the connected accounting integration. No public Rippling API is currently available to retrieve this accounting customer.", "type": "string" }, "gl_tax_code": { "description": "Rippling ID of the tax code synced from the connected accounting integration. No public API is currently available to retrieve it. Null when not set.", "type": "string" }, "memo": { "description": "Memo entered on this split.", "type": "string" }, "prepaid_account": { "description": "ID of the prepaid account in the connected accounting integration. No public API is currently available to retrieve it. Null when not set.", "type": "string" }, "price": { "description": "Unit price, in the merchant currency. The `value` is a decimal string. Null when not set.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "quantity": { "description": "Item quantity, as a decimal string. Null when not set.", "type": "string" }, "quantity_unit_of_measure": { "description": "Unit for quantity, such as tons or seats. Null when quantity is not set.", "type": "string" }, "start_date": { "description": "Amortization start date. Null when not set.", "type": "string" }, "tax_amount": { "description": "Tax amount entered on the line, in the merchant currency. The `value` is a decimal string. Null when not set.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "tax_code_display_alias": { "description": "Display name of the tax code. Null when not set.", "type": "string" }, "term": { "description": "Term length, as a decimal string. Null when not set.", "type": "string" }, "term_unit_of_measure": { "description": "Unit for term: YEARS, QUARTERS, MONTHS, WEEKS, or DAYS. Null when term is not set.", "type": "string" }, "total_amortized_amount": { "description": "Amount amortized so far, in the company's headquarters currency. The `value` is a decimal string. Null when not set.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" } }, "title": "BillPaymentLineItem", "type": "object" }, "OutputRestApiBillPaymentee88dd92df5e": { "description": "A bill payment visible to the caller, including its invoice and payment details.", "properties": { "accounting_date": { "description": "Date the transaction is booked in the accounting system, as an ISO 8601 date (YYYY-MM-DD).", "type": "string" }, "approval_status": { "description": "Approval state of the bill. `DRAFT`: not submitted. `PENDING`: awaiting required information before submission. `REQUESTED`: awaiting approval. `APPROVED`: approved. `REJECTED`: rejected. `FINALIZED`: finalized for payment. `ACTIONED`: paid. `CANCELLED`: cancelled. `FAILED`: payment failed.", "type": "string" }, "attachments": { "description": "URLs of other attached files.", "items": { "type": "string" }, "type": "array" }, "check_date": { "description": "Date the company is debited, as an ISO 8601 date. Null when not set.", "type": "string" }, "company_amount": { "description": "Amount in the company's headquarters currency. The `value` is a decimal string.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "credit_method": { "description": "How the vendor is paid: ACH, WIRE, CHECK, GLOBAL_ORDER, EXISTING_CORPORATE_CARD, or MANUALLY_PAID.", "type": "string" }, "debit_method": { "description": "How the company is debited: ACH, WIRE, EXISTING_CORPORATE_CARD, or MANUALLY_PAID.", "type": "string" }, "due_date": { "description": "Invoice due date, as an ISO 8601 date. A draft can omit it.", "type": "string" }, "entity_id": { "description": "ID of the legal entity the transaction belongs to. Use it with `/company-legal-entities/{id}/`.", "type": "string" }, "estimated_payment_arrival": { "description": "When the vendor is expected to receive the payment, as an ISO 8601 date-time in UTC. Null when not set.", "type": "string" }, "gl_sync_state": { "description": "State of the sync to the accounting system. `NOT_FINALIZED`: not ready for accounting review. `FOR_REVIEW`: ready for accounting review. `PENDING_SYNC`: sync is in progress. `SYNCED`: synced to the accounting system. `ERROR`: sync failed. `DO_NOT_SYNC`: marked to be excluded from sync. `EXPORTED`: exported for accounting. `NOT_SYNCABLE`: this record cannot be synced. `AUTO_SYNC`: ready to be synced automatically. Null when no sync state is set.", "type": "string" }, "gl_vendor": { "description": "Vendor in the connected accounting system.", "properties": { "gl_vendor_id": { "description": "ID of the vendor in the accounting system.", "type": "string" }, "id": { "description": "ID of the accounting vendor in Rippling.", "type": "string" }, "name": { "description": "Name of the vendor in the accounting system.", "type": "string" } }, "title": "GLVendor", "type": "object" }, "global_purpose": { "description": "Purpose code for an international payment. Null for domestic payments.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "invoice_number": { "description": "Invoice number. Null when the bill has no invoice number.", "type": "string" }, "line_items": { "description": "Bill line items, including accounting, tax, quantity, and term details.", "items": { "$ref": "#/components/schemas/OutputRestApiBillPaymentLineItem3bf57be649fb" }, "type": "array" }, "memo": { "description": "Memo entered on the transaction.", "type": "string" }, "merchant_amount": { "description": "Amount charged by the merchant, in the merchant currency. The `value` is a decimal string.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "parent_bill_id": { "description": "ID of the bill this payment was split from. Use it with `/bill-payments/{id}/`. Null when it is not a split bill.", "type": "string" }, "payment_amount": { "description": "Amount paid to the vendor, in the payment currency. The value is a decimal string.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "payment_method_fee": { "description": "Payment method fee, in the company's headquarters currency. The `value` is a decimal string. Zero when there is no fee.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "payment_schedule_setting": { "description": "SCHEDULE_NOW when a debit date was chosen; SKIP_FOR_NOW when choosing one was skipped.", "type": "string" }, "payment_velocity": { "description": "How fast the vendor is paid after `check_date`: `TWO_DAY` (accelerated, 2 business days) or `FOUR_DAY` (standard, 4 business days).", "type": "string" }, "receipt": { "description": "URL of the receipt file.", "type": "string" }, "scheduled_payment_date": { "description": "Date used to estimate vendor payment, as an ISO 8601 date. Null when not set.", "type": "string" }, "submitter_id": { "description": "ID of the bill manager who submitted the bill. Use it with `/workers/{id}/`. Can differ from `worker_id`. Null before submission.", "type": "string" }, "transaction_date": { "description": "Invoice date, as an ISO 8601 date-time in UTC. Null when not set.", "type": "string" }, "transaction_type": { "description": "Type of transaction: `BILL_PAYMENT`.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "vendor": { "description": "Vendor the purchase was made from.", "properties": { "id": { "description": "ID of the vendor.", "type": "string" }, "name": { "description": "Name of the vendor.", "type": "string" } }, "title": "Vendor", "type": "object" }, "vendor_memo": { "description": "Memo included on the payment to the vendor. Supported for ACH; null when not set.", "type": "string" }, "vendor_paid_date": { "description": "Date the vendor is paid, as an ISO 8601 date. Null until paid.", "type": "string" }, "worker_id": { "description": "ID of the worker who made the transaction. Use it with `/workers/{id}/`.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "BillPayment", "type": "object" }, "OutputRestApiBiweeklyScheduleTriggerc261b277efb4": { "additionalProperties": false, "properties": { "days_of_week": { "items": { "anyOf": [ { "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "type": "array" }, "hour": { "anyOf": [ { "maximum": 23, "minimum": 0, "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "kind": { "type": "string" }, "minute": { "anyOf": [ { "default": 0, "maximum": 59, "minimum": 0, "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "timezone": { "type": "string" } }, "required": [ "days_of_week", "hour", "kind", "timezone" ], "title": "BiweeklyScheduleTrigger", "type": "object" }, "OutputRestApiBreak50f807167b82": { "description": "", "properties": { "break_type_id": { "description": "The ID of the break type.", "type": "string" }, "end_time": { "description": "The end time of the break.", "type": "string" }, "original_end_time": { "description": "The original end time of the break. If the endTime field has been rounded then this contain the end time before the rounding occured.", "type": "string" }, "original_start_time": { "description": "The original start time of the break. If the startTime field has been rounded then this contain the start time before the rounding occured.", "type": "string" }, "start_time": { "description": "The start time of the break.", "type": "string" } }, "title": "Break", "type": "object" }, "OutputRestApiBreakPolicycdd2c69fe56e": { "description": "", "properties": { "country_code": { "description": "ISO 3166-1 alpha-2 country code the policy applies to (e.g. 'US', 'CA', 'GB').", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_default": { "description": "Whether this is a system-seeded default policy (true) or a custom policy created by an admin (false).", "type": "boolean" }, "name": { "description": "The display name of the break policy. For default policies this is the system-generated label (e.g. 'Default Break policy: All Workers | California'); for custom policies this is the admin-provided description.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "BreakPolicy", "type": "object" }, "OutputRestApiBreakType7a4805efe181": { "description": "", "properties": { "break_category": { "description": "The break category. One of: MEAL, REST, or OTHER.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_paid": { "description": "Whether this is a paid break (true) or unpaid (false).", "type": "boolean" }, "name": { "description": "The display name of the break type.", "type": "string" }, "policy": { "description": "The break policy this break type belongs to. Use ?expand=policy to inline the full policy object.\n\nExpandable field", "properties": { "country_code": { "description": "ISO 3166-1 alpha-2 country code the policy applies to (e.g. 'US', 'CA', 'GB').", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_default": { "description": "Whether this is a system-seeded default policy (true) or a custom policy created by an admin (false).", "type": "boolean" }, "name": { "description": "The display name of the break policy. For default policies this is the system-generated label (e.g. 'Default Break policy: All Workers | California'); for custom policies this is the admin-provided description.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "BreakPolicy", "type": "object" }, "policy_id": { "description": "The ID of the break policy this break type belongs to.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "BreakType", "type": "object" }, "OutputRestApiBusinessEventTrigger16af6dea9307": { "additionalProperties": false, "properties": { "event_name": { "type": "string" }, "kind": { "type": "string" } }, "required": [ "event_name", "kind" ], "title": "BusinessEventTrigger", "type": "object" }, "OutputRestApiBusinessPartner01691db528c5": { "description": "", "properties": { "business_partner_group": { "$ref": "#/components/schemas/OutputRestBusinessPartnerGroup", "description": "Business partner group the business partner is a part of\n\nExpandable field", "type": "object" }, "business_partner_group_id": { "description": "Identifier of business partner group the business parter is a part of", "type": "string" }, "client_group": { "description": "Group of workers associated with the business partner\n\nExpandable field", "properties": { "allow_non_employees": { "description": "Whether the group allows non employees", "type": "boolean" }, "app_owner_id": { "description": "The id of the group's app owner.", "type": "string" }, "can_override_role_states": { "description": "Whether the group can override role states", "type": "boolean" }, "created_at": { "description": "Record creation date", "type": "string" }, "cumulatively_exhaustive_default": { "description": "Whether the group is the cumulatively exhaustive default", "type": "boolean" }, "description": { "description": "The group's description.", "type": "string" }, "display_name": { "description": "The group's display name.", "type": "string" }, "group_type": { "description": "The group type", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "ignore_prov_group_matching": { "description": "Whether to ignore provisioning group matching when determining group membership", "type": "boolean" }, "include_terminated": { "description": "Whether the group include terminated roles", "type": "boolean" }, "is_invisible": { "description": "Whether the group is invisible", "type": "boolean" }, "mutually_exclusive_key": { "description": "The group's mutually exclusive key", "type": "string" }, "name": { "description": "The group's name.", "type": "string" }, "parent": { "description": "The group's parent.", "type": "string" }, "priority": { "anyOf": [ { "description": "The group's priority when calculating mutual exclusivity", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "read_only": { "description": "Whether the group is read only.", "type": "boolean" }, "sub_group_type": { "description": "The sub group type", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Supergroup", "type": "object" }, "client_group_id": { "description": "Identifier of group of workers associated with the business partner", "type": "string" }, "client_group_member_count": { "anyOf": [ { "description": "Number of workers associated with the business partner", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "worker": { "$ref": "#/components/schemas/OutputRestWorker", "description": "Worker who is the business partner\n\nExpandable field", "type": "object" }, "worker_id": { "description": "Identifier of worker who is the business partner", "type": "string" } }, "required": [ "business_partner_group_id", "created_at", "id", "updated_at", "worker_id" ], "title": "BusinessPartner", "type": "object" }, "OutputRestApiBusinessPartner77b00a069c32": { "description": "", "properties": { "business_partner_group": { "description": "Business partner group the business partner is a part of\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "default_business_partner": { "$ref": "#/components/schemas/OutputRestWorker", "description": "Optional default business partner worker to whom all employees will be mapped if not explicitly mapped to a business partner in the group.\n\nExpandable field", "type": "object" }, "default_business_partner_id": { "description": "Id of Optional default business partner worker to whom all employees will be mapped if not explicitly mapped to a business partner in the group.", "type": "string" }, "domain": { "description": "Type of business partner group", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "Name used to identify business partner group", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "BusinessPartnerGroup", "type": "object" }, "business_partner_group_id": { "description": "Identifier of business partner group the business parter is a part of", "type": "string" }, "client_group": { "description": "Group of workers associated with the business partner\n\nExpandable field", "properties": { "allow_non_employees": { "description": "Whether the group allows non employees", "type": "boolean" }, "app_owner_id": { "description": "The id of the group's app owner.", "type": "string" }, "can_override_role_states": { "description": "Whether the group can override role states", "type": "boolean" }, "created_at": { "description": "Record creation date", "type": "string" }, "cumulatively_exhaustive_default": { "description": "Whether the group is the cumulatively exhaustive default", "type": "boolean" }, "description": { "description": "The group's description.", "type": "string" }, "display_name": { "description": "The group's display name.", "type": "string" }, "group_type": { "description": "The group type", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "ignore_prov_group_matching": { "description": "Whether to ignore provisioning group matching when determining group membership", "type": "boolean" }, "include_terminated": { "description": "Whether the group include terminated roles", "type": "boolean" }, "is_invisible": { "description": "Whether the group is invisible", "type": "boolean" }, "mutually_exclusive_key": { "description": "The group's mutually exclusive key", "type": "string" }, "name": { "description": "The group's name.", "type": "string" }, "parent": { "description": "The group's parent.", "type": "string" }, "priority": { "anyOf": [ { "description": "The group's priority when calculating mutual exclusivity", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "read_only": { "description": "Whether the group is read only.", "type": "boolean" }, "sub_group_type": { "description": "The sub group type", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Supergroup", "type": "object" }, "client_group_id": { "description": "Identifier of group of workers associated with the business partner", "type": "string" }, "client_group_member_count": { "anyOf": [ { "description": "Number of workers associated with the business partner", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "worker": { "$ref": "#/components/schemas/OutputRestWorker", "description": "Worker who is the business partner\n\nExpandable field", "type": "object" }, "worker_id": { "description": "Identifier of worker who is the business partner", "type": "string" } }, "required": [ "business_partner_group_id", "created_at", "id", "updated_at", "worker_id" ], "title": "BusinessPartner", "type": "object" }, "OutputRestApiBusinessPartner9723c10abb09": { "description": "", "properties": { "business_partner_group": { "description": "Business partner group the business partner is a part of\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "default_business_partner": { "description": "Optional default business partner worker to whom all employees will be mapped if not explicitly mapped to a business partner in the group.\n\nExpandable field", "properties": { "business_partners": { "description": "Worker's assigned business partners. This field is only populated when explicitly requested via the expand parameter (e.g., ?expand=business_partners). When expanded, returns an empty list ([]) if the worker has no business partners.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestBusinessPartner" }, "type": "array" }, "business_partners_id": { "description": "Worker's assigned business partners unique identifiers. Returns an empty list ([]) if the worker has no business partners.", "items": { "type": "string" }, "type": "array" }, "citizenship": { "description": "The countries that the worker has citizenship in.", "type": "string" }, "compensation": { "description": "The compensation package for the worker.\n\nExpandable field", "properties": { "annual_compensation": { "description": "The worker's annual compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "annual_salary_equivalent": { "description": "The worker's annual salary equivalent, for insurance purposes. It will be equal to the worker's annual compensation, except for owners that are receiving no cashcompensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "bonus_schedule": { "description": "The worker's bonus schedule.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "hourly_wage": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "id": { "description": "Identifier field", "type": "string" }, "monthly_compensation": { "description": "The worker's monthly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "on_target_commission": { "description": "The worker's on-target commission.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "payment_terms": { "description": "The payment terms for an worker's compensation.", "type": "string" }, "payment_type": { "description": "The payment type for an worker's compensation.", "type": "string" }, "relocation_reimbursement": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "salary_effective_date": { "description": "Salary effective date", "type": "string" }, "signing_bonus": { "description": "The worker's signing bonus.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus": { "description": "The worker's target annual bonus amount.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus_percent": { "anyOf": [ { "description": "The worker's target annual bonus as a percent of annual compensation.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" }, "weekly_compensation": { "description": "The worker's weekly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "worker": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's details.\n\nExpandable field", "type": "object" }, "worker_id": { "description": "The worker's ID.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Compensation", "type": "object" }, "compensation_grade": { "description": "The compensation grade assigned to the worker, if any.", "properties": { "id": { "description": "The compensation grade's unique identifier.", "type": "string" }, "label": { "description": "The compensation grade's label.", "type": "string" } }, "title": "WorkerCompensationGrade", "type": "object" }, "compensation_id": { "description": "The compensation package for the worker.", "type": "string" }, "country": { "description": "The worker's country.", "type": "string" }, "country_fields": { "description": "Country level fields for the worker.", "properties": { "ca": { "description": "Country-wise regional fields for Canada", "properties": { "sin": { "description": "Social Insurance Number (SIN) for Canada employees.", "type": "string" } }, "title": "CanadaFields", "type": "object" }, "nz": { "description": "Country-wise regional fields for New Zealand", "properties": { "ird_number": { "description": "Inland Revenue Department (IRD) number for New Zealand employees.", "type": "string" } }, "title": "NewZealandFields", "type": "object" }, "us": { "description": "Country-wise regional fields for USA", "properties": { "ssn": { "description": "Social Security Number (SSN) for US employees.", "type": "string" } }, "title": "USFields", "type": "object" } }, "title": "CountryFields", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "custom_fields": { "description": "Custom field values defined on the Employee object for this worker\n\nExpandable field", "items": { "additionalProperties": {} }, "type": "array" }, "date_of_birth": { "description": "The worker's date of birth.", "type": "string" }, "department": { "description": "The worker's assigned department.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "department_hierarchy": { "description": "List of departments in the department hierarchy. Refer department_hierarchy_ids for department hierarchy order.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestDepartment" }, "type": "array" }, "department_hierarchy_id": { "description": "The identifier of departments in the department hierarchy ordered from parent department to child department.", "items": { "type": "string" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the department.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestDepartment", "description": "The parent department.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent department.", "type": "string" }, "reference_code": { "description": "Reference code of the department.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Department", "type": "object" }, "department_id": { "description": "The worker's assigned department.", "type": "string" }, "employment_type": { "description": "The worker's employment type.\n\nExpandable field", "properties": { "amount_worked": { "description": "The amount worked for the employment type. * `FULL-TIME`: Full-time is at least 30 hours per week. Full-time workers will typically be eligible for benefits. * `PART-TIME`: Part-time is less than 30 hours per week. These workers may be eligible for benefits, depending on company settings and hours worked. * `TEMPORARY`: These workers are hired on a temporary basis. You can specify how each worker with this employment type will be paid individually.", "type": "string" }, "compensation_time_period": { "description": "The compensation period for the employment type. * `SALARIED`: Employees that are paid a fixed amount per year. * `HOURLY`: Employees that are paid a wage per hour worked.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "label": { "description": "The display label of the employment type.", "type": "string" }, "name": { "description": "The name of the employment type for non-custom employment types.", "type": "string" }, "type": { "description": "The classification of the worker by the company. * `CONTRACTOR`: Contractors are self-employed workers who provide services on a short-term or per-project basis and are not eligible for tax-withholding or benefits. * `EMPLOYEE`: Employees are hired and managed by an employer, work under the employer's direct supervision and control, and are protected by law for wages and employment rights.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "label", "updated_at" ], "title": "CompanyEmploymentType", "type": "object" }, "employment_type_id": { "description": "The worker's employment type.", "type": "string" }, "end_date": { "description": "The end date of the worker.", "type": "string" }, "ethnicity": { "description": "The identified ethnicity of the worker, if specified.", "type": "string" }, "gender": { "description": "The gender of the worker, if specified.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_manager": { "description": "Whether the worker is a manager", "type": "boolean" }, "job_function": { "description": "The worker's job function. When expanded, this field requires `job-functions.read`.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "Displayed name of the job function", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "JobFunction", "type": "object" }, "job_function_id": { "description": "ID of the worker's job function.", "type": "string" }, "legal_entity": { "description": "The worker's associated legal entity.\n\nExpandable field", "properties": { "company": { "description": "The company or organization associated with the legal entity\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "doing_business_as_name": { "description": "The doing business as name for the company.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_entities": { "description": "A list of the company's entities.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestLegalEntity" }, "type": "array" }, "legal_entities_id": { "description": "A list of the company's entities.", "items": { "type": "string" }, "type": "array" }, "legal_name": { "description": "The legal name of the company.", "type": "string" }, "name": { "description": "The name of the company.", "type": "string" }, "parent_legal_entity": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The company's ultimate holding entity.\n\nExpandable field", "type": "object" }, "parent_legal_entity_id": { "description": "The company's ultimate holding entity.", "type": "string" }, "phone": { "description": "The phone number for the company.", "type": "string" }, "physical_address": { "description": "The physical address of the holding entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "primary_email": { "description": "The email address used when registering this company.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "legal_entities", "legal_entities_id", "name", "updated_at" ], "title": "Company", "type": "object" }, "company_id": { "description": "The company or organization associated with the legal entity", "type": "string" }, "country": { "description": "The country the legal entity is based in.", "properties": { "code": { "description": "The code of the country.", "type": "string" } }, "required": [ "code" ], "title": "Country", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "entity_level": { "description": "The legal entity's level in a hierarchy. * `PARENT`: The legal entity is considered the ultimate holding entity. * `SUBSIDIARY`: The legal entity is considered a subsidiary, fully or partially held by another. * `BRANCH`: The legal entity is considered a branch, associated with a parent legal entity.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_name": { "description": "The legal name of the legal entity.", "type": "string" }, "mailing_address": { "description": "The mailing address of the legal entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "management_type": { "description": "The legal entity management type in the case of an employer of record (EOR) or professional employment organization (PEO). * `PEO`: The legal entity is considered a Professional Employment Organization (PEO). * `EOR`: The legal entity is considered an Employer of Record (EOR).", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The parent legal entity.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent legal entity.", "type": "string" }, "physical_address": { "description": "The physical address of the legal entity, if it differs from the mailing address.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "registration_date": { "description": "The registration date of the entity.", "type": "string" }, "tax_identifier": { "description": "The tax identifier for the legal entity.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "LegalEntity", "type": "object" }, "legal_entity_id": { "description": "The worker's associated legal entity.", "type": "string" }, "level": { "description": "The level of the worker.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "description": { "description": "The description of the level.", "type": "string" }, "experience_requirements": { "description": "The experience requirements for the level.", "type": "string" }, "global_level": { "anyOf": [ { "description": "Global level is used to track the seniority of levels. The higher up a level is placed on the page, the more senior and higher-ranked the level. Global level is used in workflows, policies, and reports that use the level attribute (e.g., you can use Level Lookup to set up a workflow that notifies the nearest person in an worker's management chain at or above the specified level).", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the level. Must be unique within the company or organization.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLevel", "description": "The parent level.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent level.", "type": "string" }, "rank": { "anyOf": [ { "description": "The rank of the level within its track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "scope_of_responsibilities": { "description": "The scope of responsibilities for the level.", "type": "string" }, "track": { "description": "The track associated with the level, if it's not a global level.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_default": { "description": "Whether this is the company's default track.", "type": "boolean" }, "name": { "description": "The name of the track. Must be unique within the company or organization.", "type": "string" }, "order": { "anyOf": [ { "description": "The one-based horizontal display order of the track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "start_global_level": { "anyOf": [ { "description": "The highest global level occupied by this track. Empty tracks return null.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Track", "type": "object" }, "track_id": { "description": "The track associated with the level. Required during creation. Include global_level when changing it.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Level", "type": "object" }, "level_id": { "description": "The level of the worker.", "type": "string" }, "location": { "description": "The location that the worker is mapped to for tax purposes. In the case that a worker is remote, the location's type is remote.", "properties": { "type": { "description": "The type of location.", "type": "string" }, "work_location_id": { "description": "The work location, if the worker isn't remote.", "type": "string" } }, "required": [ "type", "work_location_id" ], "title": "WorkerLocation", "type": "object" }, "manager": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's manager.\n\nExpandable field", "type": "object" }, "manager_id": { "description": "The worker's manager.", "type": "string" }, "number": { "anyOf": [ { "description": "The worker's number within the organization.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "original_start_date": { "description": "The worker's earliest start date across their employment history, excluding INIT roles.", "type": "string" }, "overtime_exemption": { "description": "The worker's overtime exemption status.", "type": "string" }, "pay_schedule_id": { "description": "The ID of the pay schedule currently associated with the worker.", "type": "string" }, "personal_email": { "description": "The worker's associated personal email address.", "type": "string" }, "race": { "description": "The identified race of the worker, if specified.", "type": "string" }, "start_date": { "description": "The start date of the worker.", "type": "string" }, "status": { "description": "The worker's status within the organization.", "type": "string" }, "teams": { "description": "The worker's assigned teams.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiTeamcb26bc28f32f" }, "type": "array" }, "teams_id": { "description": "The worker's assigned teams.", "items": { "type": "string" }, "type": "array" }, "termination_details": { "description": "The details of the worker's termination, if applicable.", "properties": { "reason": { "description": "This is a description that will be custom to each Rippling company.", "type": "string" }, "type": { "description": "The termination type indicates whether the termination was voluntary or involuntary.", "type": "string" } }, "title": "TerminationDetails", "type": "object" }, "title": { "description": "The worker's title.", "type": "string" }, "title_effective_date": { "description": "Title effective date", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "user": { "description": "The worker's associated user.\n\nExpandable field", "properties": { "active": { "description": "Whether the user is able to access company resources, typically when they are in actively engaged with the company and not after off-boarding.", "type": "boolean" }, "addresses": { "description": "The user's addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiUserAddressedd59b9ba9a1" }, "type": "array" }, "created_at": { "description": "Record creation date", "type": "string" }, "display_name": { "description": "The display name of the user using either the concatenated preferred given and family name or username depending on availability.", "type": "string" }, "emails": { "description": "The user's email addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiEmail5284c8258dc3" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "locale": { "description": "The User's default location for purposes of localization of currency, date time format, or numerical representations pursuant to RFC5646.", "type": "string" }, "name": { "description": "The user's name.", "properties": { "family_name": { "description": "The legal family name of the user, or last name in most Western languages.", "type": "string" }, "formatted": { "description": "The user's full name.", "type": "string" }, "given_name": { "description": "The given legal name of the user, or first name in most Western languages.", "type": "string" }, "middle_name": { "description": "The middle name(s) of the user.", "type": "string" }, "preferred_family_name": { "description": "The preferred family name, or last name in most Western languages, by the user.", "type": "string" }, "preferred_given_name": { "description": "The preferred given name, or first name in most Western languages, by the user.", "type": "string" } }, "title": "UserName", "type": "object" }, "number": { "description": "The permanent profile number of the user.", "type": "string" }, "phone_numbers": { "description": "The user's phone numbers.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoneNumber12060c61ecf5" }, "type": "array" }, "photos": { "description": "The user's photos.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoto2be7c3ae3f39" }, "type": "array" }, "preferred_language": { "description": "The User's preferred written or spoken language in the same format of the HTTP Accept-Language header, pursuant to Section 5.3.5 of RFC7231.", "type": "string" }, "timezone": { "description": "The User's current time zone in IANA database Olson format", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "username": { "description": "The unique identifier across Rippling used by the User for direct authentication into their associated company. Globally unique.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "User", "type": "object" }, "user_id": { "description": "The worker's associated user.", "type": "string" }, "work_email": { "description": "The worker's associated work email address.", "type": "string" }, "work_schedule": { "additionalProperties": { "$ref": "#/components/schemas/OutputRestApiWorkScheduleDay938f88d94f20" }, "description": "The worker's scheduled working hours for each day of the week.", "type": "object" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Worker", "type": "object" }, "default_business_partner_id": { "description": "Id of Optional default business partner worker to whom all employees will be mapped if not explicitly mapped to a business partner in the group.", "type": "string" }, "domain": { "description": "Type of business partner group", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "Name used to identify business partner group", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "BusinessPartnerGroup", "type": "object" }, "business_partner_group_id": { "description": "Identifier of business partner group the business parter is a part of", "type": "string" }, "client_group": { "description": "Group of workers associated with the business partner\n\nExpandable field", "properties": { "allow_non_employees": { "description": "Whether the group allows non employees", "type": "boolean" }, "app_owner_id": { "description": "The id of the group's app owner.", "type": "string" }, "can_override_role_states": { "description": "Whether the group can override role states", "type": "boolean" }, "created_at": { "description": "Record creation date", "type": "string" }, "cumulatively_exhaustive_default": { "description": "Whether the group is the cumulatively exhaustive default", "type": "boolean" }, "description": { "description": "The group's description.", "type": "string" }, "display_name": { "description": "The group's display name.", "type": "string" }, "group_type": { "description": "The group type", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "ignore_prov_group_matching": { "description": "Whether to ignore provisioning group matching when determining group membership", "type": "boolean" }, "include_terminated": { "description": "Whether the group include terminated roles", "type": "boolean" }, "is_invisible": { "description": "Whether the group is invisible", "type": "boolean" }, "mutually_exclusive_key": { "description": "The group's mutually exclusive key", "type": "string" }, "name": { "description": "The group's name.", "type": "string" }, "parent": { "description": "The group's parent.", "type": "string" }, "priority": { "anyOf": [ { "description": "The group's priority when calculating mutual exclusivity", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "read_only": { "description": "Whether the group is read only.", "type": "boolean" }, "sub_group_type": { "description": "The sub group type", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Supergroup", "type": "object" }, "client_group_id": { "description": "Identifier of group of workers associated with the business partner", "type": "string" }, "client_group_member_count": { "anyOf": [ { "description": "Number of workers associated with the business partner", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "worker": { "description": "Worker who is the business partner\n\nExpandable field", "properties": { "business_partners": { "description": "Worker's assigned business partners. This field is only populated when explicitly requested via the expand parameter (e.g., ?expand=business_partners). When expanded, returns an empty list ([]) if the worker has no business partners.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestBusinessPartner" }, "type": "array" }, "business_partners_id": { "description": "Worker's assigned business partners unique identifiers. Returns an empty list ([]) if the worker has no business partners.", "items": { "type": "string" }, "type": "array" }, "citizenship": { "description": "The countries that the worker has citizenship in.", "type": "string" }, "compensation": { "description": "The compensation package for the worker.\n\nExpandable field", "properties": { "annual_compensation": { "description": "The worker's annual compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "annual_salary_equivalent": { "description": "The worker's annual salary equivalent, for insurance purposes. It will be equal to the worker's annual compensation, except for owners that are receiving no cashcompensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "bonus_schedule": { "description": "The worker's bonus schedule.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "hourly_wage": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "id": { "description": "Identifier field", "type": "string" }, "monthly_compensation": { "description": "The worker's monthly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "on_target_commission": { "description": "The worker's on-target commission.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "payment_terms": { "description": "The payment terms for an worker's compensation.", "type": "string" }, "payment_type": { "description": "The payment type for an worker's compensation.", "type": "string" }, "relocation_reimbursement": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "salary_effective_date": { "description": "Salary effective date", "type": "string" }, "signing_bonus": { "description": "The worker's signing bonus.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus": { "description": "The worker's target annual bonus amount.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus_percent": { "anyOf": [ { "description": "The worker's target annual bonus as a percent of annual compensation.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" }, "weekly_compensation": { "description": "The worker's weekly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "worker": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's details.\n\nExpandable field", "type": "object" }, "worker_id": { "description": "The worker's ID.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Compensation", "type": "object" }, "compensation_grade": { "description": "The compensation grade assigned to the worker, if any.", "properties": { "id": { "description": "The compensation grade's unique identifier.", "type": "string" }, "label": { "description": "The compensation grade's label.", "type": "string" } }, "title": "WorkerCompensationGrade", "type": "object" }, "compensation_id": { "description": "The compensation package for the worker.", "type": "string" }, "country": { "description": "The worker's country.", "type": "string" }, "country_fields": { "description": "Country level fields for the worker.", "properties": { "ca": { "description": "Country-wise regional fields for Canada", "properties": { "sin": { "description": "Social Insurance Number (SIN) for Canada employees.", "type": "string" } }, "title": "CanadaFields", "type": "object" }, "nz": { "description": "Country-wise regional fields for New Zealand", "properties": { "ird_number": { "description": "Inland Revenue Department (IRD) number for New Zealand employees.", "type": "string" } }, "title": "NewZealandFields", "type": "object" }, "us": { "description": "Country-wise regional fields for USA", "properties": { "ssn": { "description": "Social Security Number (SSN) for US employees.", "type": "string" } }, "title": "USFields", "type": "object" } }, "title": "CountryFields", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "custom_fields": { "description": "Custom field values defined on the Employee object for this worker\n\nExpandable field", "items": { "additionalProperties": {} }, "type": "array" }, "date_of_birth": { "description": "The worker's date of birth.", "type": "string" }, "department": { "description": "The worker's assigned department.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "department_hierarchy": { "description": "List of departments in the department hierarchy. Refer department_hierarchy_ids for department hierarchy order.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestDepartment" }, "type": "array" }, "department_hierarchy_id": { "description": "The identifier of departments in the department hierarchy ordered from parent department to child department.", "items": { "type": "string" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the department.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestDepartment", "description": "The parent department.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent department.", "type": "string" }, "reference_code": { "description": "Reference code of the department.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Department", "type": "object" }, "department_id": { "description": "The worker's assigned department.", "type": "string" }, "employment_type": { "description": "The worker's employment type.\n\nExpandable field", "properties": { "amount_worked": { "description": "The amount worked for the employment type. * `FULL-TIME`: Full-time is at least 30 hours per week. Full-time workers will typically be eligible for benefits. * `PART-TIME`: Part-time is less than 30 hours per week. These workers may be eligible for benefits, depending on company settings and hours worked. * `TEMPORARY`: These workers are hired on a temporary basis. You can specify how each worker with this employment type will be paid individually.", "type": "string" }, "compensation_time_period": { "description": "The compensation period for the employment type. * `SALARIED`: Employees that are paid a fixed amount per year. * `HOURLY`: Employees that are paid a wage per hour worked.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "label": { "description": "The display label of the employment type.", "type": "string" }, "name": { "description": "The name of the employment type for non-custom employment types.", "type": "string" }, "type": { "description": "The classification of the worker by the company. * `CONTRACTOR`: Contractors are self-employed workers who provide services on a short-term or per-project basis and are not eligible for tax-withholding or benefits. * `EMPLOYEE`: Employees are hired and managed by an employer, work under the employer's direct supervision and control, and are protected by law for wages and employment rights.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "label", "updated_at" ], "title": "CompanyEmploymentType", "type": "object" }, "employment_type_id": { "description": "The worker's employment type.", "type": "string" }, "end_date": { "description": "The end date of the worker.", "type": "string" }, "ethnicity": { "description": "The identified ethnicity of the worker, if specified.", "type": "string" }, "gender": { "description": "The gender of the worker, if specified.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_manager": { "description": "Whether the worker is a manager", "type": "boolean" }, "job_function": { "description": "The worker's job function. When expanded, this field requires `job-functions.read`.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "Displayed name of the job function", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "JobFunction", "type": "object" }, "job_function_id": { "description": "ID of the worker's job function.", "type": "string" }, "legal_entity": { "description": "The worker's associated legal entity.\n\nExpandable field", "properties": { "company": { "description": "The company or organization associated with the legal entity\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "doing_business_as_name": { "description": "The doing business as name for the company.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_entities": { "description": "A list of the company's entities.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestLegalEntity" }, "type": "array" }, "legal_entities_id": { "description": "A list of the company's entities.", "items": { "type": "string" }, "type": "array" }, "legal_name": { "description": "The legal name of the company.", "type": "string" }, "name": { "description": "The name of the company.", "type": "string" }, "parent_legal_entity": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The company's ultimate holding entity.\n\nExpandable field", "type": "object" }, "parent_legal_entity_id": { "description": "The company's ultimate holding entity.", "type": "string" }, "phone": { "description": "The phone number for the company.", "type": "string" }, "physical_address": { "description": "The physical address of the holding entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "primary_email": { "description": "The email address used when registering this company.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "legal_entities", "legal_entities_id", "name", "updated_at" ], "title": "Company", "type": "object" }, "company_id": { "description": "The company or organization associated with the legal entity", "type": "string" }, "country": { "description": "The country the legal entity is based in.", "properties": { "code": { "description": "The code of the country.", "type": "string" } }, "required": [ "code" ], "title": "Country", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "entity_level": { "description": "The legal entity's level in a hierarchy. * `PARENT`: The legal entity is considered the ultimate holding entity. * `SUBSIDIARY`: The legal entity is considered a subsidiary, fully or partially held by another. * `BRANCH`: The legal entity is considered a branch, associated with a parent legal entity.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_name": { "description": "The legal name of the legal entity.", "type": "string" }, "mailing_address": { "description": "The mailing address of the legal entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "management_type": { "description": "The legal entity management type in the case of an employer of record (EOR) or professional employment organization (PEO). * `PEO`: The legal entity is considered a Professional Employment Organization (PEO). * `EOR`: The legal entity is considered an Employer of Record (EOR).", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The parent legal entity.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent legal entity.", "type": "string" }, "physical_address": { "description": "The physical address of the legal entity, if it differs from the mailing address.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "registration_date": { "description": "The registration date of the entity.", "type": "string" }, "tax_identifier": { "description": "The tax identifier for the legal entity.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "LegalEntity", "type": "object" }, "legal_entity_id": { "description": "The worker's associated legal entity.", "type": "string" }, "level": { "description": "The level of the worker.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "description": { "description": "The description of the level.", "type": "string" }, "experience_requirements": { "description": "The experience requirements for the level.", "type": "string" }, "global_level": { "anyOf": [ { "description": "Global level is used to track the seniority of levels. The higher up a level is placed on the page, the more senior and higher-ranked the level. Global level is used in workflows, policies, and reports that use the level attribute (e.g., you can use Level Lookup to set up a workflow that notifies the nearest person in an worker's management chain at or above the specified level).", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the level. Must be unique within the company or organization.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLevel", "description": "The parent level.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent level.", "type": "string" }, "rank": { "anyOf": [ { "description": "The rank of the level within its track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "scope_of_responsibilities": { "description": "The scope of responsibilities for the level.", "type": "string" }, "track": { "description": "The track associated with the level, if it's not a global level.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_default": { "description": "Whether this is the company's default track.", "type": "boolean" }, "name": { "description": "The name of the track. Must be unique within the company or organization.", "type": "string" }, "order": { "anyOf": [ { "description": "The one-based horizontal display order of the track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "start_global_level": { "anyOf": [ { "description": "The highest global level occupied by this track. Empty tracks return null.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Track", "type": "object" }, "track_id": { "description": "The track associated with the level. Required during creation. Include global_level when changing it.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Level", "type": "object" }, "level_id": { "description": "The level of the worker.", "type": "string" }, "location": { "description": "The location that the worker is mapped to for tax purposes. In the case that a worker is remote, the location's type is remote.", "properties": { "type": { "description": "The type of location.", "type": "string" }, "work_location_id": { "description": "The work location, if the worker isn't remote.", "type": "string" } }, "required": [ "type", "work_location_id" ], "title": "WorkerLocation", "type": "object" }, "manager": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's manager.\n\nExpandable field", "type": "object" }, "manager_id": { "description": "The worker's manager.", "type": "string" }, "number": { "anyOf": [ { "description": "The worker's number within the organization.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "original_start_date": { "description": "The worker's earliest start date across their employment history, excluding INIT roles.", "type": "string" }, "overtime_exemption": { "description": "The worker's overtime exemption status.", "type": "string" }, "pay_schedule_id": { "description": "The ID of the pay schedule currently associated with the worker.", "type": "string" }, "personal_email": { "description": "The worker's associated personal email address.", "type": "string" }, "race": { "description": "The identified race of the worker, if specified.", "type": "string" }, "start_date": { "description": "The start date of the worker.", "type": "string" }, "status": { "description": "The worker's status within the organization.", "type": "string" }, "teams": { "description": "The worker's assigned teams.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiTeamcb26bc28f32f" }, "type": "array" }, "teams_id": { "description": "The worker's assigned teams.", "items": { "type": "string" }, "type": "array" }, "termination_details": { "description": "The details of the worker's termination, if applicable.", "properties": { "reason": { "description": "This is a description that will be custom to each Rippling company.", "type": "string" }, "type": { "description": "The termination type indicates whether the termination was voluntary or involuntary.", "type": "string" } }, "title": "TerminationDetails", "type": "object" }, "title": { "description": "The worker's title.", "type": "string" }, "title_effective_date": { "description": "Title effective date", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "user": { "description": "The worker's associated user.\n\nExpandable field", "properties": { "active": { "description": "Whether the user is able to access company resources, typically when they are in actively engaged with the company and not after off-boarding.", "type": "boolean" }, "addresses": { "description": "The user's addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiUserAddressedd59b9ba9a1" }, "type": "array" }, "created_at": { "description": "Record creation date", "type": "string" }, "display_name": { "description": "The display name of the user using either the concatenated preferred given and family name or username depending on availability.", "type": "string" }, "emails": { "description": "The user's email addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiEmail5284c8258dc3" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "locale": { "description": "The User's default location for purposes of localization of currency, date time format, or numerical representations pursuant to RFC5646.", "type": "string" }, "name": { "description": "The user's name.", "properties": { "family_name": { "description": "The legal family name of the user, or last name in most Western languages.", "type": "string" }, "formatted": { "description": "The user's full name.", "type": "string" }, "given_name": { "description": "The given legal name of the user, or first name in most Western languages.", "type": "string" }, "middle_name": { "description": "The middle name(s) of the user.", "type": "string" }, "preferred_family_name": { "description": "The preferred family name, or last name in most Western languages, by the user.", "type": "string" }, "preferred_given_name": { "description": "The preferred given name, or first name in most Western languages, by the user.", "type": "string" } }, "title": "UserName", "type": "object" }, "number": { "description": "The permanent profile number of the user.", "type": "string" }, "phone_numbers": { "description": "The user's phone numbers.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoneNumber12060c61ecf5" }, "type": "array" }, "photos": { "description": "The user's photos.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoto2be7c3ae3f39" }, "type": "array" }, "preferred_language": { "description": "The User's preferred written or spoken language in the same format of the HTTP Accept-Language header, pursuant to Section 5.3.5 of RFC7231.", "type": "string" }, "timezone": { "description": "The User's current time zone in IANA database Olson format", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "username": { "description": "The unique identifier across Rippling used by the User for direct authentication into their associated company. Globally unique.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "User", "type": "object" }, "user_id": { "description": "The worker's associated user.", "type": "string" }, "work_email": { "description": "The worker's associated work email address.", "type": "string" }, "work_schedule": { "additionalProperties": { "$ref": "#/components/schemas/OutputRestApiWorkScheduleDay938f88d94f20" }, "description": "The worker's scheduled working hours for each day of the week.", "type": "object" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Worker", "type": "object" }, "worker_id": { "description": "Identifier of worker who is the business partner", "type": "string" } }, "required": [ "business_partner_group_id", "created_at", "id", "updated_at", "worker_id" ], "title": "BusinessPartner", "type": "object" }, "OutputRestApiBusinessPartnerGroup17ccd8b88b1b": { "description": "", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "default_business_partner": { "description": "Optional default business partner worker to whom all employees will be mapped if not explicitly mapped to a business partner in the group.\n\nExpandable field", "properties": { "business_partners": { "description": "Worker's assigned business partners. This field is only populated when explicitly requested via the expand parameter (e.g., ?expand=business_partners). When expanded, returns an empty list ([]) if the worker has no business partners.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiBusinessPartner01691db528c5" }, "type": "array" }, "business_partners_id": { "description": "Worker's assigned business partners unique identifiers. Returns an empty list ([]) if the worker has no business partners.", "items": { "type": "string" }, "type": "array" }, "citizenship": { "description": "The countries that the worker has citizenship in.", "type": "string" }, "compensation": { "description": "The compensation package for the worker.\n\nExpandable field", "properties": { "annual_compensation": { "description": "The worker's annual compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "annual_salary_equivalent": { "description": "The worker's annual salary equivalent, for insurance purposes. It will be equal to the worker's annual compensation, except for owners that are receiving no cashcompensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "bonus_schedule": { "description": "The worker's bonus schedule.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "hourly_wage": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "id": { "description": "Identifier field", "type": "string" }, "monthly_compensation": { "description": "The worker's monthly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "on_target_commission": { "description": "The worker's on-target commission.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "payment_terms": { "description": "The payment terms for an worker's compensation.", "type": "string" }, "payment_type": { "description": "The payment type for an worker's compensation.", "type": "string" }, "relocation_reimbursement": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "salary_effective_date": { "description": "Salary effective date", "type": "string" }, "signing_bonus": { "description": "The worker's signing bonus.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus": { "description": "The worker's target annual bonus amount.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus_percent": { "anyOf": [ { "description": "The worker's target annual bonus as a percent of annual compensation.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" }, "weekly_compensation": { "description": "The worker's weekly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "worker": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's details.\n\nExpandable field", "type": "object" }, "worker_id": { "description": "The worker's ID.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Compensation", "type": "object" }, "compensation_grade": { "description": "The compensation grade assigned to the worker, if any.", "properties": { "id": { "description": "The compensation grade's unique identifier.", "type": "string" }, "label": { "description": "The compensation grade's label.", "type": "string" } }, "title": "WorkerCompensationGrade", "type": "object" }, "compensation_id": { "description": "The compensation package for the worker.", "type": "string" }, "country": { "description": "The worker's country.", "type": "string" }, "country_fields": { "description": "Country level fields for the worker.", "properties": { "ca": { "description": "Country-wise regional fields for Canada", "properties": { "sin": { "description": "Social Insurance Number (SIN) for Canada employees.", "type": "string" } }, "title": "CanadaFields", "type": "object" }, "nz": { "description": "Country-wise regional fields for New Zealand", "properties": { "ird_number": { "description": "Inland Revenue Department (IRD) number for New Zealand employees.", "type": "string" } }, "title": "NewZealandFields", "type": "object" }, "us": { "description": "Country-wise regional fields for USA", "properties": { "ssn": { "description": "Social Security Number (SSN) for US employees.", "type": "string" } }, "title": "USFields", "type": "object" } }, "title": "CountryFields", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "custom_fields": { "description": "Custom field values defined on the Employee object for this worker\n\nExpandable field", "items": { "additionalProperties": {} }, "type": "array" }, "date_of_birth": { "description": "The worker's date of birth.", "type": "string" }, "department": { "description": "The worker's assigned department.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "department_hierarchy": { "description": "List of departments in the department hierarchy. Refer department_hierarchy_ids for department hierarchy order.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestDepartment" }, "type": "array" }, "department_hierarchy_id": { "description": "The identifier of departments in the department hierarchy ordered from parent department to child department.", "items": { "type": "string" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the department.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestDepartment", "description": "The parent department.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent department.", "type": "string" }, "reference_code": { "description": "Reference code of the department.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Department", "type": "object" }, "department_id": { "description": "The worker's assigned department.", "type": "string" }, "employment_type": { "description": "The worker's employment type.\n\nExpandable field", "properties": { "amount_worked": { "description": "The amount worked for the employment type. * `FULL-TIME`: Full-time is at least 30 hours per week. Full-time workers will typically be eligible for benefits. * `PART-TIME`: Part-time is less than 30 hours per week. These workers may be eligible for benefits, depending on company settings and hours worked. * `TEMPORARY`: These workers are hired on a temporary basis. You can specify how each worker with this employment type will be paid individually.", "type": "string" }, "compensation_time_period": { "description": "The compensation period for the employment type. * `SALARIED`: Employees that are paid a fixed amount per year. * `HOURLY`: Employees that are paid a wage per hour worked.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "label": { "description": "The display label of the employment type.", "type": "string" }, "name": { "description": "The name of the employment type for non-custom employment types.", "type": "string" }, "type": { "description": "The classification of the worker by the company. * `CONTRACTOR`: Contractors are self-employed workers who provide services on a short-term or per-project basis and are not eligible for tax-withholding or benefits. * `EMPLOYEE`: Employees are hired and managed by an employer, work under the employer's direct supervision and control, and are protected by law for wages and employment rights.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "label", "updated_at" ], "title": "CompanyEmploymentType", "type": "object" }, "employment_type_id": { "description": "The worker's employment type.", "type": "string" }, "end_date": { "description": "The end date of the worker.", "type": "string" }, "ethnicity": { "description": "The identified ethnicity of the worker, if specified.", "type": "string" }, "gender": { "description": "The gender of the worker, if specified.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_manager": { "description": "Whether the worker is a manager", "type": "boolean" }, "job_function": { "description": "The worker's job function. When expanded, this field requires `job-functions.read`.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "Displayed name of the job function", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "JobFunction", "type": "object" }, "job_function_id": { "description": "ID of the worker's job function.", "type": "string" }, "legal_entity": { "description": "The worker's associated legal entity.\n\nExpandable field", "properties": { "company": { "description": "The company or organization associated with the legal entity\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "doing_business_as_name": { "description": "The doing business as name for the company.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_entities": { "description": "A list of the company's entities.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestLegalEntity" }, "type": "array" }, "legal_entities_id": { "description": "A list of the company's entities.", "items": { "type": "string" }, "type": "array" }, "legal_name": { "description": "The legal name of the company.", "type": "string" }, "name": { "description": "The name of the company.", "type": "string" }, "parent_legal_entity": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The company's ultimate holding entity.\n\nExpandable field", "type": "object" }, "parent_legal_entity_id": { "description": "The company's ultimate holding entity.", "type": "string" }, "phone": { "description": "The phone number for the company.", "type": "string" }, "physical_address": { "description": "The physical address of the holding entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "primary_email": { "description": "The email address used when registering this company.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "legal_entities", "legal_entities_id", "name", "updated_at" ], "title": "Company", "type": "object" }, "company_id": { "description": "The company or organization associated with the legal entity", "type": "string" }, "country": { "description": "The country the legal entity is based in.", "properties": { "code": { "description": "The code of the country.", "type": "string" } }, "required": [ "code" ], "title": "Country", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "entity_level": { "description": "The legal entity's level in a hierarchy. * `PARENT`: The legal entity is considered the ultimate holding entity. * `SUBSIDIARY`: The legal entity is considered a subsidiary, fully or partially held by another. * `BRANCH`: The legal entity is considered a branch, associated with a parent legal entity.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_name": { "description": "The legal name of the legal entity.", "type": "string" }, "mailing_address": { "description": "The mailing address of the legal entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "management_type": { "description": "The legal entity management type in the case of an employer of record (EOR) or professional employment organization (PEO). * `PEO`: The legal entity is considered a Professional Employment Organization (PEO). * `EOR`: The legal entity is considered an Employer of Record (EOR).", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The parent legal entity.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent legal entity.", "type": "string" }, "physical_address": { "description": "The physical address of the legal entity, if it differs from the mailing address.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "registration_date": { "description": "The registration date of the entity.", "type": "string" }, "tax_identifier": { "description": "The tax identifier for the legal entity.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "LegalEntity", "type": "object" }, "legal_entity_id": { "description": "The worker's associated legal entity.", "type": "string" }, "level": { "description": "The level of the worker.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "description": { "description": "The description of the level.", "type": "string" }, "experience_requirements": { "description": "The experience requirements for the level.", "type": "string" }, "global_level": { "anyOf": [ { "description": "Global level is used to track the seniority of levels. The higher up a level is placed on the page, the more senior and higher-ranked the level. Global level is used in workflows, policies, and reports that use the level attribute (e.g., you can use Level Lookup to set up a workflow that notifies the nearest person in an worker's management chain at or above the specified level).", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the level. Must be unique within the company or organization.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLevel", "description": "The parent level.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent level.", "type": "string" }, "rank": { "anyOf": [ { "description": "The rank of the level within its track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "scope_of_responsibilities": { "description": "The scope of responsibilities for the level.", "type": "string" }, "track": { "description": "The track associated with the level, if it's not a global level.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_default": { "description": "Whether this is the company's default track.", "type": "boolean" }, "name": { "description": "The name of the track. Must be unique within the company or organization.", "type": "string" }, "order": { "anyOf": [ { "description": "The one-based horizontal display order of the track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "start_global_level": { "anyOf": [ { "description": "The highest global level occupied by this track. Empty tracks return null.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Track", "type": "object" }, "track_id": { "description": "The track associated with the level. Required during creation. Include global_level when changing it.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Level", "type": "object" }, "level_id": { "description": "The level of the worker.", "type": "string" }, "location": { "description": "The location that the worker is mapped to for tax purposes. In the case that a worker is remote, the location's type is remote.", "properties": { "type": { "description": "The type of location.", "type": "string" }, "work_location_id": { "description": "The work location, if the worker isn't remote.", "type": "string" } }, "required": [ "type", "work_location_id" ], "title": "WorkerLocation", "type": "object" }, "manager": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's manager.\n\nExpandable field", "type": "object" }, "manager_id": { "description": "The worker's manager.", "type": "string" }, "number": { "anyOf": [ { "description": "The worker's number within the organization.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "original_start_date": { "description": "The worker's earliest start date across their employment history, excluding INIT roles.", "type": "string" }, "overtime_exemption": { "description": "The worker's overtime exemption status.", "type": "string" }, "pay_schedule_id": { "description": "The ID of the pay schedule currently associated with the worker.", "type": "string" }, "personal_email": { "description": "The worker's associated personal email address.", "type": "string" }, "race": { "description": "The identified race of the worker, if specified.", "type": "string" }, "start_date": { "description": "The start date of the worker.", "type": "string" }, "status": { "description": "The worker's status within the organization.", "type": "string" }, "teams": { "description": "The worker's assigned teams.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiTeamcb26bc28f32f" }, "type": "array" }, "teams_id": { "description": "The worker's assigned teams.", "items": { "type": "string" }, "type": "array" }, "termination_details": { "description": "The details of the worker's termination, if applicable.", "properties": { "reason": { "description": "This is a description that will be custom to each Rippling company.", "type": "string" }, "type": { "description": "The termination type indicates whether the termination was voluntary or involuntary.", "type": "string" } }, "title": "TerminationDetails", "type": "object" }, "title": { "description": "The worker's title.", "type": "string" }, "title_effective_date": { "description": "Title effective date", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "user": { "description": "The worker's associated user.\n\nExpandable field", "properties": { "active": { "description": "Whether the user is able to access company resources, typically when they are in actively engaged with the company and not after off-boarding.", "type": "boolean" }, "addresses": { "description": "The user's addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiUserAddressedd59b9ba9a1" }, "type": "array" }, "created_at": { "description": "Record creation date", "type": "string" }, "display_name": { "description": "The display name of the user using either the concatenated preferred given and family name or username depending on availability.", "type": "string" }, "emails": { "description": "The user's email addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiEmail5284c8258dc3" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "locale": { "description": "The User's default location for purposes of localization of currency, date time format, or numerical representations pursuant to RFC5646.", "type": "string" }, "name": { "description": "The user's name.", "properties": { "family_name": { "description": "The legal family name of the user, or last name in most Western languages.", "type": "string" }, "formatted": { "description": "The user's full name.", "type": "string" }, "given_name": { "description": "The given legal name of the user, or first name in most Western languages.", "type": "string" }, "middle_name": { "description": "The middle name(s) of the user.", "type": "string" }, "preferred_family_name": { "description": "The preferred family name, or last name in most Western languages, by the user.", "type": "string" }, "preferred_given_name": { "description": "The preferred given name, or first name in most Western languages, by the user.", "type": "string" } }, "title": "UserName", "type": "object" }, "number": { "description": "The permanent profile number of the user.", "type": "string" }, "phone_numbers": { "description": "The user's phone numbers.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoneNumber12060c61ecf5" }, "type": "array" }, "photos": { "description": "The user's photos.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoto2be7c3ae3f39" }, "type": "array" }, "preferred_language": { "description": "The User's preferred written or spoken language in the same format of the HTTP Accept-Language header, pursuant to Section 5.3.5 of RFC7231.", "type": "string" }, "timezone": { "description": "The User's current time zone in IANA database Olson format", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "username": { "description": "The unique identifier across Rippling used by the User for direct authentication into their associated company. Globally unique.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "User", "type": "object" }, "user_id": { "description": "The worker's associated user.", "type": "string" }, "work_email": { "description": "The worker's associated work email address.", "type": "string" }, "work_schedule": { "additionalProperties": { "$ref": "#/components/schemas/OutputRestApiWorkScheduleDay938f88d94f20" }, "description": "The worker's scheduled working hours for each day of the week.", "type": "object" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Worker", "type": "object" }, "default_business_partner_id": { "description": "Id of Optional default business partner worker to whom all employees will be mapped if not explicitly mapped to a business partner in the group.", "type": "string" }, "domain": { "description": "Type of business partner group", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "Name used to identify business partner group", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "BusinessPartnerGroup", "type": "object" }, "OutputRestApiBusinessStructurePath9cd0fa37b4bd": { "description": "", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "job_codes": { "description": "Ordered list of full JobCode objects for each job in the path, top to bottom. Populate via ?expand=job_codes. Requires both business-structure-paths.read and job-codes.read scopes.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiJobCodeeda25ec6c9a8" }, "type": "array" }, "job_codes_id": { "description": "Ordered list of Job code IDs from top to bottom.", "items": { "type": "string" }, "type": "array" }, "name": { "description": "Name of the path (e.g. 'SF Office > Coffee > Barista').", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestBusinessStructurePath", "description": "The parent path.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "Id of the parent BusinessStructurePath. None for root path.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "BusinessStructurePath", "type": "object" }, "OutputRestApiCandidatee9564ab26ba9": { "description": "", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "email": { "description": "Candidate email", "type": "string" }, "first_name": { "description": "Candidate first name", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "last_name": { "description": "Candidate last name", "type": "string" }, "phone_number": { "description": "Candidate phone number", "type": "string" }, "timezone": { "description": "Candidate timezone", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Candidate", "type": "object" }, "OutputRestApiCardTransactiond05e14d0c745": { "description": "A Spend card transaction or authorization the caller can see.\n\n An authorization is a pending hold the card network places at the time of purchase. A card transaction\n is the posted charge. List returns both; retrieve returns one by ID. A transaction the\n caller cannot see returns 404, the same as one that does not exist.\n ", "properties": { "accounting_date": { "description": "Date the transaction is booked in the accounting system, as an ISO 8601 date (YYYY-MM-DD).", "type": "string" }, "approval_status": { "description": "Approval status of the transaction. `DRAFT`: not submitted for approval. `PENDING`: awaiting required information or submission before approval. `REQUESTED`: submitted and awaiting approval. `APPROVED`: approved. `REJECTED`: rejected. `FINALIZED`: finalized for payment. `ACTIONED`: payment or reimbursement completed. `CANCELLED`: cancelled. `FAILED`: payment failed. Null for card authorizations.", "type": "string" }, "attachments": { "description": "URLs of other attached files.", "items": { "type": "string" }, "type": "array" }, "authorization_state": { "description": "State of the card authorization. `PENDING`: an active hold awaiting completion. `CLOSED`: the authorization completed and the charge posted. `REVERSED`: the authorization was reversed and the hold released. `EXPIRED`: the hold expired without completion. Null for posted card transactions.", "type": "string" }, "card_id": { "description": "ID of the Spend card used. No public API is currently available to retrieve this card.", "type": "string" }, "company_amount": { "description": "Amount in the company's headquarters currency. The `value` is a decimal string.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "entity_id": { "description": "ID of the legal entity the transaction belongs to. Use it with `/company-legal-entities/{id}/`.", "type": "string" }, "gl_sync_state": { "description": "State of the sync to the accounting system. `NOT_FINALIZED`: not ready for accounting review. `FOR_REVIEW`: ready for accounting review. `PENDING_SYNC`: sync is in progress. `SYNCED`: synced to the accounting system. `ERROR`: sync failed. `DO_NOT_SYNC`: marked to be excluded from sync. `EXPORTED`: exported for accounting. `NOT_SYNCABLE`: this record cannot be synced. `AUTO_SYNC`: ready to be synced automatically. Null when no sync state is set.", "type": "string" }, "gl_vendor": { "description": "Vendor in the connected accounting system.", "properties": { "gl_vendor_id": { "description": "ID of the vendor in the accounting system.", "type": "string" }, "id": { "description": "ID of the accounting vendor in Rippling.", "type": "string" }, "name": { "description": "Name of the vendor in the accounting system.", "type": "string" } }, "title": "GLVendor", "type": "object" }, "id": { "description": "Identifier field", "type": "string" }, "line_items": { "description": "Category splits of the transaction amount.", "items": { "$ref": "#/components/schemas/OutputRestApiLineItem8d6adc67985a" }, "type": "array" }, "memo": { "description": "Memo entered on the transaction.", "type": "string" }, "merchant_amount": { "description": "Amount charged by the merchant, in the merchant currency. The `value` is a decimal string.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "receipt": { "description": "URL of the receipt file.", "type": "string" }, "transaction_date": { "description": "When the purchase or authorization happened, as an ISO 8601 date-time in UTC.", "type": "string" }, "transaction_type": { "description": "`CARD_TRANSACTION`: a posted card charge. `CARD_AUTHORIZATION`: a hold placed by the card network before the charge posts.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "vendor": { "description": "Vendor the purchase was made from.", "properties": { "id": { "description": "ID of the vendor.", "type": "string" }, "name": { "description": "Name of the vendor.", "type": "string" } }, "title": "Vendor", "type": "object" }, "worker_id": { "description": "ID of the worker who made the transaction. Use it with `/workers/{id}/`.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "CardTransaction", "type": "object" }, "OutputRestApiCategoryd17181c72f24": { "description": "A Spend category used to classify transaction line items.\n\n Inactive categories are included so historical transactions can still resolve their category.\n ", "properties": { "active": { "description": "Whether the category is active. Inactive categories remain available for historical references.", "type": "boolean" }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "Name of the Spend category.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Category", "type": "object" }, "OutputRestApiCompany17fa1ad76b50": { "description": "", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "doing_business_as_name": { "description": "The doing business as name for the company.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_entities": { "description": "A list of the company's entities.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiLegalEntity9c4b5c98341c" }, "type": "array" }, "legal_entities_id": { "description": "A list of the company's entities.", "items": { "type": "string" }, "type": "array" }, "legal_name": { "description": "The legal name of the company.", "type": "string" }, "name": { "description": "The name of the company.", "type": "string" }, "parent_legal_entity": { "description": "The company's ultimate holding entity.\n\nExpandable field", "properties": { "company": { "$ref": "#/components/schemas/OutputRestCompany", "description": "The company or organization associated with the legal entity\n\nExpandable field", "type": "object" }, "company_id": { "description": "The company or organization associated with the legal entity", "type": "string" }, "country": { "description": "The country the legal entity is based in.", "properties": { "code": { "description": "The code of the country.", "type": "string" } }, "required": [ "code" ], "title": "Country", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "entity_level": { "description": "The legal entity's level in a hierarchy. * `PARENT`: The legal entity is considered the ultimate holding entity. * `SUBSIDIARY`: The legal entity is considered a subsidiary, fully or partially held by another. * `BRANCH`: The legal entity is considered a branch, associated with a parent legal entity.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_name": { "description": "The legal name of the legal entity.", "type": "string" }, "mailing_address": { "description": "The mailing address of the legal entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "management_type": { "description": "The legal entity management type in the case of an employer of record (EOR) or professional employment organization (PEO). * `PEO`: The legal entity is considered a Professional Employment Organization (PEO). * `EOR`: The legal entity is considered an Employer of Record (EOR).", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The parent legal entity.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent legal entity.", "type": "string" }, "physical_address": { "description": "The physical address of the legal entity, if it differs from the mailing address.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "registration_date": { "description": "The registration date of the entity.", "type": "string" }, "tax_identifier": { "description": "The tax identifier for the legal entity.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "LegalEntity", "type": "object" }, "parent_legal_entity_id": { "description": "The company's ultimate holding entity.", "type": "string" }, "phone": { "description": "The phone number for the company.", "type": "string" }, "physical_address": { "description": "The physical address of the holding entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "primary_email": { "description": "The email address used when registering this company.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "legal_entities", "legal_entities_id", "name", "updated_at" ], "title": "Company", "type": "object" }, "OutputRestApiCompanyEmploymentTypede1bd52b2c44": { "description": "", "properties": { "amount_worked": { "description": "The amount worked for the employment type. * `FULL-TIME`: Full-time is at least 30 hours per week. Full-time workers will typically be eligible for benefits. * `PART-TIME`: Part-time is less than 30 hours per week. These workers may be eligible for benefits, depending on company settings and hours worked. * `TEMPORARY`: These workers are hired on a temporary basis. You can specify how each worker with this employment type will be paid individually.", "type": "string" }, "compensation_time_period": { "description": "The compensation period for the employment type. * `SALARIED`: Employees that are paid a fixed amount per year. * `HOURLY`: Employees that are paid a wage per hour worked.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "label": { "description": "The display label of the employment type.", "type": "string" }, "name": { "description": "The name of the employment type for non-custom employment types.", "type": "string" }, "type": { "description": "The classification of the worker by the company. * `CONTRACTOR`: Contractors are self-employed workers who provide services on a short-term or per-project basis and are not eligible for tax-withholding or benefits. * `EMPLOYEE`: Employees are hired and managed by an employer, work under the employer's direct supervision and control, and are protected by law for wages and employment rights.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "label", "updated_at" ], "title": "CompanyEmploymentType", "type": "object" }, "OutputRestApiCompanyLegalEntity6fca92c61d9a": { "description": "", "properties": { "company_id": { "description": "The company associated with this entity relationship.", "type": "string" }, "country_code": { "description": "The ISO country code for the entity.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "entity_level": { "description": "The entity's level in a hierarchy. * `PARENT`: The legal entity is considered the ultimate holding entity. * `SUBSIDIARY`: The legal entity is considered a subsidiary, fully or partially held by another. * `BRANCH`: The legal entity is considered a branch, associated with a parent legal entity.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_archived": { "description": "True if this entity relationship has been archived.", "type": "boolean" }, "is_cor": { "description": "True if this entity is managed as a Contractor of Record.", "type": "boolean" }, "is_eor": { "description": "True if this entity is managed as an Employer of Record.", "type": "boolean" }, "is_peo": { "description": "True if this entity is managed as a Professional Employment Organization.", "type": "boolean" }, "legal_name": { "description": "The legal name of the entity.", "type": "string" }, "mailing_address": { "description": "The mailing address of the entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "management_type": { "description": "The entity management type. * `EOR`: The entity is managed as an Employer of Record. * `COR`: The entity is managed as a Contractor of Record. * `PEO`: The entity is managed as a Professional Employment Organization. * `null`: The entity is a direct hire with no managed employment type.", "type": "string" }, "physical_address": { "description": "The physical address of the entity, if it differs from the mailing address.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "registration_date": { "description": "The registration date of the entity.", "type": "string" }, "tax_identifier": { "description": "The tax identifier for this entity.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "CompanyLegalEntity", "type": "object" }, "OutputRestApiCompanyLegalEntityWorker8af1a3ed7249": { "description": "", "properties": { "company_entity_id": { "description": "The worker's associated company legal entity (CER ID).", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "status": { "description": "The worker's status within the organization.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "CompanyLegalEntityWorker", "type": "object" }, "OutputRestApiCompensation752572462dc4": { "description": "", "properties": { "annual_compensation": { "description": "The worker's annual compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "annual_salary_equivalent": { "description": "The worker's annual salary equivalent, for insurance purposes. It will be equal to the worker's annual compensation, except for owners that are receiving no cashcompensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "bonus_schedule": { "description": "The worker's bonus schedule.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "hourly_wage": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "id": { "description": "Identifier field", "type": "string" }, "monthly_compensation": { "description": "The worker's monthly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "on_target_commission": { "description": "The worker's on-target commission.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "payment_terms": { "description": "The payment terms for an worker's compensation.", "type": "string" }, "payment_type": { "description": "The payment type for an worker's compensation.", "type": "string" }, "relocation_reimbursement": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "salary_effective_date": { "description": "Salary effective date", "type": "string" }, "signing_bonus": { "description": "The worker's signing bonus.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus": { "description": "The worker's target annual bonus amount.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus_percent": { "anyOf": [ { "description": "The worker's target annual bonus as a percent of annual compensation.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" }, "weekly_compensation": { "description": "The worker's weekly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "worker": { "description": "The worker's details.\n\nExpandable field", "properties": { "business_partners": { "description": "Worker's assigned business partners. This field is only populated when explicitly requested via the expand parameter (e.g., ?expand=business_partners). When expanded, returns an empty list ([]) if the worker has no business partners.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiBusinessPartner77b00a069c32" }, "type": "array" }, "business_partners_id": { "description": "Worker's assigned business partners unique identifiers. Returns an empty list ([]) if the worker has no business partners.", "items": { "type": "string" }, "type": "array" }, "citizenship": { "description": "The countries that the worker has citizenship in.", "type": "string" }, "compensation": { "$ref": "#/components/schemas/OutputRestCompensation", "description": "The compensation package for the worker.\n\nExpandable field", "type": "object" }, "compensation_grade": { "description": "The compensation grade assigned to the worker, if any.", "properties": { "id": { "description": "The compensation grade's unique identifier.", "type": "string" }, "label": { "description": "The compensation grade's label.", "type": "string" } }, "title": "WorkerCompensationGrade", "type": "object" }, "compensation_id": { "description": "The compensation package for the worker.", "type": "string" }, "country": { "description": "The worker's country.", "type": "string" }, "country_fields": { "description": "Country level fields for the worker.", "properties": { "ca": { "description": "Country-wise regional fields for Canada", "properties": { "sin": { "description": "Social Insurance Number (SIN) for Canada employees.", "type": "string" } }, "title": "CanadaFields", "type": "object" }, "nz": { "description": "Country-wise regional fields for New Zealand", "properties": { "ird_number": { "description": "Inland Revenue Department (IRD) number for New Zealand employees.", "type": "string" } }, "title": "NewZealandFields", "type": "object" }, "us": { "description": "Country-wise regional fields for USA", "properties": { "ssn": { "description": "Social Security Number (SSN) for US employees.", "type": "string" } }, "title": "USFields", "type": "object" } }, "title": "CountryFields", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "custom_fields": { "description": "Custom field values defined on the Employee object for this worker\n\nExpandable field", "items": { "additionalProperties": {} }, "type": "array" }, "date_of_birth": { "description": "The worker's date of birth.", "type": "string" }, "department": { "description": "The worker's assigned department.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "department_hierarchy": { "description": "List of departments in the department hierarchy. Refer department_hierarchy_ids for department hierarchy order.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestDepartment" }, "type": "array" }, "department_hierarchy_id": { "description": "The identifier of departments in the department hierarchy ordered from parent department to child department.", "items": { "type": "string" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the department.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestDepartment", "description": "The parent department.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent department.", "type": "string" }, "reference_code": { "description": "Reference code of the department.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Department", "type": "object" }, "department_id": { "description": "The worker's assigned department.", "type": "string" }, "employment_type": { "description": "The worker's employment type.\n\nExpandable field", "properties": { "amount_worked": { "description": "The amount worked for the employment type. * `FULL-TIME`: Full-time is at least 30 hours per week. Full-time workers will typically be eligible for benefits. * `PART-TIME`: Part-time is less than 30 hours per week. These workers may be eligible for benefits, depending on company settings and hours worked. * `TEMPORARY`: These workers are hired on a temporary basis. You can specify how each worker with this employment type will be paid individually.", "type": "string" }, "compensation_time_period": { "description": "The compensation period for the employment type. * `SALARIED`: Employees that are paid a fixed amount per year. * `HOURLY`: Employees that are paid a wage per hour worked.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "label": { "description": "The display label of the employment type.", "type": "string" }, "name": { "description": "The name of the employment type for non-custom employment types.", "type": "string" }, "type": { "description": "The classification of the worker by the company. * `CONTRACTOR`: Contractors are self-employed workers who provide services on a short-term or per-project basis and are not eligible for tax-withholding or benefits. * `EMPLOYEE`: Employees are hired and managed by an employer, work under the employer's direct supervision and control, and are protected by law for wages and employment rights.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "label", "updated_at" ], "title": "CompanyEmploymentType", "type": "object" }, "employment_type_id": { "description": "The worker's employment type.", "type": "string" }, "end_date": { "description": "The end date of the worker.", "type": "string" }, "ethnicity": { "description": "The identified ethnicity of the worker, if specified.", "type": "string" }, "gender": { "description": "The gender of the worker, if specified.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_manager": { "description": "Whether the worker is a manager", "type": "boolean" }, "job_function": { "description": "The worker's job function. When expanded, this field requires `job-functions.read`.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "Displayed name of the job function", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "JobFunction", "type": "object" }, "job_function_id": { "description": "ID of the worker's job function.", "type": "string" }, "legal_entity": { "description": "The worker's associated legal entity.\n\nExpandable field", "properties": { "company": { "description": "The company or organization associated with the legal entity\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "doing_business_as_name": { "description": "The doing business as name for the company.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_entities": { "description": "A list of the company's entities.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestLegalEntity" }, "type": "array" }, "legal_entities_id": { "description": "A list of the company's entities.", "items": { "type": "string" }, "type": "array" }, "legal_name": { "description": "The legal name of the company.", "type": "string" }, "name": { "description": "The name of the company.", "type": "string" }, "parent_legal_entity": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The company's ultimate holding entity.\n\nExpandable field", "type": "object" }, "parent_legal_entity_id": { "description": "The company's ultimate holding entity.", "type": "string" }, "phone": { "description": "The phone number for the company.", "type": "string" }, "physical_address": { "description": "The physical address of the holding entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "primary_email": { "description": "The email address used when registering this company.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "legal_entities", "legal_entities_id", "name", "updated_at" ], "title": "Company", "type": "object" }, "company_id": { "description": "The company or organization associated with the legal entity", "type": "string" }, "country": { "description": "The country the legal entity is based in.", "properties": { "code": { "description": "The code of the country.", "type": "string" } }, "required": [ "code" ], "title": "Country", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "entity_level": { "description": "The legal entity's level in a hierarchy. * `PARENT`: The legal entity is considered the ultimate holding entity. * `SUBSIDIARY`: The legal entity is considered a subsidiary, fully or partially held by another. * `BRANCH`: The legal entity is considered a branch, associated with a parent legal entity.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_name": { "description": "The legal name of the legal entity.", "type": "string" }, "mailing_address": { "description": "The mailing address of the legal entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "management_type": { "description": "The legal entity management type in the case of an employer of record (EOR) or professional employment organization (PEO). * `PEO`: The legal entity is considered a Professional Employment Organization (PEO). * `EOR`: The legal entity is considered an Employer of Record (EOR).", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The parent legal entity.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent legal entity.", "type": "string" }, "physical_address": { "description": "The physical address of the legal entity, if it differs from the mailing address.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "registration_date": { "description": "The registration date of the entity.", "type": "string" }, "tax_identifier": { "description": "The tax identifier for the legal entity.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "LegalEntity", "type": "object" }, "legal_entity_id": { "description": "The worker's associated legal entity.", "type": "string" }, "level": { "description": "The level of the worker.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "description": { "description": "The description of the level.", "type": "string" }, "experience_requirements": { "description": "The experience requirements for the level.", "type": "string" }, "global_level": { "anyOf": [ { "description": "Global level is used to track the seniority of levels. The higher up a level is placed on the page, the more senior and higher-ranked the level. Global level is used in workflows, policies, and reports that use the level attribute (e.g., you can use Level Lookup to set up a workflow that notifies the nearest person in an worker's management chain at or above the specified level).", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the level. Must be unique within the company or organization.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLevel", "description": "The parent level.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent level.", "type": "string" }, "rank": { "anyOf": [ { "description": "The rank of the level within its track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "scope_of_responsibilities": { "description": "The scope of responsibilities for the level.", "type": "string" }, "track": { "description": "The track associated with the level, if it's not a global level.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_default": { "description": "Whether this is the company's default track.", "type": "boolean" }, "name": { "description": "The name of the track. Must be unique within the company or organization.", "type": "string" }, "order": { "anyOf": [ { "description": "The one-based horizontal display order of the track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "start_global_level": { "anyOf": [ { "description": "The highest global level occupied by this track. Empty tracks return null.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Track", "type": "object" }, "track_id": { "description": "The track associated with the level. Required during creation. Include global_level when changing it.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Level", "type": "object" }, "level_id": { "description": "The level of the worker.", "type": "string" }, "location": { "description": "The location that the worker is mapped to for tax purposes. In the case that a worker is remote, the location's type is remote.", "properties": { "type": { "description": "The type of location.", "type": "string" }, "work_location_id": { "description": "The work location, if the worker isn't remote.", "type": "string" } }, "required": [ "type", "work_location_id" ], "title": "WorkerLocation", "type": "object" }, "manager": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's manager.\n\nExpandable field", "type": "object" }, "manager_id": { "description": "The worker's manager.", "type": "string" }, "number": { "anyOf": [ { "description": "The worker's number within the organization.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "original_start_date": { "description": "The worker's earliest start date across their employment history, excluding INIT roles.", "type": "string" }, "overtime_exemption": { "description": "The worker's overtime exemption status.", "type": "string" }, "pay_schedule_id": { "description": "The ID of the pay schedule currently associated with the worker.", "type": "string" }, "personal_email": { "description": "The worker's associated personal email address.", "type": "string" }, "race": { "description": "The identified race of the worker, if specified.", "type": "string" }, "start_date": { "description": "The start date of the worker.", "type": "string" }, "status": { "description": "The worker's status within the organization.", "type": "string" }, "teams": { "description": "The worker's assigned teams.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiTeamcb26bc28f32f" }, "type": "array" }, "teams_id": { "description": "The worker's assigned teams.", "items": { "type": "string" }, "type": "array" }, "termination_details": { "description": "The details of the worker's termination, if applicable.", "properties": { "reason": { "description": "This is a description that will be custom to each Rippling company.", "type": "string" }, "type": { "description": "The termination type indicates whether the termination was voluntary or involuntary.", "type": "string" } }, "title": "TerminationDetails", "type": "object" }, "title": { "description": "The worker's title.", "type": "string" }, "title_effective_date": { "description": "Title effective date", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "user": { "description": "The worker's associated user.\n\nExpandable field", "properties": { "active": { "description": "Whether the user is able to access company resources, typically when they are in actively engaged with the company and not after off-boarding.", "type": "boolean" }, "addresses": { "description": "The user's addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiUserAddressedd59b9ba9a1" }, "type": "array" }, "created_at": { "description": "Record creation date", "type": "string" }, "display_name": { "description": "The display name of the user using either the concatenated preferred given and family name or username depending on availability.", "type": "string" }, "emails": { "description": "The user's email addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiEmail5284c8258dc3" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "locale": { "description": "The User's default location for purposes of localization of currency, date time format, or numerical representations pursuant to RFC5646.", "type": "string" }, "name": { "description": "The user's name.", "properties": { "family_name": { "description": "The legal family name of the user, or last name in most Western languages.", "type": "string" }, "formatted": { "description": "The user's full name.", "type": "string" }, "given_name": { "description": "The given legal name of the user, or first name in most Western languages.", "type": "string" }, "middle_name": { "description": "The middle name(s) of the user.", "type": "string" }, "preferred_family_name": { "description": "The preferred family name, or last name in most Western languages, by the user.", "type": "string" }, "preferred_given_name": { "description": "The preferred given name, or first name in most Western languages, by the user.", "type": "string" } }, "title": "UserName", "type": "object" }, "number": { "description": "The permanent profile number of the user.", "type": "string" }, "phone_numbers": { "description": "The user's phone numbers.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoneNumber12060c61ecf5" }, "type": "array" }, "photos": { "description": "The user's photos.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoto2be7c3ae3f39" }, "type": "array" }, "preferred_language": { "description": "The User's preferred written or spoken language in the same format of the HTTP Accept-Language header, pursuant to Section 5.3.5 of RFC7231.", "type": "string" }, "timezone": { "description": "The User's current time zone in IANA database Olson format", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "username": { "description": "The unique identifier across Rippling used by the User for direct authentication into their associated company. Globally unique.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "User", "type": "object" }, "user_id": { "description": "The worker's associated user.", "type": "string" }, "work_email": { "description": "The worker's associated work email address.", "type": "string" }, "work_schedule": { "additionalProperties": { "$ref": "#/components/schemas/OutputRestApiWorkScheduleDay938f88d94f20" }, "description": "The worker's scheduled working hours for each day of the week.", "type": "object" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Worker", "type": "object" }, "worker_id": { "description": "The worker's ID.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Compensation", "type": "object" }, "OutputRestApiCompensationBandsDetails70f178fbc985": { "description": "", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "internal_job_code": { "description": "Internal job code", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "worker": { "description": "The worker associated with compensation bands\n\nExpandable field", "properties": { "business_partners": { "description": "Worker's assigned business partners. This field is only populated when explicitly requested via the expand parameter (e.g., ?expand=business_partners). When expanded, returns an empty list ([]) if the worker has no business partners.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiBusinessPartner77b00a069c32" }, "type": "array" }, "business_partners_id": { "description": "Worker's assigned business partners unique identifiers. Returns an empty list ([]) if the worker has no business partners.", "items": { "type": "string" }, "type": "array" }, "citizenship": { "description": "The countries that the worker has citizenship in.", "type": "string" }, "compensation": { "description": "The compensation package for the worker.\n\nExpandable field", "properties": { "annual_compensation": { "description": "The worker's annual compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "annual_salary_equivalent": { "description": "The worker's annual salary equivalent, for insurance purposes. It will be equal to the worker's annual compensation, except for owners that are receiving no cashcompensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "bonus_schedule": { "description": "The worker's bonus schedule.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "hourly_wage": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "id": { "description": "Identifier field", "type": "string" }, "monthly_compensation": { "description": "The worker's monthly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "on_target_commission": { "description": "The worker's on-target commission.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "payment_terms": { "description": "The payment terms for an worker's compensation.", "type": "string" }, "payment_type": { "description": "The payment type for an worker's compensation.", "type": "string" }, "relocation_reimbursement": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "salary_effective_date": { "description": "Salary effective date", "type": "string" }, "signing_bonus": { "description": "The worker's signing bonus.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus": { "description": "The worker's target annual bonus amount.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus_percent": { "anyOf": [ { "description": "The worker's target annual bonus as a percent of annual compensation.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" }, "weekly_compensation": { "description": "The worker's weekly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "worker": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's details.\n\nExpandable field", "type": "object" }, "worker_id": { "description": "The worker's ID.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Compensation", "type": "object" }, "compensation_grade": { "description": "The compensation grade assigned to the worker, if any.", "properties": { "id": { "description": "The compensation grade's unique identifier.", "type": "string" }, "label": { "description": "The compensation grade's label.", "type": "string" } }, "title": "WorkerCompensationGrade", "type": "object" }, "compensation_id": { "description": "The compensation package for the worker.", "type": "string" }, "country": { "description": "The worker's country.", "type": "string" }, "country_fields": { "description": "Country level fields for the worker.", "properties": { "ca": { "description": "Country-wise regional fields for Canada", "properties": { "sin": { "description": "Social Insurance Number (SIN) for Canada employees.", "type": "string" } }, "title": "CanadaFields", "type": "object" }, "nz": { "description": "Country-wise regional fields for New Zealand", "properties": { "ird_number": { "description": "Inland Revenue Department (IRD) number for New Zealand employees.", "type": "string" } }, "title": "NewZealandFields", "type": "object" }, "us": { "description": "Country-wise regional fields for USA", "properties": { "ssn": { "description": "Social Security Number (SSN) for US employees.", "type": "string" } }, "title": "USFields", "type": "object" } }, "title": "CountryFields", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "custom_fields": { "description": "Custom field values defined on the Employee object for this worker\n\nExpandable field", "items": { "additionalProperties": {} }, "type": "array" }, "date_of_birth": { "description": "The worker's date of birth.", "type": "string" }, "department": { "description": "The worker's assigned department.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "department_hierarchy": { "description": "List of departments in the department hierarchy. Refer department_hierarchy_ids for department hierarchy order.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestDepartment" }, "type": "array" }, "department_hierarchy_id": { "description": "The identifier of departments in the department hierarchy ordered from parent department to child department.", "items": { "type": "string" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the department.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestDepartment", "description": "The parent department.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent department.", "type": "string" }, "reference_code": { "description": "Reference code of the department.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Department", "type": "object" }, "department_id": { "description": "The worker's assigned department.", "type": "string" }, "employment_type": { "description": "The worker's employment type.\n\nExpandable field", "properties": { "amount_worked": { "description": "The amount worked for the employment type. * `FULL-TIME`: Full-time is at least 30 hours per week. Full-time workers will typically be eligible for benefits. * `PART-TIME`: Part-time is less than 30 hours per week. These workers may be eligible for benefits, depending on company settings and hours worked. * `TEMPORARY`: These workers are hired on a temporary basis. You can specify how each worker with this employment type will be paid individually.", "type": "string" }, "compensation_time_period": { "description": "The compensation period for the employment type. * `SALARIED`: Employees that are paid a fixed amount per year. * `HOURLY`: Employees that are paid a wage per hour worked.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "label": { "description": "The display label of the employment type.", "type": "string" }, "name": { "description": "The name of the employment type for non-custom employment types.", "type": "string" }, "type": { "description": "The classification of the worker by the company. * `CONTRACTOR`: Contractors are self-employed workers who provide services on a short-term or per-project basis and are not eligible for tax-withholding or benefits. * `EMPLOYEE`: Employees are hired and managed by an employer, work under the employer's direct supervision and control, and are protected by law for wages and employment rights.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "label", "updated_at" ], "title": "CompanyEmploymentType", "type": "object" }, "employment_type_id": { "description": "The worker's employment type.", "type": "string" }, "end_date": { "description": "The end date of the worker.", "type": "string" }, "ethnicity": { "description": "The identified ethnicity of the worker, if specified.", "type": "string" }, "gender": { "description": "The gender of the worker, if specified.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_manager": { "description": "Whether the worker is a manager", "type": "boolean" }, "job_function": { "description": "The worker's job function. When expanded, this field requires `job-functions.read`.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "Displayed name of the job function", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "JobFunction", "type": "object" }, "job_function_id": { "description": "ID of the worker's job function.", "type": "string" }, "legal_entity": { "description": "The worker's associated legal entity.\n\nExpandable field", "properties": { "company": { "description": "The company or organization associated with the legal entity\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "doing_business_as_name": { "description": "The doing business as name for the company.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_entities": { "description": "A list of the company's entities.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestLegalEntity" }, "type": "array" }, "legal_entities_id": { "description": "A list of the company's entities.", "items": { "type": "string" }, "type": "array" }, "legal_name": { "description": "The legal name of the company.", "type": "string" }, "name": { "description": "The name of the company.", "type": "string" }, "parent_legal_entity": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The company's ultimate holding entity.\n\nExpandable field", "type": "object" }, "parent_legal_entity_id": { "description": "The company's ultimate holding entity.", "type": "string" }, "phone": { "description": "The phone number for the company.", "type": "string" }, "physical_address": { "description": "The physical address of the holding entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "primary_email": { "description": "The email address used when registering this company.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "legal_entities", "legal_entities_id", "name", "updated_at" ], "title": "Company", "type": "object" }, "company_id": { "description": "The company or organization associated with the legal entity", "type": "string" }, "country": { "description": "The country the legal entity is based in.", "properties": { "code": { "description": "The code of the country.", "type": "string" } }, "required": [ "code" ], "title": "Country", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "entity_level": { "description": "The legal entity's level in a hierarchy. * `PARENT`: The legal entity is considered the ultimate holding entity. * `SUBSIDIARY`: The legal entity is considered a subsidiary, fully or partially held by another. * `BRANCH`: The legal entity is considered a branch, associated with a parent legal entity.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_name": { "description": "The legal name of the legal entity.", "type": "string" }, "mailing_address": { "description": "The mailing address of the legal entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "management_type": { "description": "The legal entity management type in the case of an employer of record (EOR) or professional employment organization (PEO). * `PEO`: The legal entity is considered a Professional Employment Organization (PEO). * `EOR`: The legal entity is considered an Employer of Record (EOR).", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The parent legal entity.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent legal entity.", "type": "string" }, "physical_address": { "description": "The physical address of the legal entity, if it differs from the mailing address.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "registration_date": { "description": "The registration date of the entity.", "type": "string" }, "tax_identifier": { "description": "The tax identifier for the legal entity.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "LegalEntity", "type": "object" }, "legal_entity_id": { "description": "The worker's associated legal entity.", "type": "string" }, "level": { "description": "The level of the worker.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "description": { "description": "The description of the level.", "type": "string" }, "experience_requirements": { "description": "The experience requirements for the level.", "type": "string" }, "global_level": { "anyOf": [ { "description": "Global level is used to track the seniority of levels. The higher up a level is placed on the page, the more senior and higher-ranked the level. Global level is used in workflows, policies, and reports that use the level attribute (e.g., you can use Level Lookup to set up a workflow that notifies the nearest person in an worker's management chain at or above the specified level).", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the level. Must be unique within the company or organization.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLevel", "description": "The parent level.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent level.", "type": "string" }, "rank": { "anyOf": [ { "description": "The rank of the level within its track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "scope_of_responsibilities": { "description": "The scope of responsibilities for the level.", "type": "string" }, "track": { "description": "The track associated with the level, if it's not a global level.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_default": { "description": "Whether this is the company's default track.", "type": "boolean" }, "name": { "description": "The name of the track. Must be unique within the company or organization.", "type": "string" }, "order": { "anyOf": [ { "description": "The one-based horizontal display order of the track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "start_global_level": { "anyOf": [ { "description": "The highest global level occupied by this track. Empty tracks return null.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Track", "type": "object" }, "track_id": { "description": "The track associated with the level. Required during creation. Include global_level when changing it.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Level", "type": "object" }, "level_id": { "description": "The level of the worker.", "type": "string" }, "location": { "description": "The location that the worker is mapped to for tax purposes. In the case that a worker is remote, the location's type is remote.", "properties": { "type": { "description": "The type of location.", "type": "string" }, "work_location_id": { "description": "The work location, if the worker isn't remote.", "type": "string" } }, "required": [ "type", "work_location_id" ], "title": "WorkerLocation", "type": "object" }, "manager": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's manager.\n\nExpandable field", "type": "object" }, "manager_id": { "description": "The worker's manager.", "type": "string" }, "number": { "anyOf": [ { "description": "The worker's number within the organization.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "original_start_date": { "description": "The worker's earliest start date across their employment history, excluding INIT roles.", "type": "string" }, "overtime_exemption": { "description": "The worker's overtime exemption status.", "type": "string" }, "pay_schedule_id": { "description": "The ID of the pay schedule currently associated with the worker.", "type": "string" }, "personal_email": { "description": "The worker's associated personal email address.", "type": "string" }, "race": { "description": "The identified race of the worker, if specified.", "type": "string" }, "start_date": { "description": "The start date of the worker.", "type": "string" }, "status": { "description": "The worker's status within the organization.", "type": "string" }, "teams": { "description": "The worker's assigned teams.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiTeamcb26bc28f32f" }, "type": "array" }, "teams_id": { "description": "The worker's assigned teams.", "items": { "type": "string" }, "type": "array" }, "termination_details": { "description": "The details of the worker's termination, if applicable.", "properties": { "reason": { "description": "This is a description that will be custom to each Rippling company.", "type": "string" }, "type": { "description": "The termination type indicates whether the termination was voluntary or involuntary.", "type": "string" } }, "title": "TerminationDetails", "type": "object" }, "title": { "description": "The worker's title.", "type": "string" }, "title_effective_date": { "description": "Title effective date", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "user": { "description": "The worker's associated user.\n\nExpandable field", "properties": { "active": { "description": "Whether the user is able to access company resources, typically when they are in actively engaged with the company and not after off-boarding.", "type": "boolean" }, "addresses": { "description": "The user's addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiUserAddressedd59b9ba9a1" }, "type": "array" }, "created_at": { "description": "Record creation date", "type": "string" }, "display_name": { "description": "The display name of the user using either the concatenated preferred given and family name or username depending on availability.", "type": "string" }, "emails": { "description": "The user's email addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiEmail5284c8258dc3" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "locale": { "description": "The User's default location for purposes of localization of currency, date time format, or numerical representations pursuant to RFC5646.", "type": "string" }, "name": { "description": "The user's name.", "properties": { "family_name": { "description": "The legal family name of the user, or last name in most Western languages.", "type": "string" }, "formatted": { "description": "The user's full name.", "type": "string" }, "given_name": { "description": "The given legal name of the user, or first name in most Western languages.", "type": "string" }, "middle_name": { "description": "The middle name(s) of the user.", "type": "string" }, "preferred_family_name": { "description": "The preferred family name, or last name in most Western languages, by the user.", "type": "string" }, "preferred_given_name": { "description": "The preferred given name, or first name in most Western languages, by the user.", "type": "string" } }, "title": "UserName", "type": "object" }, "number": { "description": "The permanent profile number of the user.", "type": "string" }, "phone_numbers": { "description": "The user's phone numbers.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoneNumber12060c61ecf5" }, "type": "array" }, "photos": { "description": "The user's photos.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoto2be7c3ae3f39" }, "type": "array" }, "preferred_language": { "description": "The User's preferred written or spoken language in the same format of the HTTP Accept-Language header, pursuant to Section 5.3.5 of RFC7231.", "type": "string" }, "timezone": { "description": "The User's current time zone in IANA database Olson format", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "username": { "description": "The unique identifier across Rippling used by the User for direct authentication into their associated company. Globally unique.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "User", "type": "object" }, "user_id": { "description": "The worker's associated user.", "type": "string" }, "work_email": { "description": "The worker's associated work email address.", "type": "string" }, "work_schedule": { "additionalProperties": { "$ref": "#/components/schemas/OutputRestApiWorkScheduleDay938f88d94f20" }, "description": "The worker's scheduled working hours for each day of the week.", "type": "object" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Worker", "type": "object" }, "worker_id": { "description": "ID of the worker associated with compensation bands", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "CompensationBandsDetails", "type": "object" }, "OutputRestApiCoverageSegment54c23d42c145": { "description": "", "properties": { "end_date": { "description": "Segment end date, if known.", "type": "string" }, "program_codes": { "description": "Programs active over this segment.", "items": { "type": "string" }, "type": "array" }, "start_date": { "description": "Segment start date.", "type": "string" } }, "required": [ "program_codes", "start_date" ], "title": "CoverageSegment", "type": "object" }, "OutputRestApiCreateHiresResponse4353de9e8bc9": { "additionalProperties": false, "description": "", "properties": { "results": { "description": "One result per request hire, in request order. HTTP 200 means the envelope was accepted; each item's status is the outcome.", "items": { "$ref": "#/components/schemas/OutputRestApiHireResultf759f93b6e74" }, "type": "array" } }, "required": [ "results" ], "title": "CreateHiresResponse", "type": "object" }, "OutputRestApiCronScheduleTrigger0679b602052c": { "additionalProperties": false, "properties": { "expression": { "type": "string" }, "kind": { "type": "string" }, "timezone": { "type": "string" } }, "required": [ "expression", "kind", "timezone" ], "title": "CronScheduleTrigger", "type": "object" }, "OutputRestApiCustomAppe481dbc8a4b8": { "description": "", "properties": { "api_name": { "description": "The unique api name of the custom app", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "description": { "description": "The description of the custom app", "type": "string" }, "icon": { "description": "The icon URL of the custom app", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The display name of the custom app", "type": "string" }, "pages": { "description": "The pages of the custom app", "items": { "$ref": "#/components/schemas/OutputRestApiPageSummary831a5e01076d" }, "type": "array" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "api_name", "name" ], "title": "CustomApp", "type": "object" }, "OutputRestApiCustomField760477f10998": { "description": "", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "description": { "description": "The description of the custom field.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the custom field.", "type": "string" }, "options": { "description": "The available choice values for SELECT and RADIO custom fields. Null for other field types.", "items": { "type": "string" }, "type": "array" }, "required": { "description": "Whether the custom field is required.", "type": "boolean" }, "type": { "description": "The data type of the custom field.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "type", "updated_at" ], "title": "CustomField", "type": "object" }, "OutputRestApiCustomObjectDataRow46b111ba0ddb": { "additionalProperties": {}, "description": "", "required": [ "created_at", "id", "name", "updated_at" ], "title": "CustomObjectDataRow", "type": "object" }, "OutputRestApiCustomObjectDataRow8539d9fa9ed5": { "additionalProperties": {}, "description": "", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "created_by": { "properties": { "display_value": { "description": "The display name of the role.", "type": "string" }, "id": { "description": "The unique identifier of the role.", "type": "string" }, "image": { "description": "The URL of the role's profile image.", "type": "string" } }, "type": "object" }, "external_id": { "description": "The external id of the custom object datarow", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "last_modified_by": { "properties": { "display_value": { "description": "The display name of the role.", "type": "string" }, "id": { "description": "The unique identifier of the role.", "type": "string" }, "image": { "description": "The URL of the role's profile image.", "type": "string" } }, "type": "object" }, "name": { "description": "The name of the custom object datarow", "type": "string" }, "owner_role": { "properties": { "display_value": { "description": "The display name of the role.", "type": "string" }, "id": { "description": "The unique identifier of the role.", "type": "string" }, "image": { "description": "The URL of the role's profile image.", "type": "string" } }, "type": "object" }, "system_updated_at": { "description": "The timestamp when the record was last updated by the system.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "CustomObjectDataRow", "type": "object" }, "OutputRestApiCustomObjectField5cc7c0ac740a": { "description": "", "properties": { "api_name": { "description": "The api name of the custom object field", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "custom_object": { "description": "The custom object which the field belongs to", "type": "string" }, "data_type": { "additionalProperties": true, "description": "The data type configuration for the field.", "properties": { "num_of_decimal_places": { "anyOf": [ { "description": "Configured fractional scale for NUMBER, PERCENTAGE, and CURRENCY fields. Availability above the legacy per-type limit is capability-gated.", "maximum": 15, "minimum": 0, "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "type": "object" }, "description": { "description": "The description of the custom object field", "type": "string" }, "enable_history": { "description": "whether the history is enable for the field", "type": "boolean" }, "id": { "description": "Identifier field", "type": "string" }, "is_immutable": { "description": "whether the field is imuatable", "type": "boolean" }, "is_standard": { "description": "whether the field is standard field", "type": "boolean" }, "is_unique": { "description": "This field specifies whether a particular column value has unique values", "type": "boolean" }, "managed_package_install_id": { "description": "The id of the package which the custom object field belongs to", "type": "string" }, "name": { "description": "The name of the custom object field", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "api_name", "created_at", "custom_object", "data_type", "enable_history", "id", "is_immutable", "is_standard", "is_unique", "name", "updated_at" ], "title": "CustomObjectField", "type": "object" }, "OutputRestApiCustomObjectListView45dd08dc429b": { "description": "A saved Custom Object grid configuration for selecting, filtering, and ordering records.", "properties": { "columns": { "description": "Visible columns, in saved display order.", "items": { "$ref": "#/components/schemas/OutputRestApiCustomObjectListViewColumnf489c8c5f904" }, "type": "array" }, "created_at": { "description": "Record creation date", "type": "string" }, "description": { "anyOf": [ { "description": "Creator-provided explanation of the records or purpose of this saved view. Null when no explanation was saved.", "type": "string" }, { "type": "null" } ] }, "has_filter": { "description": "Whether this view applies a saved filter in addition to record_scope. The server resolves it when view_id is supplied to record queries; its expression and values are not disclosed.", "type": "boolean" }, "id": { "description": "Identifier field", "type": "string" }, "is_default": { "description": "Whether this is the company's default view for this object.", "type": "boolean" }, "name": { "description": "Display name of the saved view.", "type": "string" }, "order_by": { "anyOf": [ { "description": "Saved field and asc/desc direction; null means no saved ordering.", "type": "string" }, { "type": "null" } ] }, "record_scope": { "description": "MY_RECORDS restricts owners to the authenticated requester when the view is used.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "visibility": { "description": "PRIVATE belongs to its creator; SHARED is visible within the company. Neither grants record access.", "type": "string" } }, "required": [ "columns", "created_at", "has_filter", "id", "is_default", "name", "record_scope", "updated_at", "visibility" ], "title": "CustomObjectListView", "type": "object" }, "OutputRestApiCustomObjectListViewColumnf489c8c5f904": { "description": "A field and its saved display width within a Custom Object list view.", "properties": { "field": { "description": "Field API name.", "type": "string" }, "width": { "anyOf": [ { "anyOf": [ { "description": "Saved column width in pixels, or null to use the grid default.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, { "type": "null" } ] } }, "required": [ "field" ], "title": "CustomObjectListViewColumn", "type": "object" }, "OutputRestApiCustomObjecta49caa0ec2a2": { "description": "", "properties": { "api_name": { "description": "The api name of the custom object", "type": "string" }, "category_id": { "description": "The category of the custom object", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "description": { "description": "The description of the custom object", "type": "string" }, "enable_history": { "description": "Whether to record the history of the custom object", "type": "boolean" }, "id": { "description": "Identifier field", "type": "string" }, "managed_package_install_id": { "description": "The id of the package which the custom object belongs to", "type": "string" }, "name": { "description": "The name of the custom object", "type": "string" }, "native_category_id": { "description": "The native category of the custom object if belongs to", "type": "string" }, "owner_id": { "description": "The id of the owner for the custom object", "type": "string" }, "plural_label": { "description": "The plural label of the custom object", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "category_id", "created_at", "enable_history", "id", "name", "plural_label", "updated_at" ], "title": "CustomObject", "type": "object" }, "OutputRestApiCustomPage205fc2dc58c4": { "description": "", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "created_by": { "description": "The ID of the role that created the page", "type": "string" }, "function_id": { "description": "The ID of the Rippling Function that renders this page", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The display name of the custom page", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "updated_by": { "description": "The ID of the role that last modified the page", "type": "string" } }, "title": "CustomPage", "type": "object" }, "OutputRestApiCustomScheduleTriggerdb31666e4bdd": { "additionalProperties": false, "properties": { "day_of_month": { "anyOf": [ { "anyOf": [ { "maximum": 31, "minimum": 1, "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, { "type": "null" } ] }, "days_of_week": { "anyOf": [ { "items": { "anyOf": [ { "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "type": "array" }, { "type": "null" } ] }, "hour": { "anyOf": [ { "default": 0, "maximum": 23, "minimum": 0, "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "interval": { "anyOf": [ { "minimum": 1, "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "kind": { "type": "string" }, "minute": { "anyOf": [ { "default": 0, "maximum": 59, "minimum": 0, "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "month_of_year": { "anyOf": [ { "anyOf": [ { "maximum": 12, "minimum": 1, "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, { "type": "null" } ] }, "start_month": { "anyOf": [ { "anyOf": [ { "maximum": 12, "minimum": 1, "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, { "type": "null" } ] }, "timezone": { "type": "string" }, "unit": { "type": "string" } }, "required": [ "interval", "kind", "timezone", "unit" ], "title": "CustomScheduleTrigger", "type": "object" }, "OutputRestApiDailyScheduleTriggerf828f14d1d97": { "additionalProperties": false, "properties": { "hour": { "anyOf": [ { "maximum": 23, "minimum": 0, "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "kind": { "type": "string" }, "minute": { "anyOf": [ { "default": 0, "maximum": 59, "minimum": 0, "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "timezone": { "type": "string" } }, "required": [ "hour", "kind", "timezone" ], "title": "DailyScheduleTrigger", "type": "object" }, "OutputRestApiDayOff9e4b21f07f8d": { "description": "", "properties": { "date": { "description": "The date of the day off.", "type": "string" }, "number_of_minutes_taken_off": { "anyOf": [ { "description": "The number of minutes taken off for the day.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "required": [ "date", "number_of_minutes_taken_off" ], "title": "DayOff", "type": "object" }, "OutputRestApiDepartment03eb5a225da5": { "description": "", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "department_hierarchy": { "description": "List of departments in the department hierarchy. Refer department_hierarchy_ids for department hierarchy order.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestDepartment" }, "type": "array" }, "department_hierarchy_id": { "description": "The identifier of departments in the department hierarchy ordered from parent department to child department.", "items": { "type": "string" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the department.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestDepartment", "description": "The parent department.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent department.", "type": "string" }, "reference_code": { "description": "Reference code of the department.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Department", "type": "object" }, "OutputRestApiDetailBooleanField900976202e0f": { "description": "A readable record field and the caller's ability to edit it.", "properties": { "api_name": { "description": "Field key used by layout placements and canonical record PATCH changes. Direct keys come from the Custom Object field definition; dotted related keys are read-only.", "type": "string" }, "data_type": { "description": "BOOLEAN contains true or false.", "type": "string" }, "editable": { "description": "Whether this caller can edit this field on this record.", "type": "boolean" }, "label": { "description": "Field display name.", "type": "string" }, "multiple": { "description": "Whether this field accepts multiple selections. True for SELECT; false for RADIO and scalar references.", "type": "boolean" }, "options": { "description": "Configured choice values; empty for non-choice fields.", "items": { "type": "string" }, "type": "array" }, "read_only_reason": { "anyOf": [ { "description": "PERMISSION_DENIED means record or field update access is absent; RECORD_LOCKED blocks changes; IMMUTABLE identifies an unchangeable field; MANAGED_OR_DERIVED identifies a system-maintained value; UNSUPPORTED_EDITOR means this API has no editor for the type; MASKED withholds a restricted value; REFERENCE_UNAVAILABLE means the reference target is unsupported or unreadable. Null when editable.", "type": "string" }, { "type": "null" } ] }, "reference_object": { "anyOf": [ { "description": "Target collection for a supported reference: workers or a Custom Object API name ending in __c. Null for other fields and unsupported reference targets.", "type": "string" }, { "type": "null" } ] }, "required": { "description": "Whether a nonempty value is required by the field schema.", "type": "boolean" }, "value": { "anyOf": [ { "description": "Whether the configured condition is true; null unless value_state is PRESENT.", "type": "boolean" }, { "type": "null" } ] }, "value_state": { "description": "PRESENT includes a readable value; EMPTY is an unset field; MASKED withholds a restricted value; UNSUPPORTED withholds a value whose type this API cannot represent. Only PRESENT contains a non-null value; an empty multichoice is an empty array.", "type": "string" } }, "required": [ "api_name", "data_type", "editable", "label", "multiple", "options", "required", "value", "value_state" ], "title": "DetailBooleanField", "type": "object" }, "OutputRestApiDetailChoiceField7ad9d5cfc201": { "description": "A readable record field and the caller's ability to edit it.", "properties": { "api_name": { "description": "Field key used by layout placements and canonical record PATCH changes. Direct keys come from the Custom Object field definition; dotted related keys are read-only.", "type": "string" }, "data_type": { "description": "RADIO contains one configured choice.", "type": "string" }, "editable": { "description": "Whether this caller can edit this field on this record.", "type": "boolean" }, "label": { "description": "Field display name.", "type": "string" }, "multiple": { "description": "Whether this field accepts multiple selections. True for SELECT; false for RADIO and scalar references.", "type": "boolean" }, "options": { "description": "Configured choice values; empty for non-choice fields.", "items": { "type": "string" }, "type": "array" }, "read_only_reason": { "anyOf": [ { "description": "PERMISSION_DENIED means record or field update access is absent; RECORD_LOCKED blocks changes; IMMUTABLE identifies an unchangeable field; MANAGED_OR_DERIVED identifies a system-maintained value; UNSUPPORTED_EDITOR means this API has no editor for the type; MASKED withholds a restricted value; REFERENCE_UNAVAILABLE means the reference target is unsupported or unreadable. Null when editable.", "type": "string" }, { "type": "null" } ] }, "reference_object": { "anyOf": [ { "description": "Target collection for a supported reference: workers or a Custom Object API name ending in __c. Null for other fields and unsupported reference targets.", "type": "string" }, { "type": "null" } ] }, "required": { "description": "Whether a nonempty value is required by the field schema.", "type": "boolean" }, "value": { "anyOf": [ { "description": "One value from options; null unless value_state is PRESENT.", "type": "string" }, { "type": "null" } ] }, "value_state": { "description": "PRESENT includes a readable value; EMPTY is an unset field; MASKED withholds a restricted value; UNSUPPORTED withholds a value whose type this API cannot represent. Only PRESENT contains a non-null value; an empty multichoice is an empty array.", "type": "string" } }, "required": [ "api_name", "data_type", "editable", "label", "multiple", "options", "required", "value", "value_state" ], "title": "DetailChoiceField", "type": "object" }, "OutputRestApiDetailCurrencyField4e872a664276": { "description": "A readable record field and the caller's ability to edit it.", "properties": { "api_name": { "description": "Field key used by layout placements and canonical record PATCH changes. Direct keys come from the Custom Object field definition; dotted related keys are read-only.", "type": "string" }, "data_type": { "description": "CURRENCY contains a monetary amount and its currency.", "type": "string" }, "editable": { "description": "Whether this caller can edit this field on this record.", "type": "boolean" }, "label": { "description": "Field display name.", "type": "string" }, "multiple": { "description": "Whether this field accepts multiple selections. True for SELECT; false for RADIO and scalar references.", "type": "boolean" }, "options": { "description": "Configured choice values; empty for non-choice fields.", "items": { "type": "string" }, "type": "array" }, "read_only_reason": { "anyOf": [ { "description": "PERMISSION_DENIED means record or field update access is absent; RECORD_LOCKED blocks changes; IMMUTABLE identifies an unchangeable field; MANAGED_OR_DERIVED identifies a system-maintained value; UNSUPPORTED_EDITOR means this API has no editor for the type; MASKED withholds a restricted value; REFERENCE_UNAVAILABLE means the reference target is unsupported or unreadable. Null when editable.", "type": "string" }, { "type": "null" } ] }, "reference_object": { "anyOf": [ { "description": "Target collection for a supported reference: workers or a Custom Object API name ending in __c. Null for other fields and unsupported reference targets.", "type": "string" }, { "type": "null" } ] }, "required": { "description": "Whether a nonempty value is required by the field schema.", "type": "boolean" }, "value": { "anyOf": [ { "$ref": "#/components/schemas/OutputRestApiRecordDetailCurrencydaf3debf90df" }, { "anyOf": [ { "type": "string" }, { "type": "null" } ] } ], "description": "Platform Currency with an ISO 4217 currency_type and decimal value, for example {currency_type: USD, value: 25.00}. The amount is in currency units, not cents. Null unless value_state is PRESENT." }, "value_state": { "description": "PRESENT includes a readable value; EMPTY is an unset field; MASKED withholds a restricted value; UNSUPPORTED withholds a value whose type this API cannot represent. Only PRESENT contains a non-null value; an empty multichoice is an empty array.", "type": "string" } }, "required": [ "api_name", "data_type", "editable", "label", "multiple", "options", "required", "value", "value_state" ], "title": "DetailCurrencyField", "type": "object" }, "OutputRestApiDetailCustomObjectReference99a81702d45c": { "description": "A canonical Custom Object record relationship, including its dynamic fields.", "properties": { "custom_object_record": { "anyOf": [ { "$ref": "#/components/schemas/OutputRestApiCustomObjectDataRow8539d9fa9ed5" }, { "anyOf": [ { "type": "string" }, { "type": "null" } ] } ], "description": "Exact canonical Custom Object record response, including readable dynamic fields; included with expand=fields.value.custom_object_record. Null when not expanded or unavailable under target permissions." }, "custom_object_record_id": { "description": "Canonical record identifier in reference_object. Retrieve it through GET /custom-objects/{reference_object}/records/{custom_object_record_id}/; PATCH accepts this identifier.", "type": "string" } }, "required": [ "custom_object_record_id" ], "title": "DetailCustomObjectReference", "type": "object" }, "OutputRestApiDetailDateField47aa52ba8268": { "description": "A readable record field and the caller's ability to edit it.", "properties": { "api_name": { "description": "Field key used by layout placements and canonical record PATCH changes. Direct keys come from the Custom Object field definition; dotted related keys are read-only.", "type": "string" }, "data_type": { "description": "DATE contains a calendar date without a time or timezone.", "type": "string" }, "editable": { "description": "Whether this caller can edit this field on this record.", "type": "boolean" }, "label": { "description": "Field display name.", "type": "string" }, "multiple": { "description": "Whether this field accepts multiple selections. True for SELECT; false for RADIO and scalar references.", "type": "boolean" }, "options": { "description": "Configured choice values; empty for non-choice fields.", "items": { "type": "string" }, "type": "array" }, "read_only_reason": { "anyOf": [ { "description": "PERMISSION_DENIED means record or field update access is absent; RECORD_LOCKED blocks changes; IMMUTABLE identifies an unchangeable field; MANAGED_OR_DERIVED identifies a system-maintained value; UNSUPPORTED_EDITOR means this API has no editor for the type; MASKED withholds a restricted value; REFERENCE_UNAVAILABLE means the reference target is unsupported or unreadable. Null when editable.", "type": "string" }, { "type": "null" } ] }, "reference_object": { "anyOf": [ { "description": "Target collection for a supported reference: workers or a Custom Object API name ending in __c. Null for other fields and unsupported reference targets.", "type": "string" }, { "type": "null" } ] }, "required": { "description": "Whether a nonempty value is required by the field schema.", "type": "boolean" }, "value": { "anyOf": [ { "description": "Calendar date in YYYY-MM-DD format, for example 2026-10-24; null unless value_state is PRESENT.", "format": "date", "type": "string" }, { "type": "null" } ] }, "value_state": { "description": "PRESENT includes a readable value; EMPTY is an unset field; MASKED withholds a restricted value; UNSUPPORTED withholds a value whose type this API cannot represent. Only PRESENT contains a non-null value; an empty multichoice is an empty array.", "type": "string" } }, "required": [ "api_name", "data_type", "editable", "label", "multiple", "options", "required", "value", "value_state" ], "title": "DetailDateField", "type": "object" }, "OutputRestApiDetailDateTimeFieldf7deeeec114e": { "description": "A readable record field and the caller's ability to edit it.", "properties": { "api_name": { "description": "Field key used by layout placements and canonical record PATCH changes. Direct keys come from the Custom Object field definition; dotted related keys are read-only.", "type": "string" }, "data_type": { "description": "DATETIME contains an instant and is read-only in this release.", "type": "string" }, "editable": { "description": "Whether this caller can edit this field on this record.", "type": "boolean" }, "label": { "description": "Field display name.", "type": "string" }, "multiple": { "description": "Whether this field accepts multiple selections. True for SELECT; false for RADIO and scalar references.", "type": "boolean" }, "options": { "description": "Configured choice values; empty for non-choice fields.", "items": { "type": "string" }, "type": "array" }, "read_only_reason": { "anyOf": [ { "description": "PERMISSION_DENIED means record or field update access is absent; RECORD_LOCKED blocks changes; IMMUTABLE identifies an unchangeable field; MANAGED_OR_DERIVED identifies a system-maintained value; UNSUPPORTED_EDITOR means this API has no editor for the type; MASKED withholds a restricted value; REFERENCE_UNAVAILABLE means the reference target is unsupported or unreadable. Null when editable.", "type": "string" }, { "type": "null" } ] }, "reference_object": { "anyOf": [ { "description": "Target collection for a supported reference: workers or a Custom Object API name ending in __c. Null for other fields and unsupported reference targets.", "type": "string" }, { "type": "null" } ] }, "required": { "description": "Whether a nonempty value is required by the field schema.", "type": "boolean" }, "value": { "anyOf": [ { "description": "ISO 8601 timestamp with timezone, normalized to UTC; null unless value_state is PRESENT.", "format": "date-time", "type": "string" }, { "type": "null" } ] }, "value_state": { "description": "PRESENT includes a readable value; EMPTY is an unset field; MASKED withholds a restricted value; UNSUPPORTED withholds a value whose type this API cannot represent. Only PRESENT contains a non-null value; an empty multichoice is an empty array.", "type": "string" } }, "required": [ "api_name", "data_type", "editable", "label", "multiple", "options", "required", "value", "value_state" ], "title": "DetailDateTimeField", "type": "object" }, "OutputRestApiDetailHeader3968813c75bb": { "description": "Semantic record header.", "properties": { "description_field": { "anyOf": [ { "description": "Description field API name, or null when unavailable.", "type": "string" }, { "type": "null" } ] }, "fields": { "description": "Ordered summary field API names.", "items": { "type": "string" }, "type": "array" }, "title_field": { "anyOf": [ { "description": "Title field API name, or null when unavailable.", "type": "string" }, { "type": "null" } ] } }, "required": [ "fields" ], "title": "DetailHeader", "type": "object" }, "OutputRestApiDetailLayout926395a1dabf": { "description": "Effective saved page layout.", "properties": { "api_name": { "description": "Resolved saved layout API name.", "type": "string" }, "header": { "$ref": "#/components/schemas/OutputRestApiDetailHeader3968813c75bb" }, "revision": { "description": "Opaque revision of the effective, permission-filtered layout. Compare to detect layout changes; this is not the record write version.", "type": "string" }, "tabs": { "description": "Ordered, visible tabs.", "items": { "$ref": "#/components/schemas/OutputRestApiDetailTab50d1101c38a7" }, "type": "array" } }, "required": [ "api_name", "header", "revision", "tabs" ], "title": "DetailLayout", "type": "object" }, "OutputRestApiDetailMultiChoiceFielde8f2b5b3e40b": { "description": "A readable record field and the caller's ability to edit it.", "properties": { "api_name": { "description": "Field key used by layout placements and canonical record PATCH changes. Direct keys come from the Custom Object field definition; dotted related keys are read-only.", "type": "string" }, "data_type": { "description": "SELECT contains zero or more configured choices.", "type": "string" }, "editable": { "description": "Whether this caller can edit this field on this record.", "type": "boolean" }, "label": { "description": "Field display name.", "type": "string" }, "multiple": { "description": "Whether this field accepts multiple selections. True for SELECT; false for RADIO and scalar references.", "type": "boolean" }, "options": { "description": "Configured choice values; empty for non-choice fields.", "items": { "type": "string" }, "type": "array" }, "read_only_reason": { "anyOf": [ { "description": "PERMISSION_DENIED means record or field update access is absent; RECORD_LOCKED blocks changes; IMMUTABLE identifies an unchangeable field; MANAGED_OR_DERIVED identifies a system-maintained value; UNSUPPORTED_EDITOR means this API has no editor for the type; MASKED withholds a restricted value; REFERENCE_UNAVAILABLE means the reference target is unsupported or unreadable. Null when editable.", "type": "string" }, { "type": "null" } ] }, "reference_object": { "anyOf": [ { "description": "Target collection for a supported reference: workers or a Custom Object API name ending in __c. Null for other fields and unsupported reference targets.", "type": "string" }, { "type": "null" } ] }, "required": { "description": "Whether a nonempty value is required by the field schema.", "type": "boolean" }, "value": { "anyOf": [ { "description": "Selected values from options. An empty selection is []; null unless value_state is PRESENT.", "items": { "type": "string" }, "type": "array" }, { "type": "null" } ] }, "value_state": { "description": "PRESENT includes a readable value; EMPTY is an unset field; MASKED withholds a restricted value; UNSUPPORTED withholds a value whose type this API cannot represent. Only PRESENT contains a non-null value; an empty multichoice is an empty array.", "type": "string" } }, "required": [ "api_name", "data_type", "editable", "label", "multiple", "options", "required", "value", "value_state" ], "title": "DetailMultiChoiceField", "type": "object" }, "OutputRestApiDetailNumberField70754b498c34": { "description": "A readable record field and the caller's ability to edit it.", "properties": { "api_name": { "description": "Field key used by layout placements and canonical record PATCH changes. Direct keys come from the Custom Object field definition; dotted related keys are read-only.", "type": "string" }, "data_type": { "description": "NUMBER contains a decimal quantity.", "type": "string" }, "editable": { "description": "Whether this caller can edit this field on this record.", "type": "boolean" }, "label": { "description": "Field display name.", "type": "string" }, "multiple": { "description": "Whether this field accepts multiple selections. True for SELECT; false for RADIO and scalar references.", "type": "boolean" }, "options": { "description": "Configured choice values; empty for non-choice fields.", "items": { "type": "string" }, "type": "array" }, "read_only_reason": { "anyOf": [ { "description": "PERMISSION_DENIED means record or field update access is absent; RECORD_LOCKED blocks changes; IMMUTABLE identifies an unchangeable field; MANAGED_OR_DERIVED identifies a system-maintained value; UNSUPPORTED_EDITOR means this API has no editor for the type; MASKED withholds a restricted value; REFERENCE_UNAVAILABLE means the reference target is unsupported or unreadable. Null when editable.", "type": "string" }, { "type": "null" } ] }, "reference_object": { "anyOf": [ { "description": "Target collection for a supported reference: workers or a Custom Object API name ending in __c. Null for other fields and unsupported reference targets.", "type": "string" }, { "type": "null" } ] }, "required": { "description": "Whether a nonempty value is required by the field schema.", "type": "boolean" }, "value": { "anyOf": [ { "description": "Decimal quantity encoded as a string to preserve precision, for example 12.50. Units follow the configured field's meaning. Null unless value_state is PRESENT.", "pattern": "^[+-]?(?:\\d+(?:\\.\\d*)?|\\.\\d+)(?:[eE][+-]?\\d+)?$", "type": "string" }, { "type": "null" } ] }, "value_state": { "description": "PRESENT includes a readable value; EMPTY is an unset field; MASKED withholds a restricted value; UNSUPPORTED withholds a value whose type this API cannot represent. Only PRESENT contains a non-null value; an empty multichoice is an empty array.", "type": "string" } }, "required": [ "api_name", "data_type", "editable", "label", "multiple", "options", "required", "value", "value_state" ], "title": "DetailNumberField", "type": "object" }, "OutputRestApiDetailReferenceField13e7da96f7f1": { "description": "A readable record field and the caller's ability to edit it.", "properties": { "api_name": { "description": "Field key used by layout placements and canonical record PATCH changes. Direct keys come from the Custom Object field definition; dotted related keys are read-only.", "type": "string" }, "data_type": { "description": "OG_REFERENCE_FIELD identifies a reference to the collection in reference_object, including standard owner and audit Worker references.", "type": "string" }, "editable": { "description": "Whether this caller can edit this field on this record.", "type": "boolean" }, "label": { "description": "Field display name.", "type": "string" }, "multiple": { "description": "Whether this field accepts multiple selections. True for SELECT; false for RADIO and scalar references.", "type": "boolean" }, "options": { "description": "Configured choice values; empty for non-choice fields.", "items": { "type": "string" }, "type": "array" }, "read_only_reason": { "anyOf": [ { "description": "PERMISSION_DENIED means record or field update access is absent; RECORD_LOCKED blocks changes; IMMUTABLE identifies an unchangeable field; MANAGED_OR_DERIVED identifies a system-maintained value; UNSUPPORTED_EDITOR means this API has no editor for the type; MASKED withholds a restricted value; REFERENCE_UNAVAILABLE means the reference target is unsupported or unreadable. Null when editable.", "type": "string" }, { "type": "null" } ] }, "reference_object": { "anyOf": [ { "description": "Target collection for a supported reference: workers or a Custom Object API name ending in __c. Null for other fields and unsupported reference targets.", "type": "string" }, { "type": "null" } ] }, "required": { "description": "Whether a nonempty value is required by the field schema.", "type": "boolean" }, "value": { "anyOf": [ { "$ref": "#/components/schemas/OutputRestApiDetailWorkerReference6c1295a5d200" }, { "$ref": "#/components/schemas/OutputRestApiDetailCustomObjectReference99a81702d45c" }, { "anyOf": [ { "type": "string" }, { "type": "null" } ] } ], "description": "Canonical relationship pair for reference_object: worker_id and expandable worker, or custom_object_record_id and expandable custom_object_record. Null unless PRESENT; masked references disclose no identifier or resource." }, "value_state": { "description": "PRESENT includes a readable value; EMPTY is an unset field; MASKED withholds a restricted value; UNSUPPORTED withholds a value whose type this API cannot represent. Only PRESENT contains a non-null value; an empty multichoice is an empty array.", "type": "string" } }, "required": [ "api_name", "data_type", "editable", "label", "multiple", "options", "required", "value", "value_state" ], "title": "DetailReferenceField", "type": "object" }, "OutputRestApiDetailSectionba3e6ecd0305": { "description": "Visible group of field placements, a deferred related list, or explicitly unsupported content.", "properties": { "columns": { "anyOf": [ { "description": "Suggested field columns; clients may adapt to available space.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "fields": { "description": "Ordered placements for a FIELDS section. Empty for RELATED_LIST and UNSUPPORTED sections.", "items": { "$ref": "#/components/schemas/OutputRestApiFieldPlacementa67e091362d8" }, "type": "array" }, "id": { "description": "Section identifier scoped to the effective layout. Use a RELATED_LIST section's records_link to retrieve its records.", "type": "string" }, "label": { "description": "Section display name.", "type": "string" }, "object_api_name": { "anyOf": [ { "description": "Related Custom Object API name; null for other sections.", "type": "string" }, { "type": "null" } ] }, "reason": { "anyOf": [ { "description": "CONTENT_NOT_SUPPORTED means this section requires a renderer outside this API; RELATED_OBJECT_NOT_SUPPORTED means the related list targets a native object, which this release cannot render. Null for supported field and Custom Object related-list sections.", "type": "string" }, { "type": "null" } ] }, "records_link": { "anyOf": [ { "description": "Authorized related-record collection URL, including the resolved layout; null for other sections.", "type": "string" }, { "type": "null" } ] }, "type": { "description": "FIELDS contains ordered field placements; RELATED_LIST describes records loaded through records_link; UNSUPPORTED identifies visible content this API cannot render.", "type": "string" } }, "required": [ "columns", "fields", "id", "label", "type" ], "title": "DetailSection", "type": "object" }, "OutputRestApiDetailTab50d1101c38a7": { "description": "Ordered, visible tab of sections in the effective record page layout.", "properties": { "id": { "description": "Stable tab identifier.", "type": "string" }, "label": { "description": "Tab display name.", "type": "string" }, "sections": { "description": "Ordered, visible sections.", "items": { "$ref": "#/components/schemas/OutputRestApiDetailSectionba3e6ecd0305" }, "type": "array" } }, "required": [ "id", "label", "sections" ], "title": "DetailTab", "type": "object" }, "OutputRestApiDetailTextField90ae801b552e": { "description": "A readable record field and the caller's ability to edit it.", "properties": { "api_name": { "description": "Field key used by layout placements and canonical record PATCH changes. Direct keys come from the Custom Object field definition; dotted related keys are read-only.", "type": "string" }, "data_type": { "description": "TEXT and LONG_TEXT contain text; EMAIL, URL, and PHONE_NUMBER contain their respective textual values.", "type": "string" }, "editable": { "description": "Whether this caller can edit this field on this record.", "type": "boolean" }, "label": { "description": "Field display name.", "type": "string" }, "multiple": { "description": "Whether this field accepts multiple selections. True for SELECT; false for RADIO and scalar references.", "type": "boolean" }, "options": { "description": "Configured choice values; empty for non-choice fields.", "items": { "type": "string" }, "type": "array" }, "read_only_reason": { "anyOf": [ { "description": "PERMISSION_DENIED means record or field update access is absent; RECORD_LOCKED blocks changes; IMMUTABLE identifies an unchangeable field; MANAGED_OR_DERIVED identifies a system-maintained value; UNSUPPORTED_EDITOR means this API has no editor for the type; MASKED withholds a restricted value; REFERENCE_UNAVAILABLE means the reference target is unsupported or unreadable. Null when editable.", "type": "string" }, { "type": "null" } ] }, "reference_object": { "anyOf": [ { "description": "Target collection for a supported reference: workers or a Custom Object API name ending in __c. Null for other fields and unsupported reference targets.", "type": "string" }, { "type": "null" } ] }, "required": { "description": "Whether a nonempty value is required by the field schema.", "type": "boolean" }, "value": { "anyOf": [ { "description": "Readable text, or null unless value_state is PRESENT.", "type": "string" }, { "type": "null" } ] }, "value_state": { "description": "PRESENT includes a readable value; EMPTY is an unset field; MASKED withholds a restricted value; UNSUPPORTED withholds a value whose type this API cannot represent. Only PRESENT contains a non-null value; an empty multichoice is an empty array.", "type": "string" } }, "required": [ "api_name", "data_type", "editable", "label", "multiple", "options", "required", "value", "value_state" ], "title": "DetailTextField", "type": "object" }, "OutputRestApiDetailUnsupportedField8bc3be1db840": { "description": "A readable record field and the caller's ability to edit it.", "properties": { "api_name": { "description": "Field key used by layout placements and canonical record PATCH changes. Direct keys come from the Custom Object field definition; dotted related keys are read-only.", "type": "string" }, "data_type": { "description": "These specialized types have no public value representation in this release. UNSUPPORTED also covers unrecognized source types. Values are withheld and editing is unavailable.", "type": "string" }, "editable": { "description": "Whether this caller can edit this field on this record.", "type": "boolean" }, "label": { "description": "Field display name.", "type": "string" }, "multiple": { "description": "Whether this field accepts multiple selections. True for SELECT; false for RADIO and scalar references.", "type": "boolean" }, "options": { "description": "Configured choice values; empty for non-choice fields.", "items": { "type": "string" }, "type": "array" }, "read_only_reason": { "anyOf": [ { "description": "PERMISSION_DENIED means record or field update access is absent; RECORD_LOCKED blocks changes; IMMUTABLE identifies an unchangeable field; MANAGED_OR_DERIVED identifies a system-maintained value; UNSUPPORTED_EDITOR means this API has no editor for the type; MASKED withholds a restricted value; REFERENCE_UNAVAILABLE means the reference target is unsupported or unreadable. Null when editable.", "type": "string" }, { "type": "null" } ] }, "reference_object": { "anyOf": [ { "description": "Target collection for a supported reference: workers or a Custom Object API name ending in __c. Null for other fields and unsupported reference targets.", "type": "string" }, { "type": "null" } ] }, "required": { "description": "Whether a nonempty value is required by the field schema.", "type": "boolean" }, "value": { "anyOf": [ { "description": "Always null because this field type is unsupported.", "type": "string" }, { "type": "null" } ] }, "value_state": { "description": "PRESENT includes a readable value; EMPTY is an unset field; MASKED withholds a restricted value; UNSUPPORTED withholds a value whose type this API cannot represent. Only PRESENT contains a non-null value; an empty multichoice is an empty array.", "type": "string" } }, "required": [ "api_name", "data_type", "editable", "label", "multiple", "options", "required", "value", "value_state" ], "title": "DetailUnsupportedField", "type": "object" }, "OutputRestApiDetailWorkerReference6c1295a5d200": { "description": "A canonical Worker relationship; Worker facts belong to its expansion.", "properties": { "worker": { "anyOf": [ { "$ref": "#/components/schemas/OutputRestApiWorker75ef4092b644" }, { "anyOf": [ { "type": "string" }, { "type": "null" } ] } ], "description": "Exact canonical Worker response, included with expand=fields.value.worker or fields.value.worker.user. Null when not expanded or unavailable under target permissions." }, "worker_id": { "description": "Canonical Worker identifier accepted by the Custom Object record PATCH endpoint. Retrieve it through GET /workers/{worker_id}/.", "type": "string" } }, "required": [ "worker_id" ], "title": "DetailWorkerReference", "type": "object" }, "OutputRestApiDeveloperProgramApplyDTOd3d31f8b663b": { "description": "Developer Program application resource for Path B existing-company apply.", "properties": { "build_description": { "description": "What the company plans to build on Rippling", "type": "string" }, "company_id": { "description": "Rippling company ID on the application", "type": "string" }, "email": { "description": "Applicant email on the application", "type": "string" }, "expires_at": { "description": "Time after which ops can no longer approve this pending application", "type": "string" }, "id": { "description": "Stable application ID", "type": "string" }, "role_id": { "description": "Applicant role ID", "type": "string" }, "signup_id": { "description": "Deprecated alias of id. Prefer id.", "type": "string" }, "stages": { "description": "Application checklist stages", "properties": { "access_ready": { "description": "Whether ops approved the application and provisioning is pending", "type": "boolean" }, "application_submitted": { "description": "Whether the application has been submitted", "type": "boolean" }, "email_confirmed": { "description": "Whether the applicant email is confirmed", "type": "boolean" }, "start_building": { "description": "Whether Developer Program access has been provisioned", "type": "boolean" } }, "title": "DeveloperProgramApplicationStagesDTO", "type": "object" }, "status": { "description": "Application status: EMAIL_VERIFICATION_PENDING, SUBMITTED, APPROVED, VERIFIED, REJECTED, or EXPIRED. Existing-company apply writes SUBMITTED and never EMAIL_VERIFICATION_PENDING. VERIFIED means provision finished, not email verified.", "type": "string" }, "submitted_at": { "description": "Time the application was submitted", "type": "string" } }, "required": [ "id" ], "title": "DeveloperProgramApplyDTO", "type": "object" }, "OutputRestApiDeveloperSandboxEntryRole4ff07d6e5910": { "description": "Company and administrator role used to enter a developer sandbox.", "properties": { "admin_role_id": { "anyOf": [ { "description": "The unique identifier of the sandbox company's administrator role.", "type": "string" }, { "type": "null" } ] }, "target_company_id": { "anyOf": [ { "description": "The unique identifier of the company inside the sandbox.", "type": "string" }, { "type": "null" } ] } }, "required": [ "admin_role_id", "target_company_id" ], "title": "DeveloperSandboxEntryRole", "type": "object" }, "OutputRestApiDeveloperUserDTO2e062bd465c2": { "description": "App Shop Publishers Super Group member.", "properties": { "email": { "description": "The publisher's work or invite email", "type": "string" }, "full_name": { "description": "The publisher's full name", "type": "string" }, "id": { "description": "Role ID of a member of the App Shop Publishers Super Group", "type": "string" }, "is_super_admin": { "description": "Whether this publisher is a Super Admin", "type": "boolean" }, "role_state": { "description": "Role state: INIT, HIRED, ACCEPTED, ACTIVE, or TERMINATED", "type": "string" } }, "title": "DeveloperUserDTO", "type": "object" }, "OutputRestApiDeviceOrder39314fd30d88": { "description": "", "properties": { "cancel_requested": { "description": "True when a cancellation has been requested but not yet completed.", "type": "boolean" }, "completed_at": { "description": "When the order reached a terminal state (COMPLETED, FAILED, or CANCELED).", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "order_type": { "description": "The type of hardware order, as reported by the underlying inventory order (for example: New Device Order, Warehouse Return, Warehouse Order, Add Existing Device, Assign Device, Empty Order, or Sell Device).", "type": "string" }, "requested_by_id": { "description": "The ID of the role that requested the order (often an IT admin). Null if system-created.", "type": "string" }, "status": { "description": "The order lifecycle state (InventoryFlowState): CREATED, RUNNING, COMPLETED, FAILED, CANCELING, CANCELED.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "warehouse_provider": { "description": "The warehouse / vendor provider servicing the order (e.g. CDW, INGRAMMICRO, TD_SYNNEX, GROWRK).", "type": "string" }, "worker": { "description": "The worker the order is for.\n\nExpandable field", "properties": { "business_partners": { "description": "Worker's assigned business partners. This field is only populated when explicitly requested via the expand parameter (e.g., ?expand=business_partners). When expanded, returns an empty list ([]) if the worker has no business partners.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiBusinessPartner77b00a069c32" }, "type": "array" }, "business_partners_id": { "description": "Worker's assigned business partners unique identifiers. Returns an empty list ([]) if the worker has no business partners.", "items": { "type": "string" }, "type": "array" }, "citizenship": { "description": "The countries that the worker has citizenship in.", "type": "string" }, "compensation": { "description": "The compensation package for the worker.\n\nExpandable field", "properties": { "annual_compensation": { "description": "The worker's annual compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "annual_salary_equivalent": { "description": "The worker's annual salary equivalent, for insurance purposes. It will be equal to the worker's annual compensation, except for owners that are receiving no cashcompensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "bonus_schedule": { "description": "The worker's bonus schedule.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "hourly_wage": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "id": { "description": "Identifier field", "type": "string" }, "monthly_compensation": { "description": "The worker's monthly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "on_target_commission": { "description": "The worker's on-target commission.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "payment_terms": { "description": "The payment terms for an worker's compensation.", "type": "string" }, "payment_type": { "description": "The payment type for an worker's compensation.", "type": "string" }, "relocation_reimbursement": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "salary_effective_date": { "description": "Salary effective date", "type": "string" }, "signing_bonus": { "description": "The worker's signing bonus.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus": { "description": "The worker's target annual bonus amount.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus_percent": { "anyOf": [ { "description": "The worker's target annual bonus as a percent of annual compensation.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" }, "weekly_compensation": { "description": "The worker's weekly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "worker": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's details.\n\nExpandable field", "type": "object" }, "worker_id": { "description": "The worker's ID.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Compensation", "type": "object" }, "compensation_grade": { "description": "The compensation grade assigned to the worker, if any.", "properties": { "id": { "description": "The compensation grade's unique identifier.", "type": "string" }, "label": { "description": "The compensation grade's label.", "type": "string" } }, "title": "WorkerCompensationGrade", "type": "object" }, "compensation_id": { "description": "The compensation package for the worker.", "type": "string" }, "country": { "description": "The worker's country.", "type": "string" }, "country_fields": { "description": "Country level fields for the worker.", "properties": { "ca": { "description": "Country-wise regional fields for Canada", "properties": { "sin": { "description": "Social Insurance Number (SIN) for Canada employees.", "type": "string" } }, "title": "CanadaFields", "type": "object" }, "nz": { "description": "Country-wise regional fields for New Zealand", "properties": { "ird_number": { "description": "Inland Revenue Department (IRD) number for New Zealand employees.", "type": "string" } }, "title": "NewZealandFields", "type": "object" }, "us": { "description": "Country-wise regional fields for USA", "properties": { "ssn": { "description": "Social Security Number (SSN) for US employees.", "type": "string" } }, "title": "USFields", "type": "object" } }, "title": "CountryFields", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "custom_fields": { "description": "Custom field values defined on the Employee object for this worker\n\nExpandable field", "items": { "additionalProperties": {} }, "type": "array" }, "date_of_birth": { "description": "The worker's date of birth.", "type": "string" }, "department": { "description": "The worker's assigned department.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "department_hierarchy": { "description": "List of departments in the department hierarchy. Refer department_hierarchy_ids for department hierarchy order.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestDepartment" }, "type": "array" }, "department_hierarchy_id": { "description": "The identifier of departments in the department hierarchy ordered from parent department to child department.", "items": { "type": "string" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the department.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestDepartment", "description": "The parent department.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent department.", "type": "string" }, "reference_code": { "description": "Reference code of the department.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Department", "type": "object" }, "department_id": { "description": "The worker's assigned department.", "type": "string" }, "employment_type": { "description": "The worker's employment type.\n\nExpandable field", "properties": { "amount_worked": { "description": "The amount worked for the employment type. * `FULL-TIME`: Full-time is at least 30 hours per week. Full-time workers will typically be eligible for benefits. * `PART-TIME`: Part-time is less than 30 hours per week. These workers may be eligible for benefits, depending on company settings and hours worked. * `TEMPORARY`: These workers are hired on a temporary basis. You can specify how each worker with this employment type will be paid individually.", "type": "string" }, "compensation_time_period": { "description": "The compensation period for the employment type. * `SALARIED`: Employees that are paid a fixed amount per year. * `HOURLY`: Employees that are paid a wage per hour worked.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "label": { "description": "The display label of the employment type.", "type": "string" }, "name": { "description": "The name of the employment type for non-custom employment types.", "type": "string" }, "type": { "description": "The classification of the worker by the company. * `CONTRACTOR`: Contractors are self-employed workers who provide services on a short-term or per-project basis and are not eligible for tax-withholding or benefits. * `EMPLOYEE`: Employees are hired and managed by an employer, work under the employer's direct supervision and control, and are protected by law for wages and employment rights.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "label", "updated_at" ], "title": "CompanyEmploymentType", "type": "object" }, "employment_type_id": { "description": "The worker's employment type.", "type": "string" }, "end_date": { "description": "The end date of the worker.", "type": "string" }, "ethnicity": { "description": "The identified ethnicity of the worker, if specified.", "type": "string" }, "gender": { "description": "The gender of the worker, if specified.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_manager": { "description": "Whether the worker is a manager", "type": "boolean" }, "job_function": { "description": "The worker's job function. When expanded, this field requires `job-functions.read`.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "Displayed name of the job function", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "JobFunction", "type": "object" }, "job_function_id": { "description": "ID of the worker's job function.", "type": "string" }, "legal_entity": { "description": "The worker's associated legal entity.\n\nExpandable field", "properties": { "company": { "description": "The company or organization associated with the legal entity\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "doing_business_as_name": { "description": "The doing business as name for the company.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_entities": { "description": "A list of the company's entities.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestLegalEntity" }, "type": "array" }, "legal_entities_id": { "description": "A list of the company's entities.", "items": { "type": "string" }, "type": "array" }, "legal_name": { "description": "The legal name of the company.", "type": "string" }, "name": { "description": "The name of the company.", "type": "string" }, "parent_legal_entity": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The company's ultimate holding entity.\n\nExpandable field", "type": "object" }, "parent_legal_entity_id": { "description": "The company's ultimate holding entity.", "type": "string" }, "phone": { "description": "The phone number for the company.", "type": "string" }, "physical_address": { "description": "The physical address of the holding entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "primary_email": { "description": "The email address used when registering this company.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "legal_entities", "legal_entities_id", "name", "updated_at" ], "title": "Company", "type": "object" }, "company_id": { "description": "The company or organization associated with the legal entity", "type": "string" }, "country": { "description": "The country the legal entity is based in.", "properties": { "code": { "description": "The code of the country.", "type": "string" } }, "required": [ "code" ], "title": "Country", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "entity_level": { "description": "The legal entity's level in a hierarchy. * `PARENT`: The legal entity is considered the ultimate holding entity. * `SUBSIDIARY`: The legal entity is considered a subsidiary, fully or partially held by another. * `BRANCH`: The legal entity is considered a branch, associated with a parent legal entity.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_name": { "description": "The legal name of the legal entity.", "type": "string" }, "mailing_address": { "description": "The mailing address of the legal entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "management_type": { "description": "The legal entity management type in the case of an employer of record (EOR) or professional employment organization (PEO). * `PEO`: The legal entity is considered a Professional Employment Organization (PEO). * `EOR`: The legal entity is considered an Employer of Record (EOR).", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The parent legal entity.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent legal entity.", "type": "string" }, "physical_address": { "description": "The physical address of the legal entity, if it differs from the mailing address.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "registration_date": { "description": "The registration date of the entity.", "type": "string" }, "tax_identifier": { "description": "The tax identifier for the legal entity.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "LegalEntity", "type": "object" }, "legal_entity_id": { "description": "The worker's associated legal entity.", "type": "string" }, "level": { "description": "The level of the worker.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "description": { "description": "The description of the level.", "type": "string" }, "experience_requirements": { "description": "The experience requirements for the level.", "type": "string" }, "global_level": { "anyOf": [ { "description": "Global level is used to track the seniority of levels. The higher up a level is placed on the page, the more senior and higher-ranked the level. Global level is used in workflows, policies, and reports that use the level attribute (e.g., you can use Level Lookup to set up a workflow that notifies the nearest person in an worker's management chain at or above the specified level).", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the level. Must be unique within the company or organization.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLevel", "description": "The parent level.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent level.", "type": "string" }, "rank": { "anyOf": [ { "description": "The rank of the level within its track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "scope_of_responsibilities": { "description": "The scope of responsibilities for the level.", "type": "string" }, "track": { "description": "The track associated with the level, if it's not a global level.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_default": { "description": "Whether this is the company's default track.", "type": "boolean" }, "name": { "description": "The name of the track. Must be unique within the company or organization.", "type": "string" }, "order": { "anyOf": [ { "description": "The one-based horizontal display order of the track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "start_global_level": { "anyOf": [ { "description": "The highest global level occupied by this track. Empty tracks return null.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Track", "type": "object" }, "track_id": { "description": "The track associated with the level. Required during creation. Include global_level when changing it.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Level", "type": "object" }, "level_id": { "description": "The level of the worker.", "type": "string" }, "location": { "description": "The location that the worker is mapped to for tax purposes. In the case that a worker is remote, the location's type is remote.", "properties": { "type": { "description": "The type of location.", "type": "string" }, "work_location_id": { "description": "The work location, if the worker isn't remote.", "type": "string" } }, "required": [ "type", "work_location_id" ], "title": "WorkerLocation", "type": "object" }, "manager": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's manager.\n\nExpandable field", "type": "object" }, "manager_id": { "description": "The worker's manager.", "type": "string" }, "number": { "anyOf": [ { "description": "The worker's number within the organization.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "original_start_date": { "description": "The worker's earliest start date across their employment history, excluding INIT roles.", "type": "string" }, "overtime_exemption": { "description": "The worker's overtime exemption status.", "type": "string" }, "pay_schedule_id": { "description": "The ID of the pay schedule currently associated with the worker.", "type": "string" }, "personal_email": { "description": "The worker's associated personal email address.", "type": "string" }, "race": { "description": "The identified race of the worker, if specified.", "type": "string" }, "start_date": { "description": "The start date of the worker.", "type": "string" }, "status": { "description": "The worker's status within the organization.", "type": "string" }, "teams": { "description": "The worker's assigned teams.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiTeamcb26bc28f32f" }, "type": "array" }, "teams_id": { "description": "The worker's assigned teams.", "items": { "type": "string" }, "type": "array" }, "termination_details": { "description": "The details of the worker's termination, if applicable.", "properties": { "reason": { "description": "This is a description that will be custom to each Rippling company.", "type": "string" }, "type": { "description": "The termination type indicates whether the termination was voluntary or involuntary.", "type": "string" } }, "title": "TerminationDetails", "type": "object" }, "title": { "description": "The worker's title.", "type": "string" }, "title_effective_date": { "description": "Title effective date", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "user": { "description": "The worker's associated user.\n\nExpandable field", "properties": { "active": { "description": "Whether the user is able to access company resources, typically when they are in actively engaged with the company and not after off-boarding.", "type": "boolean" }, "addresses": { "description": "The user's addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiUserAddressedd59b9ba9a1" }, "type": "array" }, "created_at": { "description": "Record creation date", "type": "string" }, "display_name": { "description": "The display name of the user using either the concatenated preferred given and family name or username depending on availability.", "type": "string" }, "emails": { "description": "The user's email addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiEmail5284c8258dc3" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "locale": { "description": "The User's default location for purposes of localization of currency, date time format, or numerical representations pursuant to RFC5646.", "type": "string" }, "name": { "description": "The user's name.", "properties": { "family_name": { "description": "The legal family name of the user, or last name in most Western languages.", "type": "string" }, "formatted": { "description": "The user's full name.", "type": "string" }, "given_name": { "description": "The given legal name of the user, or first name in most Western languages.", "type": "string" }, "middle_name": { "description": "The middle name(s) of the user.", "type": "string" }, "preferred_family_name": { "description": "The preferred family name, or last name in most Western languages, by the user.", "type": "string" }, "preferred_given_name": { "description": "The preferred given name, or first name in most Western languages, by the user.", "type": "string" } }, "title": "UserName", "type": "object" }, "number": { "description": "The permanent profile number of the user.", "type": "string" }, "phone_numbers": { "description": "The user's phone numbers.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoneNumber12060c61ecf5" }, "type": "array" }, "photos": { "description": "The user's photos.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoto2be7c3ae3f39" }, "type": "array" }, "preferred_language": { "description": "The User's preferred written or spoken language in the same format of the HTTP Accept-Language header, pursuant to Section 5.3.5 of RFC7231.", "type": "string" }, "timezone": { "description": "The User's current time zone in IANA database Olson format", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "username": { "description": "The unique identifier across Rippling used by the User for direct authentication into their associated company. Globally unique.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "User", "type": "object" }, "user_id": { "description": "The worker's associated user.", "type": "string" }, "work_email": { "description": "The worker's associated work email address.", "type": "string" }, "work_schedule": { "additionalProperties": { "$ref": "#/components/schemas/OutputRestApiWorkScheduleDay938f88d94f20" }, "description": "The worker's scheduled working hours for each day of the week.", "type": "object" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Worker", "type": "object" }, "worker_id": { "description": "The ID of the worker the order is for (the recipient). Null if unassigned.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "DeviceOrder", "type": "object" }, "OutputRestApiDevicePendingActiona50f0a777ce1": { "description": "", "properties": { "action_type": { "description": "The type of the pending device action (e.g. LOCK_DEVICE, RESET_PASSWORD).", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "queued_at": { "description": "When the action was queued.", "type": "string" }, "state": { "description": "The current state of the pending action (e.g. QUEUED, WAITING_FOR_USER_ACTION).", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "DevicePendingAction", "type": "object" }, "OutputRestApiDeviceaf98aca9e7fb": { "description": "", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "enrollment_status": { "description": "The MDM enrollment status: ENROLLED, UNENROLLED, WAITING_FOR_CONNECTION, ERROR, etc.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_encrypted": { "description": "Whether the device's disk is encrypted (FileVault on macOS, BitLocker on Windows).", "type": "boolean" }, "is_managed": { "description": "Whether the device is managed via MDM.", "type": "boolean" }, "last_checkin_at": { "description": "When the Rippling agent last checked in from this device.", "type": "string" }, "last_mdm_sync_at": { "description": "When the device last synced with MDM.", "type": "string" }, "lifecycle_state": { "description": "The device lifecycle state (e.g. ACTIVE, READY, LOCKED, LOST, DECOMMISSIONED).", "type": "string" }, "mdm_provider": { "description": "The MDM provider currently recorded on the device (RIPPLING, JAMFCLOUD, INTUNE, KANDJI, etc.). Null when the device is not currently MDM-managed (typical for unenrolled or recently-reset devices).", "type": "string" }, "model": { "description": "The device hardware model identifier as reported by MDM (e.g. 'MacBookPro18,3', 'iPhone15,2').", "type": "string" }, "os_name": { "description": "The device operating system name.", "type": "string" }, "os_version": { "description": "The device operating system version.", "type": "string" }, "pending_actions": { "description": "Actions currently queued against the device (not yet completed). Expandable.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiDevicePendingActiona50f0a777ce1" }, "type": "array" }, "pending_actions_id": { "description": "The IDs of actions currently queued against the device (not yet completed).", "items": { "type": "string" }, "type": "array" }, "platform": { "description": "The OS platform the device runs: MACOS, WINDOWS, IOS, or IPADOS.", "type": "string" }, "serial_number": { "description": "The device's hardware serial number.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "worker": { "description": "The worker this device is currently assigned to.\n\nExpandable field", "properties": { "business_partners": { "description": "Worker's assigned business partners. This field is only populated when explicitly requested via the expand parameter (e.g., ?expand=business_partners). When expanded, returns an empty list ([]) if the worker has no business partners.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiBusinessPartner77b00a069c32" }, "type": "array" }, "business_partners_id": { "description": "Worker's assigned business partners unique identifiers. Returns an empty list ([]) if the worker has no business partners.", "items": { "type": "string" }, "type": "array" }, "citizenship": { "description": "The countries that the worker has citizenship in.", "type": "string" }, "compensation": { "description": "The compensation package for the worker.\n\nExpandable field", "properties": { "annual_compensation": { "description": "The worker's annual compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "annual_salary_equivalent": { "description": "The worker's annual salary equivalent, for insurance purposes. It will be equal to the worker's annual compensation, except for owners that are receiving no cashcompensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "bonus_schedule": { "description": "The worker's bonus schedule.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "hourly_wage": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "id": { "description": "Identifier field", "type": "string" }, "monthly_compensation": { "description": "The worker's monthly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "on_target_commission": { "description": "The worker's on-target commission.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "payment_terms": { "description": "The payment terms for an worker's compensation.", "type": "string" }, "payment_type": { "description": "The payment type for an worker's compensation.", "type": "string" }, "relocation_reimbursement": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "salary_effective_date": { "description": "Salary effective date", "type": "string" }, "signing_bonus": { "description": "The worker's signing bonus.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus": { "description": "The worker's target annual bonus amount.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus_percent": { "anyOf": [ { "description": "The worker's target annual bonus as a percent of annual compensation.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" }, "weekly_compensation": { "description": "The worker's weekly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "worker": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's details.\n\nExpandable field", "type": "object" }, "worker_id": { "description": "The worker's ID.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Compensation", "type": "object" }, "compensation_grade": { "description": "The compensation grade assigned to the worker, if any.", "properties": { "id": { "description": "The compensation grade's unique identifier.", "type": "string" }, "label": { "description": "The compensation grade's label.", "type": "string" } }, "title": "WorkerCompensationGrade", "type": "object" }, "compensation_id": { "description": "The compensation package for the worker.", "type": "string" }, "country": { "description": "The worker's country.", "type": "string" }, "country_fields": { "description": "Country level fields for the worker.", "properties": { "ca": { "description": "Country-wise regional fields for Canada", "properties": { "sin": { "description": "Social Insurance Number (SIN) for Canada employees.", "type": "string" } }, "title": "CanadaFields", "type": "object" }, "nz": { "description": "Country-wise regional fields for New Zealand", "properties": { "ird_number": { "description": "Inland Revenue Department (IRD) number for New Zealand employees.", "type": "string" } }, "title": "NewZealandFields", "type": "object" }, "us": { "description": "Country-wise regional fields for USA", "properties": { "ssn": { "description": "Social Security Number (SSN) for US employees.", "type": "string" } }, "title": "USFields", "type": "object" } }, "title": "CountryFields", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "custom_fields": { "description": "Custom field values defined on the Employee object for this worker\n\nExpandable field", "items": { "additionalProperties": {} }, "type": "array" }, "date_of_birth": { "description": "The worker's date of birth.", "type": "string" }, "department": { "description": "The worker's assigned department.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "department_hierarchy": { "description": "List of departments in the department hierarchy. Refer department_hierarchy_ids for department hierarchy order.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestDepartment" }, "type": "array" }, "department_hierarchy_id": { "description": "The identifier of departments in the department hierarchy ordered from parent department to child department.", "items": { "type": "string" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the department.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestDepartment", "description": "The parent department.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent department.", "type": "string" }, "reference_code": { "description": "Reference code of the department.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Department", "type": "object" }, "department_id": { "description": "The worker's assigned department.", "type": "string" }, "employment_type": { "description": "The worker's employment type.\n\nExpandable field", "properties": { "amount_worked": { "description": "The amount worked for the employment type. * `FULL-TIME`: Full-time is at least 30 hours per week. Full-time workers will typically be eligible for benefits. * `PART-TIME`: Part-time is less than 30 hours per week. These workers may be eligible for benefits, depending on company settings and hours worked. * `TEMPORARY`: These workers are hired on a temporary basis. You can specify how each worker with this employment type will be paid individually.", "type": "string" }, "compensation_time_period": { "description": "The compensation period for the employment type. * `SALARIED`: Employees that are paid a fixed amount per year. * `HOURLY`: Employees that are paid a wage per hour worked.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "label": { "description": "The display label of the employment type.", "type": "string" }, "name": { "description": "The name of the employment type for non-custom employment types.", "type": "string" }, "type": { "description": "The classification of the worker by the company. * `CONTRACTOR`: Contractors are self-employed workers who provide services on a short-term or per-project basis and are not eligible for tax-withholding or benefits. * `EMPLOYEE`: Employees are hired and managed by an employer, work under the employer's direct supervision and control, and are protected by law for wages and employment rights.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "label", "updated_at" ], "title": "CompanyEmploymentType", "type": "object" }, "employment_type_id": { "description": "The worker's employment type.", "type": "string" }, "end_date": { "description": "The end date of the worker.", "type": "string" }, "ethnicity": { "description": "The identified ethnicity of the worker, if specified.", "type": "string" }, "gender": { "description": "The gender of the worker, if specified.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_manager": { "description": "Whether the worker is a manager", "type": "boolean" }, "job_function": { "description": "The worker's job function. When expanded, this field requires `job-functions.read`.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "Displayed name of the job function", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "JobFunction", "type": "object" }, "job_function_id": { "description": "ID of the worker's job function.", "type": "string" }, "legal_entity": { "description": "The worker's associated legal entity.\n\nExpandable field", "properties": { "company": { "description": "The company or organization associated with the legal entity\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "doing_business_as_name": { "description": "The doing business as name for the company.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_entities": { "description": "A list of the company's entities.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestLegalEntity" }, "type": "array" }, "legal_entities_id": { "description": "A list of the company's entities.", "items": { "type": "string" }, "type": "array" }, "legal_name": { "description": "The legal name of the company.", "type": "string" }, "name": { "description": "The name of the company.", "type": "string" }, "parent_legal_entity": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The company's ultimate holding entity.\n\nExpandable field", "type": "object" }, "parent_legal_entity_id": { "description": "The company's ultimate holding entity.", "type": "string" }, "phone": { "description": "The phone number for the company.", "type": "string" }, "physical_address": { "description": "The physical address of the holding entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "primary_email": { "description": "The email address used when registering this company.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "legal_entities", "legal_entities_id", "name", "updated_at" ], "title": "Company", "type": "object" }, "company_id": { "description": "The company or organization associated with the legal entity", "type": "string" }, "country": { "description": "The country the legal entity is based in.", "properties": { "code": { "description": "The code of the country.", "type": "string" } }, "required": [ "code" ], "title": "Country", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "entity_level": { "description": "The legal entity's level in a hierarchy. * `PARENT`: The legal entity is considered the ultimate holding entity. * `SUBSIDIARY`: The legal entity is considered a subsidiary, fully or partially held by another. * `BRANCH`: The legal entity is considered a branch, associated with a parent legal entity.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_name": { "description": "The legal name of the legal entity.", "type": "string" }, "mailing_address": { "description": "The mailing address of the legal entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "management_type": { "description": "The legal entity management type in the case of an employer of record (EOR) or professional employment organization (PEO). * `PEO`: The legal entity is considered a Professional Employment Organization (PEO). * `EOR`: The legal entity is considered an Employer of Record (EOR).", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The parent legal entity.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent legal entity.", "type": "string" }, "physical_address": { "description": "The physical address of the legal entity, if it differs from the mailing address.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "registration_date": { "description": "The registration date of the entity.", "type": "string" }, "tax_identifier": { "description": "The tax identifier for the legal entity.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "LegalEntity", "type": "object" }, "legal_entity_id": { "description": "The worker's associated legal entity.", "type": "string" }, "level": { "description": "The level of the worker.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "description": { "description": "The description of the level.", "type": "string" }, "experience_requirements": { "description": "The experience requirements for the level.", "type": "string" }, "global_level": { "anyOf": [ { "description": "Global level is used to track the seniority of levels. The higher up a level is placed on the page, the more senior and higher-ranked the level. Global level is used in workflows, policies, and reports that use the level attribute (e.g., you can use Level Lookup to set up a workflow that notifies the nearest person in an worker's management chain at or above the specified level).", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the level. Must be unique within the company or organization.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLevel", "description": "The parent level.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent level.", "type": "string" }, "rank": { "anyOf": [ { "description": "The rank of the level within its track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "scope_of_responsibilities": { "description": "The scope of responsibilities for the level.", "type": "string" }, "track": { "description": "The track associated with the level, if it's not a global level.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_default": { "description": "Whether this is the company's default track.", "type": "boolean" }, "name": { "description": "The name of the track. Must be unique within the company or organization.", "type": "string" }, "order": { "anyOf": [ { "description": "The one-based horizontal display order of the track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "start_global_level": { "anyOf": [ { "description": "The highest global level occupied by this track. Empty tracks return null.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Track", "type": "object" }, "track_id": { "description": "The track associated with the level. Required during creation. Include global_level when changing it.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Level", "type": "object" }, "level_id": { "description": "The level of the worker.", "type": "string" }, "location": { "description": "The location that the worker is mapped to for tax purposes. In the case that a worker is remote, the location's type is remote.", "properties": { "type": { "description": "The type of location.", "type": "string" }, "work_location_id": { "description": "The work location, if the worker isn't remote.", "type": "string" } }, "required": [ "type", "work_location_id" ], "title": "WorkerLocation", "type": "object" }, "manager": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's manager.\n\nExpandable field", "type": "object" }, "manager_id": { "description": "The worker's manager.", "type": "string" }, "number": { "anyOf": [ { "description": "The worker's number within the organization.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "original_start_date": { "description": "The worker's earliest start date across their employment history, excluding INIT roles.", "type": "string" }, "overtime_exemption": { "description": "The worker's overtime exemption status.", "type": "string" }, "pay_schedule_id": { "description": "The ID of the pay schedule currently associated with the worker.", "type": "string" }, "personal_email": { "description": "The worker's associated personal email address.", "type": "string" }, "race": { "description": "The identified race of the worker, if specified.", "type": "string" }, "start_date": { "description": "The start date of the worker.", "type": "string" }, "status": { "description": "The worker's status within the organization.", "type": "string" }, "teams": { "description": "The worker's assigned teams.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiTeamcb26bc28f32f" }, "type": "array" }, "teams_id": { "description": "The worker's assigned teams.", "items": { "type": "string" }, "type": "array" }, "termination_details": { "description": "The details of the worker's termination, if applicable.", "properties": { "reason": { "description": "This is a description that will be custom to each Rippling company.", "type": "string" }, "type": { "description": "The termination type indicates whether the termination was voluntary or involuntary.", "type": "string" } }, "title": "TerminationDetails", "type": "object" }, "title": { "description": "The worker's title.", "type": "string" }, "title_effective_date": { "description": "Title effective date", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "user": { "description": "The worker's associated user.\n\nExpandable field", "properties": { "active": { "description": "Whether the user is able to access company resources, typically when they are in actively engaged with the company and not after off-boarding.", "type": "boolean" }, "addresses": { "description": "The user's addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiUserAddressedd59b9ba9a1" }, "type": "array" }, "created_at": { "description": "Record creation date", "type": "string" }, "display_name": { "description": "The display name of the user using either the concatenated preferred given and family name or username depending on availability.", "type": "string" }, "emails": { "description": "The user's email addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiEmail5284c8258dc3" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "locale": { "description": "The User's default location for purposes of localization of currency, date time format, or numerical representations pursuant to RFC5646.", "type": "string" }, "name": { "description": "The user's name.", "properties": { "family_name": { "description": "The legal family name of the user, or last name in most Western languages.", "type": "string" }, "formatted": { "description": "The user's full name.", "type": "string" }, "given_name": { "description": "The given legal name of the user, or first name in most Western languages.", "type": "string" }, "middle_name": { "description": "The middle name(s) of the user.", "type": "string" }, "preferred_family_name": { "description": "The preferred family name, or last name in most Western languages, by the user.", "type": "string" }, "preferred_given_name": { "description": "The preferred given name, or first name in most Western languages, by the user.", "type": "string" } }, "title": "UserName", "type": "object" }, "number": { "description": "The permanent profile number of the user.", "type": "string" }, "phone_numbers": { "description": "The user's phone numbers.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoneNumber12060c61ecf5" }, "type": "array" }, "photos": { "description": "The user's photos.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoto2be7c3ae3f39" }, "type": "array" }, "preferred_language": { "description": "The User's preferred written or spoken language in the same format of the HTTP Accept-Language header, pursuant to Section 5.3.5 of RFC7231.", "type": "string" }, "timezone": { "description": "The User's current time zone in IANA database Olson format", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "username": { "description": "The unique identifier across Rippling used by the User for direct authentication into their associated company. Globally unique.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "User", "type": "object" }, "user_id": { "description": "The worker's associated user.", "type": "string" }, "work_email": { "description": "The worker's associated work email address.", "type": "string" }, "work_schedule": { "additionalProperties": { "$ref": "#/components/schemas/OutputRestApiWorkScheduleDay938f88d94f20" }, "description": "The worker's scheduled working hours for each day of the week.", "type": "object" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Worker", "type": "object" }, "worker_id": { "description": "The ID of the worker this device is currently assigned to. Null if unassigned.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Device", "type": "object" }, "OutputRestApiDimensionChoice299d74541a33": { "description": "", "properties": { "dimension_name": { "description": "Name of the dimension, such as Department.", "type": "string" }, "label": { "description": "Display name of the selected dimension value.", "type": "string" }, "value": { "description": "ID of the selected dimension value.", "type": "string" } }, "title": "DimensionChoice", "type": "object" }, "OutputRestApiDraftHireDocument8f403bf65740": { "description": "A document to attach to a draft hire, referencing a pre-uploaded file.", "properties": { "file_id": { "description": "Id of a FileUploadTracker in ACTIVE status whose file should become a document on the hire", "type": "string" }, "name": { "description": "Document name. Defaults to the uploaded file name when omitted.", "type": "string" }, "signature_date": { "description": "Signature date in YYYY-MM-DD format.", "type": "string" } }, "required": [ "file_id" ], "title": "DraftHireDocument", "type": "object" }, "OutputRestApiDraftHireResult3d455f047883": { "description": "Result for an individual draft hire creation.", "properties": { "draft_hire_role_id": { "description": "Generated draft hire ID if successful", "type": "string" }, "errors": { "description": "List of validation errors if any", "items": { "type": "string" }, "type": "array" }, "message": { "description": "Success or error message", "type": "string" }, "status": { "description": "Status of the creation (success, error, warning)", "type": "string" } }, "required": [ "status" ], "title": "DraftHireResult", "type": "object" }, "OutputRestApiDraftTransitionItemRequestcef9f09f47d2": { "description": "", "properties": { "changes": { "description": "Requested role/profile changes for this item.", "properties": { "country_specific_info": { "description": "Country-specific field changes supported by current draft transition flows.", "type": "object" }, "employment_info": { "description": "Employment information changes for the target role.", "properties": { "annual_salary_equivalent": { "anyOf": [ { "description": "New annual salary equivalent.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "currency": { "description": "New compensation currency.", "type": "string" }, "department_id": { "description": "New department identifier for the target role.", "type": "string" }, "employment_type_id": { "description": "New company employment type identifier for the target role.", "type": "string" }, "equity_num_shares": { "anyOf": [ { "description": "New offer letter equity share count.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "equity_value": { "anyOf": [ { "description": "New offer letter equity value.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "equity_vesting_package_id": { "description": "New equity vesting package identifier.", "type": "string" }, "job_family_id": { "description": "New job family identifier for the target role.", "type": "string" }, "level_id": { "description": "New level identifier for the target role.", "type": "string" }, "manager_id": { "description": "New manager role identifier for the target role.", "type": "string" }, "on_target_commission": { "anyOf": [ { "description": "New annual on-target commission amount.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "relocation_reimbursement": { "anyOf": [ { "description": "New relocation reimbursement amount.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "salary_per_unit": { "anyOf": [ { "description": "New compensation amount per salary unit.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "salary_unit": { "description": "New salary unit.", "type": "string" }, "start_date": { "description": "New start date for the target role.", "type": "string" }, "target_annual_bonus": { "anyOf": [ { "description": "New target annual bonus amount.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "target_annual_bonus_payment_frequency_unit": { "description": "New target annual bonus payment frequency.", "type": "string" }, "target_annual_bonus_percent": { "anyOf": [ { "description": "New target annual bonus percentage.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "teams_ids": { "description": "New team identifiers for the target role.", "items": { "type": "string" }, "type": "array" }, "title": { "description": "New job title for the target role.", "type": "string" } }, "title": "DraftTransitionEmploymentInfoChangesRequest", "type": "object" }, "work_location_info": { "description": "Work location changes for the target role.", "properties": { "country_code": { "description": "New work country code for the target role.", "type": "string" }, "location_id": { "description": "New work location identifier for the target role.", "type": "string" } }, "title": "DraftTransitionWorkLocationInfoChangesRequest", "type": "object" } }, "title": "DraftTransitionChangesRequest", "type": "object" }, "draft_grouping_preference": { "description": "Controls whether this item should append to a compatible existing draft or create a new draft.", "type": "string" }, "role_id": { "description": "Target role identifier for this draft transition item.", "type": "string" } }, "required": [ "changes", "role_id" ], "title": "DraftTransitionItemRequest", "type": "object" }, "OutputRestApiEarningInput0e55076c2e04": { "description": "", "properties": { "amount": { "description": "Earning amount serialized as a decimal string.", "type": "string" }, "currency": { "description": "ISO 4217 currency code for the earning amount.", "type": "string" }, "earning_type": { "description": "Earning type to use if booking a payroll earning from the evaluation.", "type": "string" }, "weeks": { "description": "Number of benefit weeks represented by this earning, serialized as a decimal string.", "type": "string" } }, "required": [ "amount", "earning_type" ], "title": "EarningInput", "type": "object" }, "OutputRestApiEarningType291222bccebf": { "description": "An earning category available in Global Payroll, such as salary, commission, or bonus.", "properties": { "country_code": { "description": "Uppercase ISO 3166-1 alpha-2 country code of the payroll catalog, such as `CA` or `US`.", "type": "string" }, "display_name": { "description": "Configured display name of the earning type. Entries with different configurations can have the same name and `earning_code`.", "type": "string" }, "earning_code": { "description": "Code used to select this earning type in `POST /earnings-inputs/`, such as `regular_salary` or `commission`. Availability is validated against the worker's payroll catalog.", "type": "string" }, "id": { "description": "Identifier of a source earning type. With `company_entity_id`, equivalent entries use one existing ID, which can change when its source entry is removed. Use `earning_code` when submitting payroll earnings inputs.", "type": "string" } }, "title": "EarningType", "type": "object" }, "OutputRestApiEarningsInput79a2565291ab": { "description": "\n V2 DTO representing an external earnings input record.\n\n Used by:\n - GET /earnings-inputs/ (list)\n ", "properties": { "amount": { "description": "Earning amount as a string-encoded decimal.", "type": "string" }, "assignment_type": { "description": "How the earning is assigned (e.g. BY_PAY_PERIOD).", "type": "string" }, "company_entity_id": { "description": "Identifier for the legal entity (company entity relationship) this earning is associated with. Use this to correlate earnings with a specific legal entity in a multi-entity company.", "type": "string" }, "earning_code": { "description": "Code identifying the earning type (e.g. regular_salary).", "type": "string" }, "earning_end_date": { "description": "End of the period this earning was earned. Used for regular-rate-of-pay (RROP) attribution. Distinct from pay_period_basis_date, which selects the pay run.", "type": "string" }, "earning_start_date": { "description": "Start of the period this earning was earned. Used for regular-rate-of-pay (RROP) attribution. Distinct from pay_period_basis_date, which selects the pay run.", "type": "string" }, "external_id": { "description": "External reference identifier for this earning.", "type": "string" }, "hours": { "description": "Hours associated with this earning as a string-encoded decimal.", "type": "string" }, "id": { "description": "Unique identifier for the earnings input.", "type": "string" }, "is_overridden": { "description": "Whether this earning's amount was manually overridden instead of using the calculated value. Always false for newly created earnings.", "type": "boolean" }, "pay_period_basis_date": { "description": "The pay period basis date for this earning.", "type": "string" }, "run_id": { "description": "Identifier of the payroll run this earning is assigned to, if any.", "type": "string" }, "status": { "description": "Current status of the earnings input (e.g. UNASSIGNED, ASSIGNED).", "type": "string" }, "time_labels": { "description": "Time tracking labels associated with this earning.", "items": { "type": "string" }, "type": "array" }, "worker_id": { "description": "Identifier of the worker (role ID).", "type": "string" } }, "title": "EarningsInput", "type": "object" }, "OutputRestApiEditableWorkflowDefinitiond9f9354f328c": { "additionalProperties": false, "properties": { "actions": { "items": { "anyOf": [ { "$ref": "#/components/schemas/OutputRestApiRegisteredCallbackActionf36112ca9efd" } ] }, "maxItems": 160, "minItems": 1, "type": "array" }, "kind": { "type": "string" }, "trigger": { "anyOf": [ { "$ref": "#/components/schemas/OutputRestApiDailyScheduleTriggerf828f14d1d97" }, { "$ref": "#/components/schemas/OutputRestApiBusinessEventTrigger16af6dea9307" }, { "$ref": "#/components/schemas/OutputRestApiWeekdayScheduleTriggera236cc90a54c" }, { "$ref": "#/components/schemas/OutputRestApiWeeklyScheduleTrigger9d2e794637bc" }, { "$ref": "#/components/schemas/OutputRestApiBiweeklyScheduleTriggerc261b277efb4" }, { "$ref": "#/components/schemas/OutputRestApiMonthlyScheduleTrigger105d31bb71a4" }, { "$ref": "#/components/schemas/OutputRestApiMonthlyOnDayOfWeekScheduleTrigger53d4b16bf970" }, { "$ref": "#/components/schemas/OutputRestApiQuarterlyScheduleTriggerbeb283499463" }, { "$ref": "#/components/schemas/OutputRestApiAnnualScheduleTrigger9e9c8bf96230" }, { "$ref": "#/components/schemas/OutputRestApiOneTimeScheduleTrigger7f8bd364e99f" }, { "$ref": "#/components/schemas/OutputRestApiCustomScheduleTriggerdb31666e4bdd" }, { "$ref": "#/components/schemas/OutputRestApiCronScheduleTrigger0679b602052c" }, { "$ref": "#/components/schemas/OutputRestApiManualTrigger01b0ac4a464d" }, { "$ref": "#/components/schemas/OutputRestApiSlackTriggerf09888f51404" }, { "$ref": "#/components/schemas/OutputRestApiInboundEmailTriggera580510d7eb3" } ] } }, "required": [ "actions", "kind", "trigger" ], "title": "EditableWorkflowDefinition", "type": "object" }, "OutputRestApiEmail5284c8258dc3": { "description": "", "properties": { "display": { "description": "The display value of the email address.", "type": "string" }, "type": { "description": "The classification of the email.", "type": "string" }, "value": { "description": "A valid email address.", "type": "string" } }, "title": "Email", "type": "object" }, "OutputRestApiEmployeeDocumentItema59fa8768046": { "description": "A single item: attach `documents` to the worker identified by `worker_id`.", "properties": { "documents": { "description": "Documents to attach to the role. At least one required. Each entry references a FileUploadTracker by file_id.", "items": { "$ref": "#/components/schemas/OutputRestApiDraftHireDocument8f403bf65740" }, "type": "array" }, "folder_id": { "description": "Optional destination folder for documents. Accepts either: (1) an ObjectId string for custom folders, or (2) a default folder identifier ('root', 'confidential_documents', 'notices', 'work_authorization'). When omitted, documents land at the root of the worker's profile (current default behavior). When supplied, the folder must exist, be in an active state, be provisioned for the target worker, and the caller must have UPLOAD permission on it — otherwise behavior is governed by `on_invalid_folder`.", "type": "string" }, "on_invalid_folder": { "description": "Fallback behavior when `folder_id` is supplied but inaccessible. 'fail' (default) rejects each affected document with FOLDER_ACCESS_ERROR. 'fallback_to_root' uploads to the worker's root profile instead and attaches a FOLDER_ACCESS_FALLBACK warning to each result. Ignored when `folder_id` is omitted.", "type": "string" }, "worker_id": { "description": "Id of the worker to attach documents to.", "type": "string" } }, "required": [ "documents", "worker_id" ], "title": "EmployeeDocumentItem", "type": "object" }, "OutputRestApiEntitlementModelbc356e0b4ed0": { "description": "", "properties": { "description": { "description": "Description of the entitlement", "type": "string" }, "display_name": { "description": "Display name of the entitlement", "type": "string" }, "id": { "description": "Identifier field", "type": "string" } }, "required": [ "description", "display_name", "id" ], "title": "EntitlementModel", "type": "object" }, "OutputRestApiExpenseRequestd79b415064a3": { "description": "A Spend reimbursement the caller can see.\n\n A reimbursement is an expense the worker paid and the company pays back. Mileage and per diem\n use the same resource, with transaction_type MILEAGE_REIMBURSEMENT or PER_DIEM_REIMBURSEMENT.\n Retrieve returns one by ID. A reimbursement the caller cannot see returns 404, the same as one\n that does not exist.\n ", "properties": { "accounting_date": { "description": "Date the transaction is booked in the accounting system, as an ISO 8601 date (YYYY-MM-DD).", "type": "string" }, "approval_status": { "description": "Approval status of the transaction. `DRAFT`: not submitted for approval. `PENDING`: awaiting required information or submission before approval. `REQUESTED`: submitted and awaiting approval. `APPROVED`: approved. `REJECTED`: rejected. `FINALIZED`: finalized for payment. `ACTIONED`: payment or reimbursement completed. `CANCELLED`: cancelled. `FAILED`: payment failed. Null for card authorizations.", "type": "string" }, "attachments": { "description": "URLs of other attached files.", "items": { "type": "string" }, "type": "array" }, "company_amount": { "description": "Amount in the company's headquarters currency. The `value` is a decimal string.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "distance": { "anyOf": [ { "description": "Trip length in mileage_rate.units. Null except on mileage reimbursements.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "end_location": { "description": "End of a mileage trip. Null except on mileage reimbursements.", "properties": { "address": { "description": "Address of this point. Null when the point has no address.", "type": "string" }, "coordinates": { "description": "Latitude and longitude of this point, in decimal degrees. Null when the point has no coordinates.", "properties": { "latitude": { "anyOf": [ { "description": "Latitude of this point, in decimal degrees.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "longitude": { "anyOf": [ { "description": "Longitude of this point, in decimal degrees.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "MileageCoordinate", "type": "object" } }, "title": "MileageLocation", "type": "object" }, "entity_id": { "description": "ID of the legal entity the transaction belongs to. Use it with `/company-legal-entities/{id}/`.", "type": "string" }, "gl_sync_state": { "description": "State of the sync to the accounting system. `NOT_FINALIZED`: not ready for accounting review. `FOR_REVIEW`: ready for accounting review. `PENDING_SYNC`: sync is in progress. `SYNCED`: synced to the accounting system. `ERROR`: sync failed. `DO_NOT_SYNC`: marked to be excluded from sync. `EXPORTED`: exported for accounting. `NOT_SYNCABLE`: this record cannot be synced. `AUTO_SYNC`: ready to be synced automatically. Null when no sync state is set.", "type": "string" }, "gl_vendor": { "description": "Vendor in the connected accounting system.", "properties": { "gl_vendor_id": { "description": "ID of the vendor in the accounting system.", "type": "string" }, "id": { "description": "ID of the accounting vendor in Rippling.", "type": "string" }, "name": { "description": "Name of the vendor in the accounting system.", "type": "string" } }, "title": "GLVendor", "type": "object" }, "id": { "description": "Identifier field", "type": "string" }, "line_items": { "description": "Category splits of the transaction amount.", "items": { "$ref": "#/components/schemas/OutputRestApiLineItem8d6adc67985a" }, "type": "array" }, "memo": { "description": "Memo entered on the transaction.", "type": "string" }, "merchant_amount": { "description": "Amount charged by the merchant, in the merchant currency. The `value` is a decimal string.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "mileage_rate": { "description": "Company mileage rate. Null except on mileage reimbursements.", "properties": { "id": { "description": "Company mileage rate ID.", "type": "string" }, "name": { "description": "Company-defined label for this mileage rate, such as the rate used for a country or vehicle type.", "type": "string" }, "rate": { "description": "Amount per distance unit. The `value` is a decimal string.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "units": { "description": "Distance unit, mi or km.", "type": "string" } }, "title": "MileageRate", "type": "object" }, "payout_amount": { "description": "Amount credited to the worker. The `value` is a decimal string.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "payout_date": { "description": "Date the worker is paid, as an ISO 8601 date (YYYY-MM-DD). Null before a run is assigned.", "type": "string" }, "payout_method": { "description": "How the worker is paid. `NOT_SET`: no payout run is assigned. `US_PAYROLL`: assigned to a US payroll run. `GLOBAL_PAYROLL`: assigned to a global payroll run. `DIRECT_DEPOSIT`: assigned to a direct deposit run. `EOR`: assigned to an employer-of-record payroll run. `MANUAL`: marked paid outside a run. If a payout method override is set, it is returned.", "type": "string" }, "per_diem_line_items": { "description": "Per diem sub-rate rows. Null except on per diem reimbursements.", "items": { "$ref": "#/components/schemas/OutputRestApiPerDiemLineItemd5ece60cf2c4" }, "type": "array" }, "per_diem_rate": { "description": "Per diem rate for the trip. Null except on per diem reimbursements.", "properties": { "country": { "description": "Country this per diem rate applies to, as an ISO 3166-1 alpha-2 code. Example: US.", "type": "string" }, "currency": { "description": "Currency of the per diem rate, as an ISO 4217 code. Example: USD.", "type": "string" }, "destination_name": { "description": "Place this per diem rate applies to, such as a city.", "type": "string" }, "id": { "description": "Per diem rate ID.", "type": "string" } }, "title": "PerDiemRate", "type": "object" }, "receipt": { "description": "URL of the receipt file.", "type": "string" }, "start_location": { "description": "Start of a mileage trip. Null except on mileage reimbursements.", "properties": { "address": { "description": "Address of this point. Null when the point has no address.", "type": "string" }, "coordinates": { "description": "Latitude and longitude of this point, in decimal degrees. Null when the point has no coordinates.", "properties": { "latitude": { "anyOf": [ { "description": "Latitude of this point, in decimal degrees.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "longitude": { "anyOf": [ { "description": "Longitude of this point, in decimal degrees.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "MileageCoordinate", "type": "object" } }, "title": "MileageLocation", "type": "object" }, "transaction_date": { "description": "When the purchase or authorization happened, as an ISO 8601 date-time in UTC.", "type": "string" }, "transaction_type": { "description": "`REIMBURSEMENT`: an expense the worker paid and the company pays back. `MILEAGE_REIMBURSEMENT`: payback for distance driven. `PER_DIEM_REIMBURSEMENT`: payback for a daily travel allowance. This decides which mileage or per diem fields are set.", "type": "string" }, "trip_end_date": { "description": "Per diem trip end date, as an ISO 8601 date (YYYY-MM-DD). Null except on per diem reimbursements.", "type": "string" }, "trip_start_date": { "description": "Per diem trip start date, as an ISO 8601 date (YYYY-MM-DD). Null except on per diem reimbursements.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "vendor": { "description": "Vendor the purchase was made from.", "properties": { "id": { "description": "ID of the vendor.", "type": "string" }, "name": { "description": "Name of the vendor.", "type": "string" } }, "title": "Vendor", "type": "object" }, "waypoints": { "description": "List of intermediate stops during the trip, for mileage reimbursements. Null except on mileage reimbursements.", "items": { "$ref": "#/components/schemas/OutputRestApiMileageLocationa042563f5468" }, "type": "array" }, "worker_id": { "description": "ID of the worker who made the transaction. Use it with `/workers/{id}/`.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "ExpenseRequest", "type": "object" }, "OutputRestApiFieldPlacementa67e091362d8": { "description": "Placement of a readable field in a saved layout; contains no field value.", "properties": { "field": { "description": "Field API name in the response fields map.", "type": "string" }, "read_only": { "description": "Whether this placement is read-only.", "type": "boolean" } }, "required": [ "field", "read_only" ], "title": "FieldPlacement", "type": "object" }, "OutputRestApiFilterableField82dc32b097e4": { "description": "Describes a field the client can filter on when running a report", "properties": { "field_id": { "description": "Stable field identifier used when applying filters", "type": "string" }, "field_name": { "description": "Human-readable display name of the field", "type": "string" }, "operators": { "description": "Operators supported by this field", "items": { "type": "string" }, "type": "array" }, "type": { "description": "Data type of a filterable field", "title": "FilterFieldType", "type": "string" } }, "required": [ "field_id", "field_name", "operators", "type" ], "title": "FilterableField", "type": "object" }, "OutputRestApiFunctionDeploymentLogffd4b21ac24f": { "description": "", "properties": { "level": { "description": "The log level", "type": "string" }, "message": { "description": "The log message", "type": "string" }, "params": { "description": "Parameters associated with the log line", "type": "object" }, "sequence_num": { "anyOf": [ { "description": "The sequence number of the log line", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "timestamp": { "description": "The log timestamp", "type": "string" } }, "required": [ "message", "sequence_num" ], "title": "FunctionDeploymentLog", "type": "object" }, "OutputRestApiFunctionDeploymentff6a393070e2": { "description": "", "properties": { "allowed_domains": { "description": "Domains that function runs from this deployment are allowed to access", "items": { "type": "string" }, "type": "array" }, "code": { "description": "The code for the deployment", "type": "string" }, "created_at": { "description": "The creation date of the deployment", "type": "string" }, "dependencies": { "description": "The dependencies of the deployment", "type": "object" }, "external_id": { "description": "The external ID of the deployment", "type": "string" }, "function_api_name": { "description": "The API name of the function that this deployment is associated with", "type": "string" }, "function_id": { "description": "The ID of the function that this deployment is associated with", "type": "string" }, "function_version_human_friendly_id": { "anyOf": [ { "description": "The human friendly ID of version that this deployment is associated with", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "function_version_id": { "description": "The ID of the version that this deployment is associated with", "type": "string" }, "id": { "description": "The ID of the deployment", "type": "string" }, "io_contract": { "description": "Input and output JSON Schema contracts for the deployment", "type": "object" }, "options": { "description": "Additional, runtime-specific options for the deployment", "type": "object" }, "runtime": { "description": "The runtime for the deployment", "type": "string" }, "status": { "description": "The status of the deployment", "type": "string" }, "updated_at": { "description": "The last updated date of the deployment", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "FunctionDeployment", "type": "object" }, "OutputRestApiFunctionExecution8b8a5c5caf35": { "description": "", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "finished_at": { "description": "The end time of the execution", "type": "string" }, "function_id": { "description": "The ID of the function this execution belongs to", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "inputs": { "description": "The inputs of the execution", "type": "object" }, "outputs": { "description": "The outputs of the execution", "type": "object" }, "started_at": { "description": "The start time of the execution", "type": "string" }, "status": { "description": "The status of the execution", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "function_id", "id", "inputs", "updated_at" ], "title": "FunctionExecution", "type": "object" }, "OutputRestApiFunctionExecutionLogde864278783d": { "description": "", "properties": { "level": { "description": "The log level", "type": "string" }, "message": { "description": "The log message", "type": "string" }, "params": { "description": "Parameters associated with the log line", "type": "object" }, "sequence_num": { "anyOf": [ { "description": "The sequence number of the log line", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "timestamp": { "description": "The log timestamp", "type": "string" } }, "required": [ "message", "sequence_num" ], "title": "FunctionExecutionLog", "type": "object" }, "OutputRestApiFunctionc7dbb2131ac7": { "description": "", "properties": { "api_name": { "description": "The API name of the function", "type": "string" }, "code_draft": { "description": "The current draft of code for the function", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "dependencies": { "description": "The dependencies of the function", "type": "object" }, "description": { "description": "The function description", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_async": { "description": "Whether this function runs asynchronously", "type": "boolean" }, "name": { "description": "The function name", "type": "string" }, "source_upload_instructions": { "description": "Upload instructions returned only when source_upload was requested on create or update.", "properties": { "archive": { "description": "Archive reference for a subsequent deployment after the upload succeeds.", "properties": { "object_key": { "description": "Tenant-scoped object key to use as the archive reference in the explicit deployment JSON.", "type": "string" }, "sha256": { "description": "SHA-256 of the ZIP bytes.", "type": "string" }, "size_bytes": { "anyOf": [ { "description": "Exact ZIP size in bytes, returned as a JSON integer.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "required": [ "object_key", "sha256", "size_bytes" ], "title": "FunctionSourceUploadArchive", "type": "object" }, "expires_at": { "description": "UTC expiration of the upload instructions, in RFC3339/ISO8601 format.", "type": "string" }, "fields": { "additionalProperties": { "type": "string" }, "description": "Include every opaque signed field unchanged in the multipart/form-data POST, plus the ZIP file.", "type": "object" }, "method": { "description": "HTTP method for the client-direct upload.", "type": "string" }, "url": { "description": "Upload the ZIP directly to this URL, not through the Functions API.", "type": "string" } }, "required": [ "archive", "expires_at", "fields", "method", "url" ], "title": "FunctionSourceUploadInstructions", "type": "object" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Function", "type": "object" }, "OutputRestApiGroupMember1b01a7ea9b9e": { "description": "", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "full_name": { "description": "The group member's full name.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "work_email": { "description": "The group member's associated work email address.", "type": "string" }, "worker": { "description": "The worker associated with this group member.\n\nExpandable field", "properties": { "business_partners": { "description": "Worker's assigned business partners. This field is only populated when explicitly requested via the expand parameter (e.g., ?expand=business_partners). When expanded, returns an empty list ([]) if the worker has no business partners.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiBusinessPartner77b00a069c32" }, "type": "array" }, "business_partners_id": { "description": "Worker's assigned business partners unique identifiers. Returns an empty list ([]) if the worker has no business partners.", "items": { "type": "string" }, "type": "array" }, "citizenship": { "description": "The countries that the worker has citizenship in.", "type": "string" }, "compensation": { "description": "The compensation package for the worker.\n\nExpandable field", "properties": { "annual_compensation": { "description": "The worker's annual compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "annual_salary_equivalent": { "description": "The worker's annual salary equivalent, for insurance purposes. It will be equal to the worker's annual compensation, except for owners that are receiving no cashcompensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "bonus_schedule": { "description": "The worker's bonus schedule.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "hourly_wage": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "id": { "description": "Identifier field", "type": "string" }, "monthly_compensation": { "description": "The worker's monthly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "on_target_commission": { "description": "The worker's on-target commission.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "payment_terms": { "description": "The payment terms for an worker's compensation.", "type": "string" }, "payment_type": { "description": "The payment type for an worker's compensation.", "type": "string" }, "relocation_reimbursement": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "salary_effective_date": { "description": "Salary effective date", "type": "string" }, "signing_bonus": { "description": "The worker's signing bonus.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus": { "description": "The worker's target annual bonus amount.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus_percent": { "anyOf": [ { "description": "The worker's target annual bonus as a percent of annual compensation.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" }, "weekly_compensation": { "description": "The worker's weekly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "worker": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's details.\n\nExpandable field", "type": "object" }, "worker_id": { "description": "The worker's ID.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Compensation", "type": "object" }, "compensation_grade": { "description": "The compensation grade assigned to the worker, if any.", "properties": { "id": { "description": "The compensation grade's unique identifier.", "type": "string" }, "label": { "description": "The compensation grade's label.", "type": "string" } }, "title": "WorkerCompensationGrade", "type": "object" }, "compensation_id": { "description": "The compensation package for the worker.", "type": "string" }, "country": { "description": "The worker's country.", "type": "string" }, "country_fields": { "description": "Country level fields for the worker.", "properties": { "ca": { "description": "Country-wise regional fields for Canada", "properties": { "sin": { "description": "Social Insurance Number (SIN) for Canada employees.", "type": "string" } }, "title": "CanadaFields", "type": "object" }, "nz": { "description": "Country-wise regional fields for New Zealand", "properties": { "ird_number": { "description": "Inland Revenue Department (IRD) number for New Zealand employees.", "type": "string" } }, "title": "NewZealandFields", "type": "object" }, "us": { "description": "Country-wise regional fields for USA", "properties": { "ssn": { "description": "Social Security Number (SSN) for US employees.", "type": "string" } }, "title": "USFields", "type": "object" } }, "title": "CountryFields", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "custom_fields": { "description": "Custom field values defined on the Employee object for this worker\n\nExpandable field", "items": { "additionalProperties": {} }, "type": "array" }, "date_of_birth": { "description": "The worker's date of birth.", "type": "string" }, "department": { "description": "The worker's assigned department.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "department_hierarchy": { "description": "List of departments in the department hierarchy. Refer department_hierarchy_ids for department hierarchy order.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestDepartment" }, "type": "array" }, "department_hierarchy_id": { "description": "The identifier of departments in the department hierarchy ordered from parent department to child department.", "items": { "type": "string" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the department.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestDepartment", "description": "The parent department.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent department.", "type": "string" }, "reference_code": { "description": "Reference code of the department.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Department", "type": "object" }, "department_id": { "description": "The worker's assigned department.", "type": "string" }, "employment_type": { "description": "The worker's employment type.\n\nExpandable field", "properties": { "amount_worked": { "description": "The amount worked for the employment type. * `FULL-TIME`: Full-time is at least 30 hours per week. Full-time workers will typically be eligible for benefits. * `PART-TIME`: Part-time is less than 30 hours per week. These workers may be eligible for benefits, depending on company settings and hours worked. * `TEMPORARY`: These workers are hired on a temporary basis. You can specify how each worker with this employment type will be paid individually.", "type": "string" }, "compensation_time_period": { "description": "The compensation period for the employment type. * `SALARIED`: Employees that are paid a fixed amount per year. * `HOURLY`: Employees that are paid a wage per hour worked.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "label": { "description": "The display label of the employment type.", "type": "string" }, "name": { "description": "The name of the employment type for non-custom employment types.", "type": "string" }, "type": { "description": "The classification of the worker by the company. * `CONTRACTOR`: Contractors are self-employed workers who provide services on a short-term or per-project basis and are not eligible for tax-withholding or benefits. * `EMPLOYEE`: Employees are hired and managed by an employer, work under the employer's direct supervision and control, and are protected by law for wages and employment rights.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "label", "updated_at" ], "title": "CompanyEmploymentType", "type": "object" }, "employment_type_id": { "description": "The worker's employment type.", "type": "string" }, "end_date": { "description": "The end date of the worker.", "type": "string" }, "ethnicity": { "description": "The identified ethnicity of the worker, if specified.", "type": "string" }, "gender": { "description": "The gender of the worker, if specified.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_manager": { "description": "Whether the worker is a manager", "type": "boolean" }, "job_function": { "description": "The worker's job function. When expanded, this field requires `job-functions.read`.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "Displayed name of the job function", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "JobFunction", "type": "object" }, "job_function_id": { "description": "ID of the worker's job function.", "type": "string" }, "legal_entity": { "description": "The worker's associated legal entity.\n\nExpandable field", "properties": { "company": { "description": "The company or organization associated with the legal entity\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "doing_business_as_name": { "description": "The doing business as name for the company.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_entities": { "description": "A list of the company's entities.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestLegalEntity" }, "type": "array" }, "legal_entities_id": { "description": "A list of the company's entities.", "items": { "type": "string" }, "type": "array" }, "legal_name": { "description": "The legal name of the company.", "type": "string" }, "name": { "description": "The name of the company.", "type": "string" }, "parent_legal_entity": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The company's ultimate holding entity.\n\nExpandable field", "type": "object" }, "parent_legal_entity_id": { "description": "The company's ultimate holding entity.", "type": "string" }, "phone": { "description": "The phone number for the company.", "type": "string" }, "physical_address": { "description": "The physical address of the holding entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "primary_email": { "description": "The email address used when registering this company.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "legal_entities", "legal_entities_id", "name", "updated_at" ], "title": "Company", "type": "object" }, "company_id": { "description": "The company or organization associated with the legal entity", "type": "string" }, "country": { "description": "The country the legal entity is based in.", "properties": { "code": { "description": "The code of the country.", "type": "string" } }, "required": [ "code" ], "title": "Country", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "entity_level": { "description": "The legal entity's level in a hierarchy. * `PARENT`: The legal entity is considered the ultimate holding entity. * `SUBSIDIARY`: The legal entity is considered a subsidiary, fully or partially held by another. * `BRANCH`: The legal entity is considered a branch, associated with a parent legal entity.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_name": { "description": "The legal name of the legal entity.", "type": "string" }, "mailing_address": { "description": "The mailing address of the legal entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "management_type": { "description": "The legal entity management type in the case of an employer of record (EOR) or professional employment organization (PEO). * `PEO`: The legal entity is considered a Professional Employment Organization (PEO). * `EOR`: The legal entity is considered an Employer of Record (EOR).", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The parent legal entity.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent legal entity.", "type": "string" }, "physical_address": { "description": "The physical address of the legal entity, if it differs from the mailing address.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "registration_date": { "description": "The registration date of the entity.", "type": "string" }, "tax_identifier": { "description": "The tax identifier for the legal entity.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "LegalEntity", "type": "object" }, "legal_entity_id": { "description": "The worker's associated legal entity.", "type": "string" }, "level": { "description": "The level of the worker.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "description": { "description": "The description of the level.", "type": "string" }, "experience_requirements": { "description": "The experience requirements for the level.", "type": "string" }, "global_level": { "anyOf": [ { "description": "Global level is used to track the seniority of levels. The higher up a level is placed on the page, the more senior and higher-ranked the level. Global level is used in workflows, policies, and reports that use the level attribute (e.g., you can use Level Lookup to set up a workflow that notifies the nearest person in an worker's management chain at or above the specified level).", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the level. Must be unique within the company or organization.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLevel", "description": "The parent level.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent level.", "type": "string" }, "rank": { "anyOf": [ { "description": "The rank of the level within its track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "scope_of_responsibilities": { "description": "The scope of responsibilities for the level.", "type": "string" }, "track": { "description": "The track associated with the level, if it's not a global level.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_default": { "description": "Whether this is the company's default track.", "type": "boolean" }, "name": { "description": "The name of the track. Must be unique within the company or organization.", "type": "string" }, "order": { "anyOf": [ { "description": "The one-based horizontal display order of the track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "start_global_level": { "anyOf": [ { "description": "The highest global level occupied by this track. Empty tracks return null.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Track", "type": "object" }, "track_id": { "description": "The track associated with the level. Required during creation. Include global_level when changing it.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Level", "type": "object" }, "level_id": { "description": "The level of the worker.", "type": "string" }, "location": { "description": "The location that the worker is mapped to for tax purposes. In the case that a worker is remote, the location's type is remote.", "properties": { "type": { "description": "The type of location.", "type": "string" }, "work_location_id": { "description": "The work location, if the worker isn't remote.", "type": "string" } }, "required": [ "type", "work_location_id" ], "title": "WorkerLocation", "type": "object" }, "manager": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's manager.\n\nExpandable field", "type": "object" }, "manager_id": { "description": "The worker's manager.", "type": "string" }, "number": { "anyOf": [ { "description": "The worker's number within the organization.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "original_start_date": { "description": "The worker's earliest start date across their employment history, excluding INIT roles.", "type": "string" }, "overtime_exemption": { "description": "The worker's overtime exemption status.", "type": "string" }, "pay_schedule_id": { "description": "The ID of the pay schedule currently associated with the worker.", "type": "string" }, "personal_email": { "description": "The worker's associated personal email address.", "type": "string" }, "race": { "description": "The identified race of the worker, if specified.", "type": "string" }, "start_date": { "description": "The start date of the worker.", "type": "string" }, "status": { "description": "The worker's status within the organization.", "type": "string" }, "teams": { "description": "The worker's assigned teams.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiTeamcb26bc28f32f" }, "type": "array" }, "teams_id": { "description": "The worker's assigned teams.", "items": { "type": "string" }, "type": "array" }, "termination_details": { "description": "The details of the worker's termination, if applicable.", "properties": { "reason": { "description": "This is a description that will be custom to each Rippling company.", "type": "string" }, "type": { "description": "The termination type indicates whether the termination was voluntary or involuntary.", "type": "string" } }, "title": "TerminationDetails", "type": "object" }, "title": { "description": "The worker's title.", "type": "string" }, "title_effective_date": { "description": "Title effective date", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "user": { "description": "The worker's associated user.\n\nExpandable field", "properties": { "active": { "description": "Whether the user is able to access company resources, typically when they are in actively engaged with the company and not after off-boarding.", "type": "boolean" }, "addresses": { "description": "The user's addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiUserAddressedd59b9ba9a1" }, "type": "array" }, "created_at": { "description": "Record creation date", "type": "string" }, "display_name": { "description": "The display name of the user using either the concatenated preferred given and family name or username depending on availability.", "type": "string" }, "emails": { "description": "The user's email addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiEmail5284c8258dc3" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "locale": { "description": "The User's default location for purposes of localization of currency, date time format, or numerical representations pursuant to RFC5646.", "type": "string" }, "name": { "description": "The user's name.", "properties": { "family_name": { "description": "The legal family name of the user, or last name in most Western languages.", "type": "string" }, "formatted": { "description": "The user's full name.", "type": "string" }, "given_name": { "description": "The given legal name of the user, or first name in most Western languages.", "type": "string" }, "middle_name": { "description": "The middle name(s) of the user.", "type": "string" }, "preferred_family_name": { "description": "The preferred family name, or last name in most Western languages, by the user.", "type": "string" }, "preferred_given_name": { "description": "The preferred given name, or first name in most Western languages, by the user.", "type": "string" } }, "title": "UserName", "type": "object" }, "number": { "description": "The permanent profile number of the user.", "type": "string" }, "phone_numbers": { "description": "The user's phone numbers.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoneNumber12060c61ecf5" }, "type": "array" }, "photos": { "description": "The user's photos.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoto2be7c3ae3f39" }, "type": "array" }, "preferred_language": { "description": "The User's preferred written or spoken language in the same format of the HTTP Accept-Language header, pursuant to Section 5.3.5 of RFC7231.", "type": "string" }, "timezone": { "description": "The User's current time zone in IANA database Olson format", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "username": { "description": "The unique identifier across Rippling used by the User for direct authentication into their associated company. Globally unique.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "User", "type": "object" }, "user_id": { "description": "The worker's associated user.", "type": "string" }, "work_email": { "description": "The worker's associated work email address.", "type": "string" }, "work_schedule": { "additionalProperties": { "$ref": "#/components/schemas/OutputRestApiWorkScheduleDay938f88d94f20" }, "description": "The worker's scheduled working hours for each day of the week.", "type": "object" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Worker", "type": "object" }, "worker_id": { "description": "The worker's identifier associated with this group member.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "GroupMember", "type": "object" }, "OutputRestApiHeadcountPosition64649a08045c": { "description": "", "properties": { "actual_compensation": { "description": "Compensation data synched from worker compensation", "properties": { "base_pay": { "description": "Annual base pay for the headcount position", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "bonus": { "description": "Annual bonus for the headcount position", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "commission": { "description": "Annual on target commission for the headcount position", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "tax_and_benefits": { "description": "Annual total taxes and benefits compensation for this headcount position", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "total_cash": { "description": "Annual total cash compensation for the headcount position", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "total_equity": { "description": "Annual total equity compensation for the headcount position", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" } }, "title": "HeadcountCompensationData", "type": "object" }, "backfill_for": { "description": "Worker for whom this headcount position was requested as a backfill\n\nExpandable field", "properties": { "business_partners": { "description": "Worker's assigned business partners. This field is only populated when explicitly requested via the expand parameter (e.g., ?expand=business_partners). When expanded, returns an empty list ([]) if the worker has no business partners.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiBusinessPartner77b00a069c32" }, "type": "array" }, "business_partners_id": { "description": "Worker's assigned business partners unique identifiers. Returns an empty list ([]) if the worker has no business partners.", "items": { "type": "string" }, "type": "array" }, "citizenship": { "description": "The countries that the worker has citizenship in.", "type": "string" }, "compensation": { "description": "The compensation package for the worker.\n\nExpandable field", "properties": { "annual_compensation": { "description": "The worker's annual compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "annual_salary_equivalent": { "description": "The worker's annual salary equivalent, for insurance purposes. It will be equal to the worker's annual compensation, except for owners that are receiving no cashcompensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "bonus_schedule": { "description": "The worker's bonus schedule.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "hourly_wage": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "id": { "description": "Identifier field", "type": "string" }, "monthly_compensation": { "description": "The worker's monthly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "on_target_commission": { "description": "The worker's on-target commission.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "payment_terms": { "description": "The payment terms for an worker's compensation.", "type": "string" }, "payment_type": { "description": "The payment type for an worker's compensation.", "type": "string" }, "relocation_reimbursement": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "salary_effective_date": { "description": "Salary effective date", "type": "string" }, "signing_bonus": { "description": "The worker's signing bonus.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus": { "description": "The worker's target annual bonus amount.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus_percent": { "anyOf": [ { "description": "The worker's target annual bonus as a percent of annual compensation.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" }, "weekly_compensation": { "description": "The worker's weekly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "worker": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's details.\n\nExpandable field", "type": "object" }, "worker_id": { "description": "The worker's ID.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Compensation", "type": "object" }, "compensation_grade": { "description": "The compensation grade assigned to the worker, if any.", "properties": { "id": { "description": "The compensation grade's unique identifier.", "type": "string" }, "label": { "description": "The compensation grade's label.", "type": "string" } }, "title": "WorkerCompensationGrade", "type": "object" }, "compensation_id": { "description": "The compensation package for the worker.", "type": "string" }, "country": { "description": "The worker's country.", "type": "string" }, "country_fields": { "description": "Country level fields for the worker.", "properties": { "ca": { "description": "Country-wise regional fields for Canada", "properties": { "sin": { "description": "Social Insurance Number (SIN) for Canada employees.", "type": "string" } }, "title": "CanadaFields", "type": "object" }, "nz": { "description": "Country-wise regional fields for New Zealand", "properties": { "ird_number": { "description": "Inland Revenue Department (IRD) number for New Zealand employees.", "type": "string" } }, "title": "NewZealandFields", "type": "object" }, "us": { "description": "Country-wise regional fields for USA", "properties": { "ssn": { "description": "Social Security Number (SSN) for US employees.", "type": "string" } }, "title": "USFields", "type": "object" } }, "title": "CountryFields", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "custom_fields": { "description": "Custom field values defined on the Employee object for this worker\n\nExpandable field", "items": { "additionalProperties": {} }, "type": "array" }, "date_of_birth": { "description": "The worker's date of birth.", "type": "string" }, "department": { "description": "The worker's assigned department.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "department_hierarchy": { "description": "List of departments in the department hierarchy. Refer department_hierarchy_ids for department hierarchy order.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestDepartment" }, "type": "array" }, "department_hierarchy_id": { "description": "The identifier of departments in the department hierarchy ordered from parent department to child department.", "items": { "type": "string" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the department.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestDepartment", "description": "The parent department.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent department.", "type": "string" }, "reference_code": { "description": "Reference code of the department.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Department", "type": "object" }, "department_id": { "description": "The worker's assigned department.", "type": "string" }, "employment_type": { "description": "The worker's employment type.\n\nExpandable field", "properties": { "amount_worked": { "description": "The amount worked for the employment type. * `FULL-TIME`: Full-time is at least 30 hours per week. Full-time workers will typically be eligible for benefits. * `PART-TIME`: Part-time is less than 30 hours per week. These workers may be eligible for benefits, depending on company settings and hours worked. * `TEMPORARY`: These workers are hired on a temporary basis. You can specify how each worker with this employment type will be paid individually.", "type": "string" }, "compensation_time_period": { "description": "The compensation period for the employment type. * `SALARIED`: Employees that are paid a fixed amount per year. * `HOURLY`: Employees that are paid a wage per hour worked.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "label": { "description": "The display label of the employment type.", "type": "string" }, "name": { "description": "The name of the employment type for non-custom employment types.", "type": "string" }, "type": { "description": "The classification of the worker by the company. * `CONTRACTOR`: Contractors are self-employed workers who provide services on a short-term or per-project basis and are not eligible for tax-withholding or benefits. * `EMPLOYEE`: Employees are hired and managed by an employer, work under the employer's direct supervision and control, and are protected by law for wages and employment rights.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "label", "updated_at" ], "title": "CompanyEmploymentType", "type": "object" }, "employment_type_id": { "description": "The worker's employment type.", "type": "string" }, "end_date": { "description": "The end date of the worker.", "type": "string" }, "ethnicity": { "description": "The identified ethnicity of the worker, if specified.", "type": "string" }, "gender": { "description": "The gender of the worker, if specified.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_manager": { "description": "Whether the worker is a manager", "type": "boolean" }, "job_function": { "description": "The worker's job function. When expanded, this field requires `job-functions.read`.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "Displayed name of the job function", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "JobFunction", "type": "object" }, "job_function_id": { "description": "ID of the worker's job function.", "type": "string" }, "legal_entity": { "description": "The worker's associated legal entity.\n\nExpandable field", "properties": { "company": { "description": "The company or organization associated with the legal entity\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "doing_business_as_name": { "description": "The doing business as name for the company.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_entities": { "description": "A list of the company's entities.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestLegalEntity" }, "type": "array" }, "legal_entities_id": { "description": "A list of the company's entities.", "items": { "type": "string" }, "type": "array" }, "legal_name": { "description": "The legal name of the company.", "type": "string" }, "name": { "description": "The name of the company.", "type": "string" }, "parent_legal_entity": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The company's ultimate holding entity.\n\nExpandable field", "type": "object" }, "parent_legal_entity_id": { "description": "The company's ultimate holding entity.", "type": "string" }, "phone": { "description": "The phone number for the company.", "type": "string" }, "physical_address": { "description": "The physical address of the holding entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "primary_email": { "description": "The email address used when registering this company.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "legal_entities", "legal_entities_id", "name", "updated_at" ], "title": "Company", "type": "object" }, "company_id": { "description": "The company or organization associated with the legal entity", "type": "string" }, "country": { "description": "The country the legal entity is based in.", "properties": { "code": { "description": "The code of the country.", "type": "string" } }, "required": [ "code" ], "title": "Country", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "entity_level": { "description": "The legal entity's level in a hierarchy. * `PARENT`: The legal entity is considered the ultimate holding entity. * `SUBSIDIARY`: The legal entity is considered a subsidiary, fully or partially held by another. * `BRANCH`: The legal entity is considered a branch, associated with a parent legal entity.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_name": { "description": "The legal name of the legal entity.", "type": "string" }, "mailing_address": { "description": "The mailing address of the legal entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "management_type": { "description": "The legal entity management type in the case of an employer of record (EOR) or professional employment organization (PEO). * `PEO`: The legal entity is considered a Professional Employment Organization (PEO). * `EOR`: The legal entity is considered an Employer of Record (EOR).", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The parent legal entity.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent legal entity.", "type": "string" }, "physical_address": { "description": "The physical address of the legal entity, if it differs from the mailing address.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "registration_date": { "description": "The registration date of the entity.", "type": "string" }, "tax_identifier": { "description": "The tax identifier for the legal entity.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "LegalEntity", "type": "object" }, "legal_entity_id": { "description": "The worker's associated legal entity.", "type": "string" }, "level": { "description": "The level of the worker.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "description": { "description": "The description of the level.", "type": "string" }, "experience_requirements": { "description": "The experience requirements for the level.", "type": "string" }, "global_level": { "anyOf": [ { "description": "Global level is used to track the seniority of levels. The higher up a level is placed on the page, the more senior and higher-ranked the level. Global level is used in workflows, policies, and reports that use the level attribute (e.g., you can use Level Lookup to set up a workflow that notifies the nearest person in an worker's management chain at or above the specified level).", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the level. Must be unique within the company or organization.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLevel", "description": "The parent level.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent level.", "type": "string" }, "rank": { "anyOf": [ { "description": "The rank of the level within its track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "scope_of_responsibilities": { "description": "The scope of responsibilities for the level.", "type": "string" }, "track": { "description": "The track associated with the level, if it's not a global level.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_default": { "description": "Whether this is the company's default track.", "type": "boolean" }, "name": { "description": "The name of the track. Must be unique within the company or organization.", "type": "string" }, "order": { "anyOf": [ { "description": "The one-based horizontal display order of the track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "start_global_level": { "anyOf": [ { "description": "The highest global level occupied by this track. Empty tracks return null.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Track", "type": "object" }, "track_id": { "description": "The track associated with the level. Required during creation. Include global_level when changing it.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Level", "type": "object" }, "level_id": { "description": "The level of the worker.", "type": "string" }, "location": { "description": "The location that the worker is mapped to for tax purposes. In the case that a worker is remote, the location's type is remote.", "properties": { "type": { "description": "The type of location.", "type": "string" }, "work_location_id": { "description": "The work location, if the worker isn't remote.", "type": "string" } }, "required": [ "type", "work_location_id" ], "title": "WorkerLocation", "type": "object" }, "manager": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's manager.\n\nExpandable field", "type": "object" }, "manager_id": { "description": "The worker's manager.", "type": "string" }, "number": { "anyOf": [ { "description": "The worker's number within the organization.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "original_start_date": { "description": "The worker's earliest start date across their employment history, excluding INIT roles.", "type": "string" }, "overtime_exemption": { "description": "The worker's overtime exemption status.", "type": "string" }, "pay_schedule_id": { "description": "The ID of the pay schedule currently associated with the worker.", "type": "string" }, "personal_email": { "description": "The worker's associated personal email address.", "type": "string" }, "race": { "description": "The identified race of the worker, if specified.", "type": "string" }, "start_date": { "description": "The start date of the worker.", "type": "string" }, "status": { "description": "The worker's status within the organization.", "type": "string" }, "teams": { "description": "The worker's assigned teams.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiTeamcb26bc28f32f" }, "type": "array" }, "teams_id": { "description": "The worker's assigned teams.", "items": { "type": "string" }, "type": "array" }, "termination_details": { "description": "The details of the worker's termination, if applicable.", "properties": { "reason": { "description": "This is a description that will be custom to each Rippling company.", "type": "string" }, "type": { "description": "The termination type indicates whether the termination was voluntary or involuntary.", "type": "string" } }, "title": "TerminationDetails", "type": "object" }, "title": { "description": "The worker's title.", "type": "string" }, "title_effective_date": { "description": "Title effective date", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "user": { "description": "The worker's associated user.\n\nExpandable field", "properties": { "active": { "description": "Whether the user is able to access company resources, typically when they are in actively engaged with the company and not after off-boarding.", "type": "boolean" }, "addresses": { "description": "The user's addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiUserAddressedd59b9ba9a1" }, "type": "array" }, "created_at": { "description": "Record creation date", "type": "string" }, "display_name": { "description": "The display name of the user using either the concatenated preferred given and family name or username depending on availability.", "type": "string" }, "emails": { "description": "The user's email addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiEmail5284c8258dc3" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "locale": { "description": "The User's default location for purposes of localization of currency, date time format, or numerical representations pursuant to RFC5646.", "type": "string" }, "name": { "description": "The user's name.", "properties": { "family_name": { "description": "The legal family name of the user, or last name in most Western languages.", "type": "string" }, "formatted": { "description": "The user's full name.", "type": "string" }, "given_name": { "description": "The given legal name of the user, or first name in most Western languages.", "type": "string" }, "middle_name": { "description": "The middle name(s) of the user.", "type": "string" }, "preferred_family_name": { "description": "The preferred family name, or last name in most Western languages, by the user.", "type": "string" }, "preferred_given_name": { "description": "The preferred given name, or first name in most Western languages, by the user.", "type": "string" } }, "title": "UserName", "type": "object" }, "number": { "description": "The permanent profile number of the user.", "type": "string" }, "phone_numbers": { "description": "The user's phone numbers.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoneNumber12060c61ecf5" }, "type": "array" }, "photos": { "description": "The user's photos.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoto2be7c3ae3f39" }, "type": "array" }, "preferred_language": { "description": "The User's preferred written or spoken language in the same format of the HTTP Accept-Language header, pursuant to Section 5.3.5 of RFC7231.", "type": "string" }, "timezone": { "description": "The User's current time zone in IANA database Olson format", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "username": { "description": "The unique identifier across Rippling used by the User for direct authentication into their associated company. Globally unique.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "User", "type": "object" }, "user_id": { "description": "The worker's associated user.", "type": "string" }, "work_email": { "description": "The worker's associated work email address.", "type": "string" }, "work_schedule": { "additionalProperties": { "$ref": "#/components/schemas/OutputRestApiWorkScheduleDay938f88d94f20" }, "description": "The worker's scheduled working hours for each day of the week.", "type": "object" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Worker", "type": "object" }, "backfill_for_id": { "description": "ID of the worker for whom this headcount position was requested as a backfill", "type": "string" }, "comp_band_compensation": { "description": "Compensation data defined through comp band", "properties": { "base_pay": { "description": "Annual base pay for the headcount position", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "bonus": { "description": "Annual bonus for the headcount position", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "commission": { "description": "Annual on target commission for the headcount position", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "tax_and_benefits": { "description": "Annual total taxes and benefits compensation for this headcount position", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "total_cash": { "description": "Annual total cash compensation for the headcount position", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "total_equity": { "description": "Annual total equity compensation for the headcount position", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" } }, "title": "HeadcountCompensationData", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "current_start_date": { "description": "Most recent start date estimate or the actual hire date if already filled", "type": "string" }, "department": { "description": "Department the headcount belongs to\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "department_hierarchy": { "description": "List of departments in the department hierarchy. Refer department_hierarchy_ids for department hierarchy order.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestDepartment" }, "type": "array" }, "department_hierarchy_id": { "description": "The identifier of departments in the department hierarchy ordered from parent department to child department.", "items": { "type": "string" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the department.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestDepartment", "description": "The parent department.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent department.", "type": "string" }, "reference_code": { "description": "Reference code of the department.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Department", "type": "object" }, "department_id": { "description": "ID for the department the headcount belongs to", "type": "string" }, "employment_type": { "description": "Employment type the headcount is assigned to\n\nExpandable field", "properties": { "amount_worked": { "description": "The amount worked for the employment type. * `FULL-TIME`: Full-time is at least 30 hours per week. Full-time workers will typically be eligible for benefits. * `PART-TIME`: Part-time is less than 30 hours per week. These workers may be eligible for benefits, depending on company settings and hours worked. * `TEMPORARY`: These workers are hired on a temporary basis. You can specify how each worker with this employment type will be paid individually.", "type": "string" }, "compensation_time_period": { "description": "The compensation period for the employment type. * `SALARIED`: Employees that are paid a fixed amount per year. * `HOURLY`: Employees that are paid a wage per hour worked.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "label": { "description": "The display label of the employment type.", "type": "string" }, "name": { "description": "The name of the employment type for non-custom employment types.", "type": "string" }, "type": { "description": "The classification of the worker by the company. * `CONTRACTOR`: Contractors are self-employed workers who provide services on a short-term or per-project basis and are not eligible for tax-withholding or benefits. * `EMPLOYEE`: Employees are hired and managed by an employer, work under the employer's direct supervision and control, and are protected by law for wages and employment rights.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "label", "updated_at" ], "title": "CompanyEmploymentType", "type": "object" }, "employment_type_id": { "description": "ID for the employment type the headcount is assigned to", "type": "string" }, "end_date": { "description": "Targeted end date for the headcount", "type": "string" }, "headcount_owner": { "description": "Owner of the headcount\n\nExpandable field", "properties": { "business_partners": { "description": "Worker's assigned business partners. This field is only populated when explicitly requested via the expand parameter (e.g., ?expand=business_partners). When expanded, returns an empty list ([]) if the worker has no business partners.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiBusinessPartner77b00a069c32" }, "type": "array" }, "business_partners_id": { "description": "Worker's assigned business partners unique identifiers. Returns an empty list ([]) if the worker has no business partners.", "items": { "type": "string" }, "type": "array" }, "citizenship": { "description": "The countries that the worker has citizenship in.", "type": "string" }, "compensation": { "description": "The compensation package for the worker.\n\nExpandable field", "properties": { "annual_compensation": { "description": "The worker's annual compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "annual_salary_equivalent": { "description": "The worker's annual salary equivalent, for insurance purposes. It will be equal to the worker's annual compensation, except for owners that are receiving no cashcompensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "bonus_schedule": { "description": "The worker's bonus schedule.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "hourly_wage": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "id": { "description": "Identifier field", "type": "string" }, "monthly_compensation": { "description": "The worker's monthly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "on_target_commission": { "description": "The worker's on-target commission.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "payment_terms": { "description": "The payment terms for an worker's compensation.", "type": "string" }, "payment_type": { "description": "The payment type for an worker's compensation.", "type": "string" }, "relocation_reimbursement": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "salary_effective_date": { "description": "Salary effective date", "type": "string" }, "signing_bonus": { "description": "The worker's signing bonus.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus": { "description": "The worker's target annual bonus amount.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus_percent": { "anyOf": [ { "description": "The worker's target annual bonus as a percent of annual compensation.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" }, "weekly_compensation": { "description": "The worker's weekly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "worker": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's details.\n\nExpandable field", "type": "object" }, "worker_id": { "description": "The worker's ID.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Compensation", "type": "object" }, "compensation_grade": { "description": "The compensation grade assigned to the worker, if any.", "properties": { "id": { "description": "The compensation grade's unique identifier.", "type": "string" }, "label": { "description": "The compensation grade's label.", "type": "string" } }, "title": "WorkerCompensationGrade", "type": "object" }, "compensation_id": { "description": "The compensation package for the worker.", "type": "string" }, "country": { "description": "The worker's country.", "type": "string" }, "country_fields": { "description": "Country level fields for the worker.", "properties": { "ca": { "description": "Country-wise regional fields for Canada", "properties": { "sin": { "description": "Social Insurance Number (SIN) for Canada employees.", "type": "string" } }, "title": "CanadaFields", "type": "object" }, "nz": { "description": "Country-wise regional fields for New Zealand", "properties": { "ird_number": { "description": "Inland Revenue Department (IRD) number for New Zealand employees.", "type": "string" } }, "title": "NewZealandFields", "type": "object" }, "us": { "description": "Country-wise regional fields for USA", "properties": { "ssn": { "description": "Social Security Number (SSN) for US employees.", "type": "string" } }, "title": "USFields", "type": "object" } }, "title": "CountryFields", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "custom_fields": { "description": "Custom field values defined on the Employee object for this worker\n\nExpandable field", "items": { "additionalProperties": {} }, "type": "array" }, "date_of_birth": { "description": "The worker's date of birth.", "type": "string" }, "department": { "description": "The worker's assigned department.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "department_hierarchy": { "description": "List of departments in the department hierarchy. Refer department_hierarchy_ids for department hierarchy order.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestDepartment" }, "type": "array" }, "department_hierarchy_id": { "description": "The identifier of departments in the department hierarchy ordered from parent department to child department.", "items": { "type": "string" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the department.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestDepartment", "description": "The parent department.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent department.", "type": "string" }, "reference_code": { "description": "Reference code of the department.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Department", "type": "object" }, "department_id": { "description": "The worker's assigned department.", "type": "string" }, "employment_type": { "description": "The worker's employment type.\n\nExpandable field", "properties": { "amount_worked": { "description": "The amount worked for the employment type. * `FULL-TIME`: Full-time is at least 30 hours per week. Full-time workers will typically be eligible for benefits. * `PART-TIME`: Part-time is less than 30 hours per week. These workers may be eligible for benefits, depending on company settings and hours worked. * `TEMPORARY`: These workers are hired on a temporary basis. You can specify how each worker with this employment type will be paid individually.", "type": "string" }, "compensation_time_period": { "description": "The compensation period for the employment type. * `SALARIED`: Employees that are paid a fixed amount per year. * `HOURLY`: Employees that are paid a wage per hour worked.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "label": { "description": "The display label of the employment type.", "type": "string" }, "name": { "description": "The name of the employment type for non-custom employment types.", "type": "string" }, "type": { "description": "The classification of the worker by the company. * `CONTRACTOR`: Contractors are self-employed workers who provide services on a short-term or per-project basis and are not eligible for tax-withholding or benefits. * `EMPLOYEE`: Employees are hired and managed by an employer, work under the employer's direct supervision and control, and are protected by law for wages and employment rights.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "label", "updated_at" ], "title": "CompanyEmploymentType", "type": "object" }, "employment_type_id": { "description": "The worker's employment type.", "type": "string" }, "end_date": { "description": "The end date of the worker.", "type": "string" }, "ethnicity": { "description": "The identified ethnicity of the worker, if specified.", "type": "string" }, "gender": { "description": "The gender of the worker, if specified.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_manager": { "description": "Whether the worker is a manager", "type": "boolean" }, "job_function": { "description": "The worker's job function. When expanded, this field requires `job-functions.read`.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "Displayed name of the job function", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "JobFunction", "type": "object" }, "job_function_id": { "description": "ID of the worker's job function.", "type": "string" }, "legal_entity": { "description": "The worker's associated legal entity.\n\nExpandable field", "properties": { "company": { "description": "The company or organization associated with the legal entity\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "doing_business_as_name": { "description": "The doing business as name for the company.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_entities": { "description": "A list of the company's entities.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestLegalEntity" }, "type": "array" }, "legal_entities_id": { "description": "A list of the company's entities.", "items": { "type": "string" }, "type": "array" }, "legal_name": { "description": "The legal name of the company.", "type": "string" }, "name": { "description": "The name of the company.", "type": "string" }, "parent_legal_entity": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The company's ultimate holding entity.\n\nExpandable field", "type": "object" }, "parent_legal_entity_id": { "description": "The company's ultimate holding entity.", "type": "string" }, "phone": { "description": "The phone number for the company.", "type": "string" }, "physical_address": { "description": "The physical address of the holding entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "primary_email": { "description": "The email address used when registering this company.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "legal_entities", "legal_entities_id", "name", "updated_at" ], "title": "Company", "type": "object" }, "company_id": { "description": "The company or organization associated with the legal entity", "type": "string" }, "country": { "description": "The country the legal entity is based in.", "properties": { "code": { "description": "The code of the country.", "type": "string" } }, "required": [ "code" ], "title": "Country", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "entity_level": { "description": "The legal entity's level in a hierarchy. * `PARENT`: The legal entity is considered the ultimate holding entity. * `SUBSIDIARY`: The legal entity is considered a subsidiary, fully or partially held by another. * `BRANCH`: The legal entity is considered a branch, associated with a parent legal entity.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_name": { "description": "The legal name of the legal entity.", "type": "string" }, "mailing_address": { "description": "The mailing address of the legal entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "management_type": { "description": "The legal entity management type in the case of an employer of record (EOR) or professional employment organization (PEO). * `PEO`: The legal entity is considered a Professional Employment Organization (PEO). * `EOR`: The legal entity is considered an Employer of Record (EOR).", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The parent legal entity.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent legal entity.", "type": "string" }, "physical_address": { "description": "The physical address of the legal entity, if it differs from the mailing address.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "registration_date": { "description": "The registration date of the entity.", "type": "string" }, "tax_identifier": { "description": "The tax identifier for the legal entity.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "LegalEntity", "type": "object" }, "legal_entity_id": { "description": "The worker's associated legal entity.", "type": "string" }, "level": { "description": "The level of the worker.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "description": { "description": "The description of the level.", "type": "string" }, "experience_requirements": { "description": "The experience requirements for the level.", "type": "string" }, "global_level": { "anyOf": [ { "description": "Global level is used to track the seniority of levels. The higher up a level is placed on the page, the more senior and higher-ranked the level. Global level is used in workflows, policies, and reports that use the level attribute (e.g., you can use Level Lookup to set up a workflow that notifies the nearest person in an worker's management chain at or above the specified level).", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the level. Must be unique within the company or organization.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLevel", "description": "The parent level.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent level.", "type": "string" }, "rank": { "anyOf": [ { "description": "The rank of the level within its track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "scope_of_responsibilities": { "description": "The scope of responsibilities for the level.", "type": "string" }, "track": { "description": "The track associated with the level, if it's not a global level.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_default": { "description": "Whether this is the company's default track.", "type": "boolean" }, "name": { "description": "The name of the track. Must be unique within the company or organization.", "type": "string" }, "order": { "anyOf": [ { "description": "The one-based horizontal display order of the track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "start_global_level": { "anyOf": [ { "description": "The highest global level occupied by this track. Empty tracks return null.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Track", "type": "object" }, "track_id": { "description": "The track associated with the level. Required during creation. Include global_level when changing it.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Level", "type": "object" }, "level_id": { "description": "The level of the worker.", "type": "string" }, "location": { "description": "The location that the worker is mapped to for tax purposes. In the case that a worker is remote, the location's type is remote.", "properties": { "type": { "description": "The type of location.", "type": "string" }, "work_location_id": { "description": "The work location, if the worker isn't remote.", "type": "string" } }, "required": [ "type", "work_location_id" ], "title": "WorkerLocation", "type": "object" }, "manager": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's manager.\n\nExpandable field", "type": "object" }, "manager_id": { "description": "The worker's manager.", "type": "string" }, "number": { "anyOf": [ { "description": "The worker's number within the organization.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "original_start_date": { "description": "The worker's earliest start date across their employment history, excluding INIT roles.", "type": "string" }, "overtime_exemption": { "description": "The worker's overtime exemption status.", "type": "string" }, "pay_schedule_id": { "description": "The ID of the pay schedule currently associated with the worker.", "type": "string" }, "personal_email": { "description": "The worker's associated personal email address.", "type": "string" }, "race": { "description": "The identified race of the worker, if specified.", "type": "string" }, "start_date": { "description": "The start date of the worker.", "type": "string" }, "status": { "description": "The worker's status within the organization.", "type": "string" }, "teams": { "description": "The worker's assigned teams.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiTeamcb26bc28f32f" }, "type": "array" }, "teams_id": { "description": "The worker's assigned teams.", "items": { "type": "string" }, "type": "array" }, "termination_details": { "description": "The details of the worker's termination, if applicable.", "properties": { "reason": { "description": "This is a description that will be custom to each Rippling company.", "type": "string" }, "type": { "description": "The termination type indicates whether the termination was voluntary or involuntary.", "type": "string" } }, "title": "TerminationDetails", "type": "object" }, "title": { "description": "The worker's title.", "type": "string" }, "title_effective_date": { "description": "Title effective date", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "user": { "description": "The worker's associated user.\n\nExpandable field", "properties": { "active": { "description": "Whether the user is able to access company resources, typically when they are in actively engaged with the company and not after off-boarding.", "type": "boolean" }, "addresses": { "description": "The user's addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiUserAddressedd59b9ba9a1" }, "type": "array" }, "created_at": { "description": "Record creation date", "type": "string" }, "display_name": { "description": "The display name of the user using either the concatenated preferred given and family name or username depending on availability.", "type": "string" }, "emails": { "description": "The user's email addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiEmail5284c8258dc3" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "locale": { "description": "The User's default location for purposes of localization of currency, date time format, or numerical representations pursuant to RFC5646.", "type": "string" }, "name": { "description": "The user's name.", "properties": { "family_name": { "description": "The legal family name of the user, or last name in most Western languages.", "type": "string" }, "formatted": { "description": "The user's full name.", "type": "string" }, "given_name": { "description": "The given legal name of the user, or first name in most Western languages.", "type": "string" }, "middle_name": { "description": "The middle name(s) of the user.", "type": "string" }, "preferred_family_name": { "description": "The preferred family name, or last name in most Western languages, by the user.", "type": "string" }, "preferred_given_name": { "description": "The preferred given name, or first name in most Western languages, by the user.", "type": "string" } }, "title": "UserName", "type": "object" }, "number": { "description": "The permanent profile number of the user.", "type": "string" }, "phone_numbers": { "description": "The user's phone numbers.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoneNumber12060c61ecf5" }, "type": "array" }, "photos": { "description": "The user's photos.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoto2be7c3ae3f39" }, "type": "array" }, "preferred_language": { "description": "The User's preferred written or spoken language in the same format of the HTTP Accept-Language header, pursuant to Section 5.3.5 of RFC7231.", "type": "string" }, "timezone": { "description": "The User's current time zone in IANA database Olson format", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "username": { "description": "The unique identifier across Rippling used by the User for direct authentication into their associated company. Globally unique.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "User", "type": "object" }, "user_id": { "description": "The worker's associated user.", "type": "string" }, "work_email": { "description": "The worker's associated work email address.", "type": "string" }, "work_schedule": { "additionalProperties": { "$ref": "#/components/schemas/OutputRestApiWorkScheduleDay938f88d94f20" }, "description": "The worker's scheduled working hours for each day of the week.", "type": "object" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Worker", "type": "object" }, "headcount_owner_id": { "description": "ID for the headcount owner", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "in_budget": { "description": "Whether the headcount position is in budget", "type": "boolean" }, "job_function": { "description": "Job function assigned to this headcount\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "Displayed name of the job function", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "JobFunction", "type": "object" }, "job_function_id": { "description": "ID for the job function the headcount is assigned to", "type": "string" }, "job_requisition": { "description": "Job requisition the headcount is associated with\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "Job requisition name", "type": "string" }, "status": { "description": "Job requisition status", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "status", "updated_at" ], "title": "JobRequisition", "type": "object" }, "job_requisition_id": { "description": "ID for the job requisition the headcount is associated with", "type": "string" }, "level": { "description": "Level the headcount is assigned to\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "description": { "description": "The description of the level.", "type": "string" }, "experience_requirements": { "description": "The experience requirements for the level.", "type": "string" }, "global_level": { "anyOf": [ { "description": "Global level is used to track the seniority of levels. The higher up a level is placed on the page, the more senior and higher-ranked the level. Global level is used in workflows, policies, and reports that use the level attribute (e.g., you can use Level Lookup to set up a workflow that notifies the nearest person in an worker's management chain at or above the specified level).", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the level. Must be unique within the company or organization.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLevel", "description": "The parent level.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent level.", "type": "string" }, "rank": { "anyOf": [ { "description": "The rank of the level within its track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "scope_of_responsibilities": { "description": "The scope of responsibilities for the level.", "type": "string" }, "track": { "description": "The track associated with the level, if it's not a global level.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_default": { "description": "Whether this is the company's default track.", "type": "boolean" }, "name": { "description": "The name of the track. Must be unique within the company or organization.", "type": "string" }, "order": { "anyOf": [ { "description": "The one-based horizontal display order of the track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "start_global_level": { "anyOf": [ { "description": "The highest global level occupied by this track. Empty tracks return null.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Track", "type": "object" }, "track_id": { "description": "The track associated with the level. Required during creation. Include global_level when changing it.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Level", "type": "object" }, "level_id": { "description": "ID for the level the headcount is assigned to", "type": "string" }, "location_factor": { "description": "Location factor assigned to this headcount\n\nExpandable field", "properties": { "adjustment_factor": { "anyOf": [ { "description": "Compensation adjustment percentage", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "country": { "description": "Country information set to the country code", "properties": { "code": { "description": "The code of the country.", "type": "string" } }, "required": [ "code" ], "title": "Country", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "display_name": { "description": "Human-readable name for the location factor", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "labour_bucket": { "description": "The labor market category (e.g., \"Engineering\", \"Marketing\", \"Sales\")", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "LocationFactor", "type": "object" }, "location_factor_id": { "description": "ID for the location factor the headcount is assigned to", "type": "string" }, "notes": { "description": "Headcount notes", "type": "string" }, "position_id": { "description": "Position name for the headcount, for ex PID100037", "type": "string" }, "position_sub_type": { "description": "More granular classification of headcount position type. `NEW` New headcount created, typically paired with the OPEN_HEADCOUNT type. `BACKFILL` Replacement headcount for someone who left the company. `FORECASTED_ATTRITION` Headcount that does not count toward the budget, also known as provisional position in the application, `HIRING_STAGE` Person is going through the hiring process, paired with the FUTURE_START type. `OFFER_STAGE` Offer has been extended to a candidate, awaiting their decision. Paired with the FUTURE_START type. `OFFER_ACCEPTED` Candidate has accepted the offer but has not yet started. Paired with the FUTURE_START type. `PLAN_CHANGE` Headcount status changed due to business decision. Paired with CLOSED type. `TERMINATED` Role was filled, but the employee was separated from the company. Paired with CLOSED type. `TRANSFERRED` Employee moved internally to another role. Paired with CLOSED type.", "type": "string" }, "position_type": { "description": "Type of headcount position. `OPEN_HEADCOUNT` A headcount position that's not yet filled. `FUTURE_START` Headcount where a candidate is going through the hiring process, or an offer has been accepted, but the person has not yet started. `ACTIVE` Headcount where a candidate has been hired and started. `CLOSED` Headcount that's no longer available to fill.", "type": "string" }, "priority": { "description": "Priority assigned to this headcount\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "Display name of the headcount priority", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "HeadcountPriority", "type": "object" }, "priority_id": { "description": "ID for the headcount priority", "type": "string" }, "recruiter": { "description": "Recruiter working on filling the position\n\nExpandable field", "properties": { "business_partners": { "description": "Worker's assigned business partners. This field is only populated when explicitly requested via the expand parameter (e.g., ?expand=business_partners). When expanded, returns an empty list ([]) if the worker has no business partners.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiBusinessPartner77b00a069c32" }, "type": "array" }, "business_partners_id": { "description": "Worker's assigned business partners unique identifiers. Returns an empty list ([]) if the worker has no business partners.", "items": { "type": "string" }, "type": "array" }, "citizenship": { "description": "The countries that the worker has citizenship in.", "type": "string" }, "compensation": { "description": "The compensation package for the worker.\n\nExpandable field", "properties": { "annual_compensation": { "description": "The worker's annual compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "annual_salary_equivalent": { "description": "The worker's annual salary equivalent, for insurance purposes. It will be equal to the worker's annual compensation, except for owners that are receiving no cashcompensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "bonus_schedule": { "description": "The worker's bonus schedule.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "hourly_wage": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "id": { "description": "Identifier field", "type": "string" }, "monthly_compensation": { "description": "The worker's monthly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "on_target_commission": { "description": "The worker's on-target commission.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "payment_terms": { "description": "The payment terms for an worker's compensation.", "type": "string" }, "payment_type": { "description": "The payment type for an worker's compensation.", "type": "string" }, "relocation_reimbursement": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "salary_effective_date": { "description": "Salary effective date", "type": "string" }, "signing_bonus": { "description": "The worker's signing bonus.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus": { "description": "The worker's target annual bonus amount.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus_percent": { "anyOf": [ { "description": "The worker's target annual bonus as a percent of annual compensation.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" }, "weekly_compensation": { "description": "The worker's weekly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "worker": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's details.\n\nExpandable field", "type": "object" }, "worker_id": { "description": "The worker's ID.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Compensation", "type": "object" }, "compensation_grade": { "description": "The compensation grade assigned to the worker, if any.", "properties": { "id": { "description": "The compensation grade's unique identifier.", "type": "string" }, "label": { "description": "The compensation grade's label.", "type": "string" } }, "title": "WorkerCompensationGrade", "type": "object" }, "compensation_id": { "description": "The compensation package for the worker.", "type": "string" }, "country": { "description": "The worker's country.", "type": "string" }, "country_fields": { "description": "Country level fields for the worker.", "properties": { "ca": { "description": "Country-wise regional fields for Canada", "properties": { "sin": { "description": "Social Insurance Number (SIN) for Canada employees.", "type": "string" } }, "title": "CanadaFields", "type": "object" }, "nz": { "description": "Country-wise regional fields for New Zealand", "properties": { "ird_number": { "description": "Inland Revenue Department (IRD) number for New Zealand employees.", "type": "string" } }, "title": "NewZealandFields", "type": "object" }, "us": { "description": "Country-wise regional fields for USA", "properties": { "ssn": { "description": "Social Security Number (SSN) for US employees.", "type": "string" } }, "title": "USFields", "type": "object" } }, "title": "CountryFields", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "custom_fields": { "description": "Custom field values defined on the Employee object for this worker\n\nExpandable field", "items": { "additionalProperties": {} }, "type": "array" }, "date_of_birth": { "description": "The worker's date of birth.", "type": "string" }, "department": { "description": "The worker's assigned department.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "department_hierarchy": { "description": "List of departments in the department hierarchy. Refer department_hierarchy_ids for department hierarchy order.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestDepartment" }, "type": "array" }, "department_hierarchy_id": { "description": "The identifier of departments in the department hierarchy ordered from parent department to child department.", "items": { "type": "string" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the department.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestDepartment", "description": "The parent department.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent department.", "type": "string" }, "reference_code": { "description": "Reference code of the department.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Department", "type": "object" }, "department_id": { "description": "The worker's assigned department.", "type": "string" }, "employment_type": { "description": "The worker's employment type.\n\nExpandable field", "properties": { "amount_worked": { "description": "The amount worked for the employment type. * `FULL-TIME`: Full-time is at least 30 hours per week. Full-time workers will typically be eligible for benefits. * `PART-TIME`: Part-time is less than 30 hours per week. These workers may be eligible for benefits, depending on company settings and hours worked. * `TEMPORARY`: These workers are hired on a temporary basis. You can specify how each worker with this employment type will be paid individually.", "type": "string" }, "compensation_time_period": { "description": "The compensation period for the employment type. * `SALARIED`: Employees that are paid a fixed amount per year. * `HOURLY`: Employees that are paid a wage per hour worked.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "label": { "description": "The display label of the employment type.", "type": "string" }, "name": { "description": "The name of the employment type for non-custom employment types.", "type": "string" }, "type": { "description": "The classification of the worker by the company. * `CONTRACTOR`: Contractors are self-employed workers who provide services on a short-term or per-project basis and are not eligible for tax-withholding or benefits. * `EMPLOYEE`: Employees are hired and managed by an employer, work under the employer's direct supervision and control, and are protected by law for wages and employment rights.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "label", "updated_at" ], "title": "CompanyEmploymentType", "type": "object" }, "employment_type_id": { "description": "The worker's employment type.", "type": "string" }, "end_date": { "description": "The end date of the worker.", "type": "string" }, "ethnicity": { "description": "The identified ethnicity of the worker, if specified.", "type": "string" }, "gender": { "description": "The gender of the worker, if specified.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_manager": { "description": "Whether the worker is a manager", "type": "boolean" }, "job_function": { "description": "The worker's job function. When expanded, this field requires `job-functions.read`.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "Displayed name of the job function", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "JobFunction", "type": "object" }, "job_function_id": { "description": "ID of the worker's job function.", "type": "string" }, "legal_entity": { "description": "The worker's associated legal entity.\n\nExpandable field", "properties": { "company": { "description": "The company or organization associated with the legal entity\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "doing_business_as_name": { "description": "The doing business as name for the company.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_entities": { "description": "A list of the company's entities.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestLegalEntity" }, "type": "array" }, "legal_entities_id": { "description": "A list of the company's entities.", "items": { "type": "string" }, "type": "array" }, "legal_name": { "description": "The legal name of the company.", "type": "string" }, "name": { "description": "The name of the company.", "type": "string" }, "parent_legal_entity": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The company's ultimate holding entity.\n\nExpandable field", "type": "object" }, "parent_legal_entity_id": { "description": "The company's ultimate holding entity.", "type": "string" }, "phone": { "description": "The phone number for the company.", "type": "string" }, "physical_address": { "description": "The physical address of the holding entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "primary_email": { "description": "The email address used when registering this company.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "legal_entities", "legal_entities_id", "name", "updated_at" ], "title": "Company", "type": "object" }, "company_id": { "description": "The company or organization associated with the legal entity", "type": "string" }, "country": { "description": "The country the legal entity is based in.", "properties": { "code": { "description": "The code of the country.", "type": "string" } }, "required": [ "code" ], "title": "Country", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "entity_level": { "description": "The legal entity's level in a hierarchy. * `PARENT`: The legal entity is considered the ultimate holding entity. * `SUBSIDIARY`: The legal entity is considered a subsidiary, fully or partially held by another. * `BRANCH`: The legal entity is considered a branch, associated with a parent legal entity.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_name": { "description": "The legal name of the legal entity.", "type": "string" }, "mailing_address": { "description": "The mailing address of the legal entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "management_type": { "description": "The legal entity management type in the case of an employer of record (EOR) or professional employment organization (PEO). * `PEO`: The legal entity is considered a Professional Employment Organization (PEO). * `EOR`: The legal entity is considered an Employer of Record (EOR).", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The parent legal entity.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent legal entity.", "type": "string" }, "physical_address": { "description": "The physical address of the legal entity, if it differs from the mailing address.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "registration_date": { "description": "The registration date of the entity.", "type": "string" }, "tax_identifier": { "description": "The tax identifier for the legal entity.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "LegalEntity", "type": "object" }, "legal_entity_id": { "description": "The worker's associated legal entity.", "type": "string" }, "level": { "description": "The level of the worker.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "description": { "description": "The description of the level.", "type": "string" }, "experience_requirements": { "description": "The experience requirements for the level.", "type": "string" }, "global_level": { "anyOf": [ { "description": "Global level is used to track the seniority of levels. The higher up a level is placed on the page, the more senior and higher-ranked the level. Global level is used in workflows, policies, and reports that use the level attribute (e.g., you can use Level Lookup to set up a workflow that notifies the nearest person in an worker's management chain at or above the specified level).", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the level. Must be unique within the company or organization.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLevel", "description": "The parent level.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent level.", "type": "string" }, "rank": { "anyOf": [ { "description": "The rank of the level within its track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "scope_of_responsibilities": { "description": "The scope of responsibilities for the level.", "type": "string" }, "track": { "description": "The track associated with the level, if it's not a global level.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_default": { "description": "Whether this is the company's default track.", "type": "boolean" }, "name": { "description": "The name of the track. Must be unique within the company or organization.", "type": "string" }, "order": { "anyOf": [ { "description": "The one-based horizontal display order of the track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "start_global_level": { "anyOf": [ { "description": "The highest global level occupied by this track. Empty tracks return null.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Track", "type": "object" }, "track_id": { "description": "The track associated with the level. Required during creation. Include global_level when changing it.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Level", "type": "object" }, "level_id": { "description": "The level of the worker.", "type": "string" }, "location": { "description": "The location that the worker is mapped to for tax purposes. In the case that a worker is remote, the location's type is remote.", "properties": { "type": { "description": "The type of location.", "type": "string" }, "work_location_id": { "description": "The work location, if the worker isn't remote.", "type": "string" } }, "required": [ "type", "work_location_id" ], "title": "WorkerLocation", "type": "object" }, "manager": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's manager.\n\nExpandable field", "type": "object" }, "manager_id": { "description": "The worker's manager.", "type": "string" }, "number": { "anyOf": [ { "description": "The worker's number within the organization.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "original_start_date": { "description": "The worker's earliest start date across their employment history, excluding INIT roles.", "type": "string" }, "overtime_exemption": { "description": "The worker's overtime exemption status.", "type": "string" }, "pay_schedule_id": { "description": "The ID of the pay schedule currently associated with the worker.", "type": "string" }, "personal_email": { "description": "The worker's associated personal email address.", "type": "string" }, "race": { "description": "The identified race of the worker, if specified.", "type": "string" }, "start_date": { "description": "The start date of the worker.", "type": "string" }, "status": { "description": "The worker's status within the organization.", "type": "string" }, "teams": { "description": "The worker's assigned teams.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiTeamcb26bc28f32f" }, "type": "array" }, "teams_id": { "description": "The worker's assigned teams.", "items": { "type": "string" }, "type": "array" }, "termination_details": { "description": "The details of the worker's termination, if applicable.", "properties": { "reason": { "description": "This is a description that will be custom to each Rippling company.", "type": "string" }, "type": { "description": "The termination type indicates whether the termination was voluntary or involuntary.", "type": "string" } }, "title": "TerminationDetails", "type": "object" }, "title": { "description": "The worker's title.", "type": "string" }, "title_effective_date": { "description": "Title effective date", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "user": { "description": "The worker's associated user.\n\nExpandable field", "properties": { "active": { "description": "Whether the user is able to access company resources, typically when they are in actively engaged with the company and not after off-boarding.", "type": "boolean" }, "addresses": { "description": "The user's addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiUserAddressedd59b9ba9a1" }, "type": "array" }, "created_at": { "description": "Record creation date", "type": "string" }, "display_name": { "description": "The display name of the user using either the concatenated preferred given and family name or username depending on availability.", "type": "string" }, "emails": { "description": "The user's email addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiEmail5284c8258dc3" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "locale": { "description": "The User's default location for purposes of localization of currency, date time format, or numerical representations pursuant to RFC5646.", "type": "string" }, "name": { "description": "The user's name.", "properties": { "family_name": { "description": "The legal family name of the user, or last name in most Western languages.", "type": "string" }, "formatted": { "description": "The user's full name.", "type": "string" }, "given_name": { "description": "The given legal name of the user, or first name in most Western languages.", "type": "string" }, "middle_name": { "description": "The middle name(s) of the user.", "type": "string" }, "preferred_family_name": { "description": "The preferred family name, or last name in most Western languages, by the user.", "type": "string" }, "preferred_given_name": { "description": "The preferred given name, or first name in most Western languages, by the user.", "type": "string" } }, "title": "UserName", "type": "object" }, "number": { "description": "The permanent profile number of the user.", "type": "string" }, "phone_numbers": { "description": "The user's phone numbers.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoneNumber12060c61ecf5" }, "type": "array" }, "photos": { "description": "The user's photos.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoto2be7c3ae3f39" }, "type": "array" }, "preferred_language": { "description": "The User's preferred written or spoken language in the same format of the HTTP Accept-Language header, pursuant to Section 5.3.5 of RFC7231.", "type": "string" }, "timezone": { "description": "The User's current time zone in IANA database Olson format", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "username": { "description": "The unique identifier across Rippling used by the User for direct authentication into their associated company. Globally unique.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "User", "type": "object" }, "user_id": { "description": "The worker's associated user.", "type": "string" }, "work_email": { "description": "The worker's associated work email address.", "type": "string" }, "work_schedule": { "additionalProperties": { "$ref": "#/components/schemas/OutputRestApiWorkScheduleDay938f88d94f20" }, "description": "The worker's scheduled working hours for each day of the week.", "type": "object" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Worker", "type": "object" }, "recruiter_id": { "description": "ID for the recruiter working on filling the position", "type": "string" }, "target_start_date": { "description": "The estimated start date when the position was first created", "type": "string" }, "teams": { "description": "Teams the headcount belongs to\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiTeamcb26bc28f32f" }, "type": "array" }, "teams_id": { "description": "IDs for the teams the headcount belongs to", "items": { "type": "string" }, "type": "array" }, "title": { "description": "Job title for the position. For a vacant headcount position, this can be defined on creation. Once the position is occupied, it’s synched from the associated worker’s job title.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "work_location": { "description": "Work location the headcount is assigned to\n\nExpandable field", "properties": { "address": { "description": "The address for the work location.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the work location.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "address", "created_at", "id", "name", "updated_at" ], "title": "WorkLocation", "type": "object" }, "work_location_id": { "description": "ID for the work location the headcount is assigned to", "type": "string" }, "worker": { "description": "Worker hired into the headcount\n\nExpandable field", "properties": { "business_partners": { "description": "Worker's assigned business partners. This field is only populated when explicitly requested via the expand parameter (e.g., ?expand=business_partners). When expanded, returns an empty list ([]) if the worker has no business partners.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiBusinessPartner77b00a069c32" }, "type": "array" }, "business_partners_id": { "description": "Worker's assigned business partners unique identifiers. Returns an empty list ([]) if the worker has no business partners.", "items": { "type": "string" }, "type": "array" }, "citizenship": { "description": "The countries that the worker has citizenship in.", "type": "string" }, "compensation": { "description": "The compensation package for the worker.\n\nExpandable field", "properties": { "annual_compensation": { "description": "The worker's annual compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "annual_salary_equivalent": { "description": "The worker's annual salary equivalent, for insurance purposes. It will be equal to the worker's annual compensation, except for owners that are receiving no cashcompensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "bonus_schedule": { "description": "The worker's bonus schedule.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "hourly_wage": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "id": { "description": "Identifier field", "type": "string" }, "monthly_compensation": { "description": "The worker's monthly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "on_target_commission": { "description": "The worker's on-target commission.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "payment_terms": { "description": "The payment terms for an worker's compensation.", "type": "string" }, "payment_type": { "description": "The payment type for an worker's compensation.", "type": "string" }, "relocation_reimbursement": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "salary_effective_date": { "description": "Salary effective date", "type": "string" }, "signing_bonus": { "description": "The worker's signing bonus.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus": { "description": "The worker's target annual bonus amount.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus_percent": { "anyOf": [ { "description": "The worker's target annual bonus as a percent of annual compensation.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" }, "weekly_compensation": { "description": "The worker's weekly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "worker": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's details.\n\nExpandable field", "type": "object" }, "worker_id": { "description": "The worker's ID.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Compensation", "type": "object" }, "compensation_grade": { "description": "The compensation grade assigned to the worker, if any.", "properties": { "id": { "description": "The compensation grade's unique identifier.", "type": "string" }, "label": { "description": "The compensation grade's label.", "type": "string" } }, "title": "WorkerCompensationGrade", "type": "object" }, "compensation_id": { "description": "The compensation package for the worker.", "type": "string" }, "country": { "description": "The worker's country.", "type": "string" }, "country_fields": { "description": "Country level fields for the worker.", "properties": { "ca": { "description": "Country-wise regional fields for Canada", "properties": { "sin": { "description": "Social Insurance Number (SIN) for Canada employees.", "type": "string" } }, "title": "CanadaFields", "type": "object" }, "nz": { "description": "Country-wise regional fields for New Zealand", "properties": { "ird_number": { "description": "Inland Revenue Department (IRD) number for New Zealand employees.", "type": "string" } }, "title": "NewZealandFields", "type": "object" }, "us": { "description": "Country-wise regional fields for USA", "properties": { "ssn": { "description": "Social Security Number (SSN) for US employees.", "type": "string" } }, "title": "USFields", "type": "object" } }, "title": "CountryFields", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "custom_fields": { "description": "Custom field values defined on the Employee object for this worker\n\nExpandable field", "items": { "additionalProperties": {} }, "type": "array" }, "date_of_birth": { "description": "The worker's date of birth.", "type": "string" }, "department": { "description": "The worker's assigned department.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "department_hierarchy": { "description": "List of departments in the department hierarchy. Refer department_hierarchy_ids for department hierarchy order.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestDepartment" }, "type": "array" }, "department_hierarchy_id": { "description": "The identifier of departments in the department hierarchy ordered from parent department to child department.", "items": { "type": "string" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the department.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestDepartment", "description": "The parent department.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent department.", "type": "string" }, "reference_code": { "description": "Reference code of the department.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Department", "type": "object" }, "department_id": { "description": "The worker's assigned department.", "type": "string" }, "employment_type": { "description": "The worker's employment type.\n\nExpandable field", "properties": { "amount_worked": { "description": "The amount worked for the employment type. * `FULL-TIME`: Full-time is at least 30 hours per week. Full-time workers will typically be eligible for benefits. * `PART-TIME`: Part-time is less than 30 hours per week. These workers may be eligible for benefits, depending on company settings and hours worked. * `TEMPORARY`: These workers are hired on a temporary basis. You can specify how each worker with this employment type will be paid individually.", "type": "string" }, "compensation_time_period": { "description": "The compensation period for the employment type. * `SALARIED`: Employees that are paid a fixed amount per year. * `HOURLY`: Employees that are paid a wage per hour worked.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "label": { "description": "The display label of the employment type.", "type": "string" }, "name": { "description": "The name of the employment type for non-custom employment types.", "type": "string" }, "type": { "description": "The classification of the worker by the company. * `CONTRACTOR`: Contractors are self-employed workers who provide services on a short-term or per-project basis and are not eligible for tax-withholding or benefits. * `EMPLOYEE`: Employees are hired and managed by an employer, work under the employer's direct supervision and control, and are protected by law for wages and employment rights.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "label", "updated_at" ], "title": "CompanyEmploymentType", "type": "object" }, "employment_type_id": { "description": "The worker's employment type.", "type": "string" }, "end_date": { "description": "The end date of the worker.", "type": "string" }, "ethnicity": { "description": "The identified ethnicity of the worker, if specified.", "type": "string" }, "gender": { "description": "The gender of the worker, if specified.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_manager": { "description": "Whether the worker is a manager", "type": "boolean" }, "job_function": { "description": "The worker's job function. When expanded, this field requires `job-functions.read`.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "Displayed name of the job function", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "JobFunction", "type": "object" }, "job_function_id": { "description": "ID of the worker's job function.", "type": "string" }, "legal_entity": { "description": "The worker's associated legal entity.\n\nExpandable field", "properties": { "company": { "description": "The company or organization associated with the legal entity\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "doing_business_as_name": { "description": "The doing business as name for the company.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_entities": { "description": "A list of the company's entities.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestLegalEntity" }, "type": "array" }, "legal_entities_id": { "description": "A list of the company's entities.", "items": { "type": "string" }, "type": "array" }, "legal_name": { "description": "The legal name of the company.", "type": "string" }, "name": { "description": "The name of the company.", "type": "string" }, "parent_legal_entity": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The company's ultimate holding entity.\n\nExpandable field", "type": "object" }, "parent_legal_entity_id": { "description": "The company's ultimate holding entity.", "type": "string" }, "phone": { "description": "The phone number for the company.", "type": "string" }, "physical_address": { "description": "The physical address of the holding entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "primary_email": { "description": "The email address used when registering this company.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "legal_entities", "legal_entities_id", "name", "updated_at" ], "title": "Company", "type": "object" }, "company_id": { "description": "The company or organization associated with the legal entity", "type": "string" }, "country": { "description": "The country the legal entity is based in.", "properties": { "code": { "description": "The code of the country.", "type": "string" } }, "required": [ "code" ], "title": "Country", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "entity_level": { "description": "The legal entity's level in a hierarchy. * `PARENT`: The legal entity is considered the ultimate holding entity. * `SUBSIDIARY`: The legal entity is considered a subsidiary, fully or partially held by another. * `BRANCH`: The legal entity is considered a branch, associated with a parent legal entity.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_name": { "description": "The legal name of the legal entity.", "type": "string" }, "mailing_address": { "description": "The mailing address of the legal entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "management_type": { "description": "The legal entity management type in the case of an employer of record (EOR) or professional employment organization (PEO). * `PEO`: The legal entity is considered a Professional Employment Organization (PEO). * `EOR`: The legal entity is considered an Employer of Record (EOR).", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The parent legal entity.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent legal entity.", "type": "string" }, "physical_address": { "description": "The physical address of the legal entity, if it differs from the mailing address.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "registration_date": { "description": "The registration date of the entity.", "type": "string" }, "tax_identifier": { "description": "The tax identifier for the legal entity.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "LegalEntity", "type": "object" }, "legal_entity_id": { "description": "The worker's associated legal entity.", "type": "string" }, "level": { "description": "The level of the worker.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "description": { "description": "The description of the level.", "type": "string" }, "experience_requirements": { "description": "The experience requirements for the level.", "type": "string" }, "global_level": { "anyOf": [ { "description": "Global level is used to track the seniority of levels. The higher up a level is placed on the page, the more senior and higher-ranked the level. Global level is used in workflows, policies, and reports that use the level attribute (e.g., you can use Level Lookup to set up a workflow that notifies the nearest person in an worker's management chain at or above the specified level).", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the level. Must be unique within the company or organization.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLevel", "description": "The parent level.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent level.", "type": "string" }, "rank": { "anyOf": [ { "description": "The rank of the level within its track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "scope_of_responsibilities": { "description": "The scope of responsibilities for the level.", "type": "string" }, "track": { "description": "The track associated with the level, if it's not a global level.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_default": { "description": "Whether this is the company's default track.", "type": "boolean" }, "name": { "description": "The name of the track. Must be unique within the company or organization.", "type": "string" }, "order": { "anyOf": [ { "description": "The one-based horizontal display order of the track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "start_global_level": { "anyOf": [ { "description": "The highest global level occupied by this track. Empty tracks return null.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Track", "type": "object" }, "track_id": { "description": "The track associated with the level. Required during creation. Include global_level when changing it.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Level", "type": "object" }, "level_id": { "description": "The level of the worker.", "type": "string" }, "location": { "description": "The location that the worker is mapped to for tax purposes. In the case that a worker is remote, the location's type is remote.", "properties": { "type": { "description": "The type of location.", "type": "string" }, "work_location_id": { "description": "The work location, if the worker isn't remote.", "type": "string" } }, "required": [ "type", "work_location_id" ], "title": "WorkerLocation", "type": "object" }, "manager": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's manager.\n\nExpandable field", "type": "object" }, "manager_id": { "description": "The worker's manager.", "type": "string" }, "number": { "anyOf": [ { "description": "The worker's number within the organization.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "original_start_date": { "description": "The worker's earliest start date across their employment history, excluding INIT roles.", "type": "string" }, "overtime_exemption": { "description": "The worker's overtime exemption status.", "type": "string" }, "pay_schedule_id": { "description": "The ID of the pay schedule currently associated with the worker.", "type": "string" }, "personal_email": { "description": "The worker's associated personal email address.", "type": "string" }, "race": { "description": "The identified race of the worker, if specified.", "type": "string" }, "start_date": { "description": "The start date of the worker.", "type": "string" }, "status": { "description": "The worker's status within the organization.", "type": "string" }, "teams": { "description": "The worker's assigned teams.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiTeamcb26bc28f32f" }, "type": "array" }, "teams_id": { "description": "The worker's assigned teams.", "items": { "type": "string" }, "type": "array" }, "termination_details": { "description": "The details of the worker's termination, if applicable.", "properties": { "reason": { "description": "This is a description that will be custom to each Rippling company.", "type": "string" }, "type": { "description": "The termination type indicates whether the termination was voluntary or involuntary.", "type": "string" } }, "title": "TerminationDetails", "type": "object" }, "title": { "description": "The worker's title.", "type": "string" }, "title_effective_date": { "description": "Title effective date", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "user": { "description": "The worker's associated user.\n\nExpandable field", "properties": { "active": { "description": "Whether the user is able to access company resources, typically when they are in actively engaged with the company and not after off-boarding.", "type": "boolean" }, "addresses": { "description": "The user's addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiUserAddressedd59b9ba9a1" }, "type": "array" }, "created_at": { "description": "Record creation date", "type": "string" }, "display_name": { "description": "The display name of the user using either the concatenated preferred given and family name or username depending on availability.", "type": "string" }, "emails": { "description": "The user's email addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiEmail5284c8258dc3" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "locale": { "description": "The User's default location for purposes of localization of currency, date time format, or numerical representations pursuant to RFC5646.", "type": "string" }, "name": { "description": "The user's name.", "properties": { "family_name": { "description": "The legal family name of the user, or last name in most Western languages.", "type": "string" }, "formatted": { "description": "The user's full name.", "type": "string" }, "given_name": { "description": "The given legal name of the user, or first name in most Western languages.", "type": "string" }, "middle_name": { "description": "The middle name(s) of the user.", "type": "string" }, "preferred_family_name": { "description": "The preferred family name, or last name in most Western languages, by the user.", "type": "string" }, "preferred_given_name": { "description": "The preferred given name, or first name in most Western languages, by the user.", "type": "string" } }, "title": "UserName", "type": "object" }, "number": { "description": "The permanent profile number of the user.", "type": "string" }, "phone_numbers": { "description": "The user's phone numbers.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoneNumber12060c61ecf5" }, "type": "array" }, "photos": { "description": "The user's photos.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoto2be7c3ae3f39" }, "type": "array" }, "preferred_language": { "description": "The User's preferred written or spoken language in the same format of the HTTP Accept-Language header, pursuant to Section 5.3.5 of RFC7231.", "type": "string" }, "timezone": { "description": "The User's current time zone in IANA database Olson format", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "username": { "description": "The unique identifier across Rippling used by the User for direct authentication into their associated company. Globally unique.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "User", "type": "object" }, "user_id": { "description": "The worker's associated user.", "type": "string" }, "work_email": { "description": "The worker's associated work email address.", "type": "string" }, "work_schedule": { "additionalProperties": { "$ref": "#/components/schemas/OutputRestApiWorkScheduleDay938f88d94f20" }, "description": "The worker's scheduled working hours for each day of the week.", "type": "object" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Worker", "type": "object" }, "worker_id": { "description": "ID for the worker hired into the headcount", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "HeadcountPosition", "type": "object" }, "OutputRestApiHeadcountPriority8e286a534c4f": { "description": "", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "Display name of the headcount priority", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "HeadcountPriority", "type": "object" }, "OutputRestApiHireItemError2f7393088d4c": { "additionalProperties": false, "description": "", "properties": { "code": { "description": "Machine-readable error code.", "type": "string" }, "field": { "description": "Public field path when the error is field-scoped.", "type": "string" }, "message": { "description": "Human-readable error message.", "type": "string" } }, "required": [ "code", "message" ], "title": "HireItemError", "type": "object" }, "OutputRestApiHireNextAction10d6f09e766f": { "additionalProperties": false, "description": "", "properties": { "code": { "description": "Machine-readable next action. Supported values:\n\n- `continue_existing_hire`: Continue the matching in-progress hire.\n- `provide_rehire_choice`: Choose how to rehire the matching former worker.\n\nWhen Auto-Hire is enabled and blocked or fails to start:\n\n- `assign_device_in_rippling`: Assign a device in Rippling.\n- `provide_document_values`: Complete missing document details.\n- `review_devices_in_rippling`: Review devices in Rippling.\n- `review_documents_in_rippling`: Review documents in Rippling.\n- `review_work_email_in_rippling`: Review work email in Rippling.\n- `review_work_pattern_in_rippling`: Review the work pattern in Rippling.\n- `review_retirement_in_rippling`: Review retirement enrollment in Rippling.\n- `configure_offer_notification`: Configure the offer notification.\n- `provide_missing_hire_input`: Complete missing hire details.\n- `review_hire_in_rippling`: Review the hire in Rippling.\n- `resolve_hire_issue_in_rippling`: Resolve the hire issue in Rippling.", "type": "string" }, "target_id": { "description": "Role id the caller should continue, when applicable.", "type": "string" } }, "required": [ "code" ], "title": "HireNextAction", "type": "object" }, "OutputRestApiHireRequirementsResponse9d2e8d2e72a5": { "additionalProperties": false, "description": "Public GET /hire-requirements/ body. Shape matches hiring's catalog JSON.", "properties": { "country_code": { "description": "ISO 3166-1 alpha-2 country code used for the lookup.", "type": "string" }, "fields_by_group": { "description": "Hiring-owned field catalog grouped by request section.", "type": "array" }, "hire_type": { "description": "Hire type for this catalog. POST /hires/ uses the same value. An omitted POST value defaults to direct_hire.", "type": "string" }, "required_groups": { "description": "Groups you must send for this country.", "items": { "type": "string" }, "type": "array" }, "requirements_version": { "description": "Baseline requirement contract version for this selector tuple.", "type": "string" }, "unsupported_fields": { "description": "Public field paths that are not writable for this selector tuple.", "items": { "type": "string" }, "type": "array" }, "warnings": { "description": "Non-fatal warnings for this lookup.", "items": { "type": "string" }, "type": "array" } }, "required": [ "country_code", "fields_by_group", "hire_type", "required_groups", "requirements_version" ], "title": "HireRequirementsResponse", "type": "object" }, "OutputRestApiHireResultf759f93b6e74": { "additionalProperties": false, "description": "", "properties": { "client_request_id": { "description": "Echo of the caller-supplied item id.", "type": "string" }, "errors": { "description": "Structured item errors using the same public field paths as GET /hire-requirements/.", "items": { "$ref": "#/components/schemas/OutputRestApiHireItemError2f7393088d4c" }, "type": "array" }, "existing_role_id": { "description": "Matching existing role id for duplicate or rehire conflicts.", "type": "string" }, "id": { "description": "Rippling hire role id when a role exists.", "type": "string" }, "missing_required_fields": { "description": "Public field paths still required before review.", "items": { "type": "string" }, "type": "array" }, "next_actions": { "description": "Actions for duplicate, rehire, or Auto-Hire failures and blockers.", "items": { "$ref": "#/components/schemas/OutputRestApiHireNextAction10d6f09e766f" }, "type": "array" }, "pending_fields": { "description": "Accepted public field paths not yet active because progression is blocked.", "items": { "type": "string" }, "type": "array" }, "status": { "description": "ready_for_review, auto_hire_processing, incomplete, or failed. auto_hire_processing includes hires awaiting approval or asynchronous completion.", "type": "string" } }, "required": [ "status" ], "title": "HireResult", "type": "object" }, "OutputRestApiInboundEmailTriggera580510d7eb3": { "additionalProperties": false, "properties": { "body_contains": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_attachment": { "default": false, "type": "boolean" }, "kind": { "type": "string" }, "recipient_email": { "type": "string" }, "subject_contains": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "kind", "recipient_email" ], "title": "InboundEmailTrigger", "type": "object" }, "OutputRestApiJobAssignment92ce85414dcb": { "description": "", "properties": { "base_pay_rate": { "anyOf": [ { "description": "Base compensation rate of worker", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "job_code": { "description": "Job that is assigned to worker\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "custom_location": { "description": "The custom location of the job code. This location will be used for tax calculation purposes if using US Payroll when an employee is working at this job code.", "properties": { "address": { "description": "The address of the custom location.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" } }, "required": [ "address" ], "title": "CustomLocation", "type": "object" }, "department": { "description": "The department associated with the job code.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "department_hierarchy": { "description": "List of departments in the department hierarchy. Refer department_hierarchy_ids for department hierarchy order.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestDepartment" }, "type": "array" }, "department_hierarchy_id": { "description": "The identifier of departments in the department hierarchy ordered from parent department to child department.", "items": { "type": "string" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the department.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestDepartment", "description": "The parent department.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent department.", "type": "string" }, "reference_code": { "description": "Reference code of the department.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Department", "type": "object" }, "department_id": { "description": "The department associated with the job code.", "type": "string" }, "external_id": { "description": "The unique identifier of the job code in an outside system.", "type": "string" }, "group_id": { "description": "The ID of the job roster group.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_archived": { "description": "Whether this job code is archived. Set to true via PATCH to archive. Archiving is irreversible via this API.", "type": "boolean" }, "job_dimension": { "description": "The job dimension this job code belongs to.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "external_id": { "description": "The unique identifier of the job dimension in a third party system", "type": "string" }, "group_id": { "description": "The ID of the dimension roster group.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "includes_custom_location": { "description": "Whether the job dimension includes codes related to a custom location. Only one dimension can have this set to true.", "type": "boolean" }, "name": { "description": "The name of the job dimension", "type": "string" }, "org_attribute_associations": { "description": "Organizational attributes associated with the job dimension. Only 'PAY_RATE' can be set or modified using POST or PATCH requests.", "items": {}, "type": "array" }, "roster_type": { "description": "The roster type of the dimension. PER_DIMENSION means that there is a group on the dimension level and employees within that group have access to all job codes in the dimension. PER_JOB_CODE means that each job code has its own group.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "JobDimension", "type": "object" }, "job_dimension_id": { "description": "The ID of the job dimension this job code belongs to.", "type": "string" }, "name": { "description": "The name of the job dimension.", "type": "string" }, "pay_rate": { "anyOf": [ { "description": "The pay rate for this job code. Only applicable if the associated job dimension includes the 'PAY_RATE' organizational attribute.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "pay_rate_exceptions": { "description": "Pay rate overrides for the job based on exception dimension values.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiJobPayRateExceptionaf426aa0ac14" }, "type": "array" }, "pay_rate_exceptions_id": { "description": "Pay rate overrides id for the job based on exception dimension values.", "items": { "type": "string" }, "type": "array" }, "updated_at": { "description": "Record update date", "type": "string" }, "work_location": { "description": "The work location associated with the job code.\n\nExpandable field", "properties": { "address": { "description": "The address for the work location.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the work location.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "address", "created_at", "id", "name", "updated_at" ], "title": "WorkLocation", "type": "object" }, "work_location_id": { "description": "The work location associated with the job code.", "type": "string" } }, "required": [ "created_at", "id", "job_dimension_id", "name", "updated_at" ], "title": "JobCode", "type": "object" }, "job_code_id": { "description": "Identifier of job that is assigned to worker", "type": "string" }, "job_pay_rate": { "anyOf": [ { "description": "The pay rate for job assigned to worker. This can be different from the job's standard pay rate and can be overriden for a worker.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "job_pay_rate_exceptions": { "description": "Pay rate exceptions applicable for the worker based on certain exception dimension values.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiJobPayRateException2b2788a4d92c" }, "type": "array" }, "job_pay_rate_exceptions_id": { "description": "Identifier of pay rate exceptions applicable for the worker based on certain exception dimension values.", "items": { "type": "string" }, "type": "array" }, "updated_at": { "description": "Record update date", "type": "string" }, "worker": { "description": "Worker to whom job is assigned.\n\nExpandable field", "properties": { "business_partners": { "description": "Worker's assigned business partners. This field is only populated when explicitly requested via the expand parameter (e.g., ?expand=business_partners). When expanded, returns an empty list ([]) if the worker has no business partners.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiBusinessPartner77b00a069c32" }, "type": "array" }, "business_partners_id": { "description": "Worker's assigned business partners unique identifiers. Returns an empty list ([]) if the worker has no business partners.", "items": { "type": "string" }, "type": "array" }, "citizenship": { "description": "The countries that the worker has citizenship in.", "type": "string" }, "compensation": { "description": "The compensation package for the worker.\n\nExpandable field", "properties": { "annual_compensation": { "description": "The worker's annual compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "annual_salary_equivalent": { "description": "The worker's annual salary equivalent, for insurance purposes. It will be equal to the worker's annual compensation, except for owners that are receiving no cashcompensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "bonus_schedule": { "description": "The worker's bonus schedule.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "hourly_wage": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "id": { "description": "Identifier field", "type": "string" }, "monthly_compensation": { "description": "The worker's monthly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "on_target_commission": { "description": "The worker's on-target commission.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "payment_terms": { "description": "The payment terms for an worker's compensation.", "type": "string" }, "payment_type": { "description": "The payment type for an worker's compensation.", "type": "string" }, "relocation_reimbursement": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "salary_effective_date": { "description": "Salary effective date", "type": "string" }, "signing_bonus": { "description": "The worker's signing bonus.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus": { "description": "The worker's target annual bonus amount.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus_percent": { "anyOf": [ { "description": "The worker's target annual bonus as a percent of annual compensation.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" }, "weekly_compensation": { "description": "The worker's weekly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "worker": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's details.\n\nExpandable field", "type": "object" }, "worker_id": { "description": "The worker's ID.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Compensation", "type": "object" }, "compensation_grade": { "description": "The compensation grade assigned to the worker, if any.", "properties": { "id": { "description": "The compensation grade's unique identifier.", "type": "string" }, "label": { "description": "The compensation grade's label.", "type": "string" } }, "title": "WorkerCompensationGrade", "type": "object" }, "compensation_id": { "description": "The compensation package for the worker.", "type": "string" }, "country": { "description": "The worker's country.", "type": "string" }, "country_fields": { "description": "Country level fields for the worker.", "properties": { "ca": { "description": "Country-wise regional fields for Canada", "properties": { "sin": { "description": "Social Insurance Number (SIN) for Canada employees.", "type": "string" } }, "title": "CanadaFields", "type": "object" }, "nz": { "description": "Country-wise regional fields for New Zealand", "properties": { "ird_number": { "description": "Inland Revenue Department (IRD) number for New Zealand employees.", "type": "string" } }, "title": "NewZealandFields", "type": "object" }, "us": { "description": "Country-wise regional fields for USA", "properties": { "ssn": { "description": "Social Security Number (SSN) for US employees.", "type": "string" } }, "title": "USFields", "type": "object" } }, "title": "CountryFields", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "custom_fields": { "description": "Custom field values defined on the Employee object for this worker\n\nExpandable field", "items": { "additionalProperties": {} }, "type": "array" }, "date_of_birth": { "description": "The worker's date of birth.", "type": "string" }, "department": { "description": "The worker's assigned department.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "department_hierarchy": { "description": "List of departments in the department hierarchy. Refer department_hierarchy_ids for department hierarchy order.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestDepartment" }, "type": "array" }, "department_hierarchy_id": { "description": "The identifier of departments in the department hierarchy ordered from parent department to child department.", "items": { "type": "string" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the department.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestDepartment", "description": "The parent department.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent department.", "type": "string" }, "reference_code": { "description": "Reference code of the department.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Department", "type": "object" }, "department_id": { "description": "The worker's assigned department.", "type": "string" }, "employment_type": { "description": "The worker's employment type.\n\nExpandable field", "properties": { "amount_worked": { "description": "The amount worked for the employment type. * `FULL-TIME`: Full-time is at least 30 hours per week. Full-time workers will typically be eligible for benefits. * `PART-TIME`: Part-time is less than 30 hours per week. These workers may be eligible for benefits, depending on company settings and hours worked. * `TEMPORARY`: These workers are hired on a temporary basis. You can specify how each worker with this employment type will be paid individually.", "type": "string" }, "compensation_time_period": { "description": "The compensation period for the employment type. * `SALARIED`: Employees that are paid a fixed amount per year. * `HOURLY`: Employees that are paid a wage per hour worked.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "label": { "description": "The display label of the employment type.", "type": "string" }, "name": { "description": "The name of the employment type for non-custom employment types.", "type": "string" }, "type": { "description": "The classification of the worker by the company. * `CONTRACTOR`: Contractors are self-employed workers who provide services on a short-term or per-project basis and are not eligible for tax-withholding or benefits. * `EMPLOYEE`: Employees are hired and managed by an employer, work under the employer's direct supervision and control, and are protected by law for wages and employment rights.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "label", "updated_at" ], "title": "CompanyEmploymentType", "type": "object" }, "employment_type_id": { "description": "The worker's employment type.", "type": "string" }, "end_date": { "description": "The end date of the worker.", "type": "string" }, "ethnicity": { "description": "The identified ethnicity of the worker, if specified.", "type": "string" }, "gender": { "description": "The gender of the worker, if specified.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_manager": { "description": "Whether the worker is a manager", "type": "boolean" }, "job_function": { "description": "The worker's job function. When expanded, this field requires `job-functions.read`.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "Displayed name of the job function", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "JobFunction", "type": "object" }, "job_function_id": { "description": "ID of the worker's job function.", "type": "string" }, "legal_entity": { "description": "The worker's associated legal entity.\n\nExpandable field", "properties": { "company": { "description": "The company or organization associated with the legal entity\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "doing_business_as_name": { "description": "The doing business as name for the company.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_entities": { "description": "A list of the company's entities.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestLegalEntity" }, "type": "array" }, "legal_entities_id": { "description": "A list of the company's entities.", "items": { "type": "string" }, "type": "array" }, "legal_name": { "description": "The legal name of the company.", "type": "string" }, "name": { "description": "The name of the company.", "type": "string" }, "parent_legal_entity": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The company's ultimate holding entity.\n\nExpandable field", "type": "object" }, "parent_legal_entity_id": { "description": "The company's ultimate holding entity.", "type": "string" }, "phone": { "description": "The phone number for the company.", "type": "string" }, "physical_address": { "description": "The physical address of the holding entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "primary_email": { "description": "The email address used when registering this company.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "legal_entities", "legal_entities_id", "name", "updated_at" ], "title": "Company", "type": "object" }, "company_id": { "description": "The company or organization associated with the legal entity", "type": "string" }, "country": { "description": "The country the legal entity is based in.", "properties": { "code": { "description": "The code of the country.", "type": "string" } }, "required": [ "code" ], "title": "Country", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "entity_level": { "description": "The legal entity's level in a hierarchy. * `PARENT`: The legal entity is considered the ultimate holding entity. * `SUBSIDIARY`: The legal entity is considered a subsidiary, fully or partially held by another. * `BRANCH`: The legal entity is considered a branch, associated with a parent legal entity.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_name": { "description": "The legal name of the legal entity.", "type": "string" }, "mailing_address": { "description": "The mailing address of the legal entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "management_type": { "description": "The legal entity management type in the case of an employer of record (EOR) or professional employment organization (PEO). * `PEO`: The legal entity is considered a Professional Employment Organization (PEO). * `EOR`: The legal entity is considered an Employer of Record (EOR).", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The parent legal entity.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent legal entity.", "type": "string" }, "physical_address": { "description": "The physical address of the legal entity, if it differs from the mailing address.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "registration_date": { "description": "The registration date of the entity.", "type": "string" }, "tax_identifier": { "description": "The tax identifier for the legal entity.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "LegalEntity", "type": "object" }, "legal_entity_id": { "description": "The worker's associated legal entity.", "type": "string" }, "level": { "description": "The level of the worker.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "description": { "description": "The description of the level.", "type": "string" }, "experience_requirements": { "description": "The experience requirements for the level.", "type": "string" }, "global_level": { "anyOf": [ { "description": "Global level is used to track the seniority of levels. The higher up a level is placed on the page, the more senior and higher-ranked the level. Global level is used in workflows, policies, and reports that use the level attribute (e.g., you can use Level Lookup to set up a workflow that notifies the nearest person in an worker's management chain at or above the specified level).", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the level. Must be unique within the company or organization.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLevel", "description": "The parent level.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent level.", "type": "string" }, "rank": { "anyOf": [ { "description": "The rank of the level within its track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "scope_of_responsibilities": { "description": "The scope of responsibilities for the level.", "type": "string" }, "track": { "description": "The track associated with the level, if it's not a global level.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_default": { "description": "Whether this is the company's default track.", "type": "boolean" }, "name": { "description": "The name of the track. Must be unique within the company or organization.", "type": "string" }, "order": { "anyOf": [ { "description": "The one-based horizontal display order of the track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "start_global_level": { "anyOf": [ { "description": "The highest global level occupied by this track. Empty tracks return null.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Track", "type": "object" }, "track_id": { "description": "The track associated with the level. Required during creation. Include global_level when changing it.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Level", "type": "object" }, "level_id": { "description": "The level of the worker.", "type": "string" }, "location": { "description": "The location that the worker is mapped to for tax purposes. In the case that a worker is remote, the location's type is remote.", "properties": { "type": { "description": "The type of location.", "type": "string" }, "work_location_id": { "description": "The work location, if the worker isn't remote.", "type": "string" } }, "required": [ "type", "work_location_id" ], "title": "WorkerLocation", "type": "object" }, "manager": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's manager.\n\nExpandable field", "type": "object" }, "manager_id": { "description": "The worker's manager.", "type": "string" }, "number": { "anyOf": [ { "description": "The worker's number within the organization.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "original_start_date": { "description": "The worker's earliest start date across their employment history, excluding INIT roles.", "type": "string" }, "overtime_exemption": { "description": "The worker's overtime exemption status.", "type": "string" }, "pay_schedule_id": { "description": "The ID of the pay schedule currently associated with the worker.", "type": "string" }, "personal_email": { "description": "The worker's associated personal email address.", "type": "string" }, "race": { "description": "The identified race of the worker, if specified.", "type": "string" }, "start_date": { "description": "The start date of the worker.", "type": "string" }, "status": { "description": "The worker's status within the organization.", "type": "string" }, "teams": { "description": "The worker's assigned teams.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiTeamcb26bc28f32f" }, "type": "array" }, "teams_id": { "description": "The worker's assigned teams.", "items": { "type": "string" }, "type": "array" }, "termination_details": { "description": "The details of the worker's termination, if applicable.", "properties": { "reason": { "description": "This is a description that will be custom to each Rippling company.", "type": "string" }, "type": { "description": "The termination type indicates whether the termination was voluntary or involuntary.", "type": "string" } }, "title": "TerminationDetails", "type": "object" }, "title": { "description": "The worker's title.", "type": "string" }, "title_effective_date": { "description": "Title effective date", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "user": { "description": "The worker's associated user.\n\nExpandable field", "properties": { "active": { "description": "Whether the user is able to access company resources, typically when they are in actively engaged with the company and not after off-boarding.", "type": "boolean" }, "addresses": { "description": "The user's addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiUserAddressedd59b9ba9a1" }, "type": "array" }, "created_at": { "description": "Record creation date", "type": "string" }, "display_name": { "description": "The display name of the user using either the concatenated preferred given and family name or username depending on availability.", "type": "string" }, "emails": { "description": "The user's email addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiEmail5284c8258dc3" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "locale": { "description": "The User's default location for purposes of localization of currency, date time format, or numerical representations pursuant to RFC5646.", "type": "string" }, "name": { "description": "The user's name.", "properties": { "family_name": { "description": "The legal family name of the user, or last name in most Western languages.", "type": "string" }, "formatted": { "description": "The user's full name.", "type": "string" }, "given_name": { "description": "The given legal name of the user, or first name in most Western languages.", "type": "string" }, "middle_name": { "description": "The middle name(s) of the user.", "type": "string" }, "preferred_family_name": { "description": "The preferred family name, or last name in most Western languages, by the user.", "type": "string" }, "preferred_given_name": { "description": "The preferred given name, or first name in most Western languages, by the user.", "type": "string" } }, "title": "UserName", "type": "object" }, "number": { "description": "The permanent profile number of the user.", "type": "string" }, "phone_numbers": { "description": "The user's phone numbers.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoneNumber12060c61ecf5" }, "type": "array" }, "photos": { "description": "The user's photos.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoto2be7c3ae3f39" }, "type": "array" }, "preferred_language": { "description": "The User's preferred written or spoken language in the same format of the HTTP Accept-Language header, pursuant to Section 5.3.5 of RFC7231.", "type": "string" }, "timezone": { "description": "The User's current time zone in IANA database Olson format", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "username": { "description": "The unique identifier across Rippling used by the User for direct authentication into their associated company. Globally unique.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "User", "type": "object" }, "user_id": { "description": "The worker's associated user.", "type": "string" }, "work_email": { "description": "The worker's associated work email address.", "type": "string" }, "work_schedule": { "additionalProperties": { "$ref": "#/components/schemas/OutputRestApiWorkScheduleDay938f88d94f20" }, "description": "The worker's scheduled working hours for each day of the week.", "type": "object" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Worker", "type": "object" }, "worker_id": { "description": "Identifier of worker to whom job is assigned.", "type": "string" } }, "required": [ "created_at", "id", "job_code_id", "updated_at", "worker_id" ], "title": "JobAssignment", "type": "object" }, "OutputRestApiJobCodeSummary73cdc3312543": { "description": "", "properties": { "hours_worked": { "anyOf": [ { "description": "The total hours worked for the job codes.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "job_codes_id": { "description": "List of job code ids that this summary is tracking hours for.", "items": { "type": "string" }, "type": "array" } }, "title": "JobCodeSummary", "type": "object" }, "OutputRestApiJobCodeeda25ec6c9a8": { "description": "", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "custom_location": { "description": "The custom location of the job code. This location will be used for tax calculation purposes if using US Payroll when an employee is working at this job code.", "properties": { "address": { "description": "The address of the custom location.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" } }, "required": [ "address" ], "title": "CustomLocation", "type": "object" }, "department": { "description": "The department associated with the job code.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "department_hierarchy": { "description": "List of departments in the department hierarchy. Refer department_hierarchy_ids for department hierarchy order.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestDepartment" }, "type": "array" }, "department_hierarchy_id": { "description": "The identifier of departments in the department hierarchy ordered from parent department to child department.", "items": { "type": "string" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the department.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestDepartment", "description": "The parent department.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent department.", "type": "string" }, "reference_code": { "description": "Reference code of the department.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Department", "type": "object" }, "department_id": { "description": "The department associated with the job code.", "type": "string" }, "external_id": { "description": "The unique identifier of the job code in an outside system.", "type": "string" }, "group_id": { "description": "The ID of the job roster group.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_archived": { "description": "Whether this job code is archived. Set to true via PATCH to archive. Archiving is irreversible via this API.", "type": "boolean" }, "job_dimension": { "description": "The job dimension this job code belongs to.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "external_id": { "description": "The unique identifier of the job dimension in a third party system", "type": "string" }, "group_id": { "description": "The ID of the dimension roster group.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "includes_custom_location": { "description": "Whether the job dimension includes codes related to a custom location. Only one dimension can have this set to true.", "type": "boolean" }, "name": { "description": "The name of the job dimension", "type": "string" }, "org_attribute_associations": { "description": "Organizational attributes associated with the job dimension. Only 'PAY_RATE' can be set or modified using POST or PATCH requests.", "items": {}, "type": "array" }, "roster_type": { "description": "The roster type of the dimension. PER_DIMENSION means that there is a group on the dimension level and employees within that group have access to all job codes in the dimension. PER_JOB_CODE means that each job code has its own group.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "JobDimension", "type": "object" }, "job_dimension_id": { "description": "The ID of the job dimension this job code belongs to.", "type": "string" }, "name": { "description": "The name of the job dimension.", "type": "string" }, "pay_rate": { "anyOf": [ { "description": "The pay rate for this job code. Only applicable if the associated job dimension includes the 'PAY_RATE' organizational attribute.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "pay_rate_exceptions": { "description": "Pay rate overrides for the job based on exception dimension values.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiJobPayRateExceptionaf426aa0ac14" }, "type": "array" }, "pay_rate_exceptions_id": { "description": "Pay rate overrides id for the job based on exception dimension values.", "items": { "type": "string" }, "type": "array" }, "updated_at": { "description": "Record update date", "type": "string" }, "work_location": { "description": "The work location associated with the job code.\n\nExpandable field", "properties": { "address": { "description": "The address for the work location.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the work location.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "address", "created_at", "id", "name", "updated_at" ], "title": "WorkLocation", "type": "object" }, "work_location_id": { "description": "The work location associated with the job code.", "type": "string" } }, "required": [ "created_at", "id", "job_dimension_id", "name", "updated_at" ], "title": "JobCode", "type": "object" }, "OutputRestApiJobDimensionce590ca55611": { "description": "", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "external_id": { "description": "The unique identifier of the job dimension in a third party system", "type": "string" }, "group_id": { "description": "The ID of the dimension roster group.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "includes_custom_location": { "description": "Whether the job dimension includes codes related to a custom location. Only one dimension can have this set to true.", "type": "boolean" }, "name": { "description": "The name of the job dimension", "type": "string" }, "org_attribute_associations": { "description": "Organizational attributes associated with the job dimension. Only 'PAY_RATE' can be set or modified using POST or PATCH requests.", "items": {}, "type": "array" }, "roster_type": { "description": "The roster type of the dimension. PER_DIMENSION means that there is a group on the dimension level and employees within that group have access to all job codes in the dimension. PER_JOB_CODE means that each job code has its own group.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "JobDimension", "type": "object" }, "OutputRestApiJobFunctionf96c2901b7d8": { "description": "", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "Displayed name of the job function", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "JobFunction", "type": "object" }, "OutputRestApiJobPayRateException2b2788a4d92c": { "description": "", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "exception_dimension_id": { "description": "Identifier of dimension object on which exception is configured. This objects details can be queried from exception_dimension_type's resource", "type": "string" }, "exception_dimension_type": { "description": "Type of dimension on which exception is configured", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "job_code": { "description": "Job for which exception is configured.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "custom_location": { "description": "The custom location of the job code. This location will be used for tax calculation purposes if using US Payroll when an employee is working at this job code.", "properties": { "address": { "description": "The address of the custom location.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" } }, "required": [ "address" ], "title": "CustomLocation", "type": "object" }, "department": { "description": "The department associated with the job code.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "department_hierarchy": { "description": "List of departments in the department hierarchy. Refer department_hierarchy_ids for department hierarchy order.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestDepartment" }, "type": "array" }, "department_hierarchy_id": { "description": "The identifier of departments in the department hierarchy ordered from parent department to child department.", "items": { "type": "string" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the department.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestDepartment", "description": "The parent department.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent department.", "type": "string" }, "reference_code": { "description": "Reference code of the department.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Department", "type": "object" }, "department_id": { "description": "The department associated with the job code.", "type": "string" }, "external_id": { "description": "The unique identifier of the job code in an outside system.", "type": "string" }, "group_id": { "description": "The ID of the job roster group.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_archived": { "description": "Whether this job code is archived. Set to true via PATCH to archive. Archiving is irreversible via this API.", "type": "boolean" }, "job_dimension": { "description": "The job dimension this job code belongs to.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "external_id": { "description": "The unique identifier of the job dimension in a third party system", "type": "string" }, "group_id": { "description": "The ID of the dimension roster group.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "includes_custom_location": { "description": "Whether the job dimension includes codes related to a custom location. Only one dimension can have this set to true.", "type": "boolean" }, "name": { "description": "The name of the job dimension", "type": "string" }, "org_attribute_associations": { "description": "Organizational attributes associated with the job dimension. Only 'PAY_RATE' can be set or modified using POST or PATCH requests.", "items": {}, "type": "array" }, "roster_type": { "description": "The roster type of the dimension. PER_DIMENSION means that there is a group on the dimension level and employees within that group have access to all job codes in the dimension. PER_JOB_CODE means that each job code has its own group.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "JobDimension", "type": "object" }, "job_dimension_id": { "description": "The ID of the job dimension this job code belongs to.", "type": "string" }, "name": { "description": "The name of the job dimension.", "type": "string" }, "pay_rate": { "anyOf": [ { "description": "The pay rate for this job code. Only applicable if the associated job dimension includes the 'PAY_RATE' organizational attribute.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "pay_rate_exceptions": { "description": "Pay rate overrides for the job based on exception dimension values.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestJobPayRateException" }, "type": "array" }, "pay_rate_exceptions_id": { "description": "Pay rate overrides id for the job based on exception dimension values.", "items": { "type": "string" }, "type": "array" }, "updated_at": { "description": "Record update date", "type": "string" }, "work_location": { "description": "The work location associated with the job code.\n\nExpandable field", "properties": { "address": { "description": "The address for the work location.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the work location.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "address", "created_at", "id", "name", "updated_at" ], "title": "WorkLocation", "type": "object" }, "work_location_id": { "description": "The work location associated with the job code.", "type": "string" } }, "required": [ "created_at", "id", "job_dimension_id", "name", "updated_at" ], "title": "JobCode", "type": "object" }, "job_code_id": { "description": "Identifier of Job for which exception is configured.", "type": "string" }, "pay_rate": { "anyOf": [ { "description": "The pay rate for exception on job_code_id and exception_dimension_id combination", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "exception_dimension_id", "id", "job_code_id", "pay_rate", "updated_at" ], "title": "JobPayRateException", "type": "object" }, "OutputRestApiJobPayRateExceptionaf426aa0ac14": { "description": "", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "exception_dimension_id": { "description": "Identifier of dimension object on which exception is configured. This objects details can be queried from exception_dimension_type's resource", "type": "string" }, "exception_dimension_type": { "description": "Type of dimension on which exception is configured", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "job_code": { "$ref": "#/components/schemas/OutputRestJobCode", "description": "Job for which exception is configured.\n\nExpandable field", "type": "object" }, "job_code_id": { "description": "Identifier of Job for which exception is configured.", "type": "string" }, "pay_rate": { "anyOf": [ { "description": "The pay rate for exception on job_code_id and exception_dimension_id combination", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "exception_dimension_id", "id", "job_code_id", "pay_rate", "updated_at" ], "title": "JobPayRateException", "type": "object" }, "OutputRestApiJobRequisition324d78fa0203": { "description": "", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "Job requisition name", "type": "string" }, "status": { "description": "Job requisition status", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "status", "updated_at" ], "title": "JobRequisition", "type": "object" }, "OutputRestApiJobShift87137d8a0daa": { "description": "", "properties": { "end_time": { "description": "The end time of the job shift.", "type": "string" }, "is_hours_only_input": { "description": "Whether the job shift was entered as a duration in hours table", "type": "boolean" }, "job_codes_id": { "description": "The IDs of the job codes associated with the job shift.", "items": { "type": "string" }, "type": "array" }, "original_end_time": { "description": "The original end time of the job shift. If the endTime field has been rounded then this contain the end time before the rounding occured.", "type": "string" }, "original_start_time": { "description": "The original start time of the job shift. If the startTime field has been rounded then this contain the start time before the rounding occured.", "type": "string" }, "start_time": { "description": "The start time of the job shift.", "type": "string" } }, "title": "JobShift", "type": "object" }, "OutputRestApiLeaveAccruald674b7ad5007": { "description": "\n Leave accrual resource representing time off credits granted to employees.\n\n Leave accruals track the allocation of paid time off (vacation, sick days, etc.)\n to employees based on company policies, manual grants, or other accrual sources.\n ", "properties": { "accrual_date": { "description": "The date when this accrual becomes effective", "type": "string" }, "accrual_type": { "description": "The type of accrual", "type": "string" }, "comment": { "description": "The comment for this accrual. This is required if the leave policy requires a comment on accruals.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "expiration_date": { "description": "The date when this accrual expires (if applicable)", "type": "string" }, "grantor": { "description": "The worker who granted this accrual. This is typically the Time Off admin.\n\nExpandable field", "properties": { "business_partners": { "description": "Worker's assigned business partners. This field is only populated when explicitly requested via the expand parameter (e.g., ?expand=business_partners). When expanded, returns an empty list ([]) if the worker has no business partners.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiBusinessPartner77b00a069c32" }, "type": "array" }, "business_partners_id": { "description": "Worker's assigned business partners unique identifiers. Returns an empty list ([]) if the worker has no business partners.", "items": { "type": "string" }, "type": "array" }, "citizenship": { "description": "The countries that the worker has citizenship in.", "type": "string" }, "compensation": { "description": "The compensation package for the worker.\n\nExpandable field", "properties": { "annual_compensation": { "description": "The worker's annual compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "annual_salary_equivalent": { "description": "The worker's annual salary equivalent, for insurance purposes. It will be equal to the worker's annual compensation, except for owners that are receiving no cashcompensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "bonus_schedule": { "description": "The worker's bonus schedule.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "hourly_wage": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "id": { "description": "Identifier field", "type": "string" }, "monthly_compensation": { "description": "The worker's monthly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "on_target_commission": { "description": "The worker's on-target commission.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "payment_terms": { "description": "The payment terms for an worker's compensation.", "type": "string" }, "payment_type": { "description": "The payment type for an worker's compensation.", "type": "string" }, "relocation_reimbursement": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "salary_effective_date": { "description": "Salary effective date", "type": "string" }, "signing_bonus": { "description": "The worker's signing bonus.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus": { "description": "The worker's target annual bonus amount.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus_percent": { "anyOf": [ { "description": "The worker's target annual bonus as a percent of annual compensation.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" }, "weekly_compensation": { "description": "The worker's weekly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "worker": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's details.\n\nExpandable field", "type": "object" }, "worker_id": { "description": "The worker's ID.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Compensation", "type": "object" }, "compensation_grade": { "description": "The compensation grade assigned to the worker, if any.", "properties": { "id": { "description": "The compensation grade's unique identifier.", "type": "string" }, "label": { "description": "The compensation grade's label.", "type": "string" } }, "title": "WorkerCompensationGrade", "type": "object" }, "compensation_id": { "description": "The compensation package for the worker.", "type": "string" }, "country": { "description": "The worker's country.", "type": "string" }, "country_fields": { "description": "Country level fields for the worker.", "properties": { "ca": { "description": "Country-wise regional fields for Canada", "properties": { "sin": { "description": "Social Insurance Number (SIN) for Canada employees.", "type": "string" } }, "title": "CanadaFields", "type": "object" }, "nz": { "description": "Country-wise regional fields for New Zealand", "properties": { "ird_number": { "description": "Inland Revenue Department (IRD) number for New Zealand employees.", "type": "string" } }, "title": "NewZealandFields", "type": "object" }, "us": { "description": "Country-wise regional fields for USA", "properties": { "ssn": { "description": "Social Security Number (SSN) for US employees.", "type": "string" } }, "title": "USFields", "type": "object" } }, "title": "CountryFields", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "custom_fields": { "description": "Custom field values defined on the Employee object for this worker\n\nExpandable field", "items": { "additionalProperties": {} }, "type": "array" }, "date_of_birth": { "description": "The worker's date of birth.", "type": "string" }, "department": { "description": "The worker's assigned department.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "department_hierarchy": { "description": "List of departments in the department hierarchy. Refer department_hierarchy_ids for department hierarchy order.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestDepartment" }, "type": "array" }, "department_hierarchy_id": { "description": "The identifier of departments in the department hierarchy ordered from parent department to child department.", "items": { "type": "string" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the department.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestDepartment", "description": "The parent department.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent department.", "type": "string" }, "reference_code": { "description": "Reference code of the department.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Department", "type": "object" }, "department_id": { "description": "The worker's assigned department.", "type": "string" }, "employment_type": { "description": "The worker's employment type.\n\nExpandable field", "properties": { "amount_worked": { "description": "The amount worked for the employment type. * `FULL-TIME`: Full-time is at least 30 hours per week. Full-time workers will typically be eligible for benefits. * `PART-TIME`: Part-time is less than 30 hours per week. These workers may be eligible for benefits, depending on company settings and hours worked. * `TEMPORARY`: These workers are hired on a temporary basis. You can specify how each worker with this employment type will be paid individually.", "type": "string" }, "compensation_time_period": { "description": "The compensation period for the employment type. * `SALARIED`: Employees that are paid a fixed amount per year. * `HOURLY`: Employees that are paid a wage per hour worked.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "label": { "description": "The display label of the employment type.", "type": "string" }, "name": { "description": "The name of the employment type for non-custom employment types.", "type": "string" }, "type": { "description": "The classification of the worker by the company. * `CONTRACTOR`: Contractors are self-employed workers who provide services on a short-term or per-project basis and are not eligible for tax-withholding or benefits. * `EMPLOYEE`: Employees are hired and managed by an employer, work under the employer's direct supervision and control, and are protected by law for wages and employment rights.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "label", "updated_at" ], "title": "CompanyEmploymentType", "type": "object" }, "employment_type_id": { "description": "The worker's employment type.", "type": "string" }, "end_date": { "description": "The end date of the worker.", "type": "string" }, "ethnicity": { "description": "The identified ethnicity of the worker, if specified.", "type": "string" }, "gender": { "description": "The gender of the worker, if specified.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_manager": { "description": "Whether the worker is a manager", "type": "boolean" }, "job_function": { "description": "The worker's job function. When expanded, this field requires `job-functions.read`.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "Displayed name of the job function", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "JobFunction", "type": "object" }, "job_function_id": { "description": "ID of the worker's job function.", "type": "string" }, "legal_entity": { "description": "The worker's associated legal entity.\n\nExpandable field", "properties": { "company": { "description": "The company or organization associated with the legal entity\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "doing_business_as_name": { "description": "The doing business as name for the company.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_entities": { "description": "A list of the company's entities.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestLegalEntity" }, "type": "array" }, "legal_entities_id": { "description": "A list of the company's entities.", "items": { "type": "string" }, "type": "array" }, "legal_name": { "description": "The legal name of the company.", "type": "string" }, "name": { "description": "The name of the company.", "type": "string" }, "parent_legal_entity": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The company's ultimate holding entity.\n\nExpandable field", "type": "object" }, "parent_legal_entity_id": { "description": "The company's ultimate holding entity.", "type": "string" }, "phone": { "description": "The phone number for the company.", "type": "string" }, "physical_address": { "description": "The physical address of the holding entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "primary_email": { "description": "The email address used when registering this company.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "legal_entities", "legal_entities_id", "name", "updated_at" ], "title": "Company", "type": "object" }, "company_id": { "description": "The company or organization associated with the legal entity", "type": "string" }, "country": { "description": "The country the legal entity is based in.", "properties": { "code": { "description": "The code of the country.", "type": "string" } }, "required": [ "code" ], "title": "Country", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "entity_level": { "description": "The legal entity's level in a hierarchy. * `PARENT`: The legal entity is considered the ultimate holding entity. * `SUBSIDIARY`: The legal entity is considered a subsidiary, fully or partially held by another. * `BRANCH`: The legal entity is considered a branch, associated with a parent legal entity.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_name": { "description": "The legal name of the legal entity.", "type": "string" }, "mailing_address": { "description": "The mailing address of the legal entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "management_type": { "description": "The legal entity management type in the case of an employer of record (EOR) or professional employment organization (PEO). * `PEO`: The legal entity is considered a Professional Employment Organization (PEO). * `EOR`: The legal entity is considered an Employer of Record (EOR).", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The parent legal entity.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent legal entity.", "type": "string" }, "physical_address": { "description": "The physical address of the legal entity, if it differs from the mailing address.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "registration_date": { "description": "The registration date of the entity.", "type": "string" }, "tax_identifier": { "description": "The tax identifier for the legal entity.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "LegalEntity", "type": "object" }, "legal_entity_id": { "description": "The worker's associated legal entity.", "type": "string" }, "level": { "description": "The level of the worker.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "description": { "description": "The description of the level.", "type": "string" }, "experience_requirements": { "description": "The experience requirements for the level.", "type": "string" }, "global_level": { "anyOf": [ { "description": "Global level is used to track the seniority of levels. The higher up a level is placed on the page, the more senior and higher-ranked the level. Global level is used in workflows, policies, and reports that use the level attribute (e.g., you can use Level Lookup to set up a workflow that notifies the nearest person in an worker's management chain at or above the specified level).", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the level. Must be unique within the company or organization.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLevel", "description": "The parent level.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent level.", "type": "string" }, "rank": { "anyOf": [ { "description": "The rank of the level within its track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "scope_of_responsibilities": { "description": "The scope of responsibilities for the level.", "type": "string" }, "track": { "description": "The track associated with the level, if it's not a global level.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_default": { "description": "Whether this is the company's default track.", "type": "boolean" }, "name": { "description": "The name of the track. Must be unique within the company or organization.", "type": "string" }, "order": { "anyOf": [ { "description": "The one-based horizontal display order of the track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "start_global_level": { "anyOf": [ { "description": "The highest global level occupied by this track. Empty tracks return null.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Track", "type": "object" }, "track_id": { "description": "The track associated with the level. Required during creation. Include global_level when changing it.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Level", "type": "object" }, "level_id": { "description": "The level of the worker.", "type": "string" }, "location": { "description": "The location that the worker is mapped to for tax purposes. In the case that a worker is remote, the location's type is remote.", "properties": { "type": { "description": "The type of location.", "type": "string" }, "work_location_id": { "description": "The work location, if the worker isn't remote.", "type": "string" } }, "required": [ "type", "work_location_id" ], "title": "WorkerLocation", "type": "object" }, "manager": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's manager.\n\nExpandable field", "type": "object" }, "manager_id": { "description": "The worker's manager.", "type": "string" }, "number": { "anyOf": [ { "description": "The worker's number within the organization.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "original_start_date": { "description": "The worker's earliest start date across their employment history, excluding INIT roles.", "type": "string" }, "overtime_exemption": { "description": "The worker's overtime exemption status.", "type": "string" }, "pay_schedule_id": { "description": "The ID of the pay schedule currently associated with the worker.", "type": "string" }, "personal_email": { "description": "The worker's associated personal email address.", "type": "string" }, "race": { "description": "The identified race of the worker, if specified.", "type": "string" }, "start_date": { "description": "The start date of the worker.", "type": "string" }, "status": { "description": "The worker's status within the organization.", "type": "string" }, "teams": { "description": "The worker's assigned teams.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiTeamcb26bc28f32f" }, "type": "array" }, "teams_id": { "description": "The worker's assigned teams.", "items": { "type": "string" }, "type": "array" }, "termination_details": { "description": "The details of the worker's termination, if applicable.", "properties": { "reason": { "description": "This is a description that will be custom to each Rippling company.", "type": "string" }, "type": { "description": "The termination type indicates whether the termination was voluntary or involuntary.", "type": "string" } }, "title": "TerminationDetails", "type": "object" }, "title": { "description": "The worker's title.", "type": "string" }, "title_effective_date": { "description": "Title effective date", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "user": { "description": "The worker's associated user.\n\nExpandable field", "properties": { "active": { "description": "Whether the user is able to access company resources, typically when they are in actively engaged with the company and not after off-boarding.", "type": "boolean" }, "addresses": { "description": "The user's addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiUserAddressedd59b9ba9a1" }, "type": "array" }, "created_at": { "description": "Record creation date", "type": "string" }, "display_name": { "description": "The display name of the user using either the concatenated preferred given and family name or username depending on availability.", "type": "string" }, "emails": { "description": "The user's email addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiEmail5284c8258dc3" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "locale": { "description": "The User's default location for purposes of localization of currency, date time format, or numerical representations pursuant to RFC5646.", "type": "string" }, "name": { "description": "The user's name.", "properties": { "family_name": { "description": "The legal family name of the user, or last name in most Western languages.", "type": "string" }, "formatted": { "description": "The user's full name.", "type": "string" }, "given_name": { "description": "The given legal name of the user, or first name in most Western languages.", "type": "string" }, "middle_name": { "description": "The middle name(s) of the user.", "type": "string" }, "preferred_family_name": { "description": "The preferred family name, or last name in most Western languages, by the user.", "type": "string" }, "preferred_given_name": { "description": "The preferred given name, or first name in most Western languages, by the user.", "type": "string" } }, "title": "UserName", "type": "object" }, "number": { "description": "The permanent profile number of the user.", "type": "string" }, "phone_numbers": { "description": "The user's phone numbers.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoneNumber12060c61ecf5" }, "type": "array" }, "photos": { "description": "The user's photos.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoto2be7c3ae3f39" }, "type": "array" }, "preferred_language": { "description": "The User's preferred written or spoken language in the same format of the HTTP Accept-Language header, pursuant to Section 5.3.5 of RFC7231.", "type": "string" }, "timezone": { "description": "The User's current time zone in IANA database Olson format", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "username": { "description": "The unique identifier across Rippling used by the User for direct authentication into their associated company. Globally unique.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "User", "type": "object" }, "user_id": { "description": "The worker's associated user.", "type": "string" }, "work_email": { "description": "The worker's associated work email address.", "type": "string" }, "work_schedule": { "additionalProperties": { "$ref": "#/components/schemas/OutputRestApiWorkScheduleDay938f88d94f20" }, "description": "The worker's scheduled working hours for each day of the week.", "type": "object" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Worker", "type": "object" }, "grantor_id": { "description": "The ID of the worker who granted this accrual. This is typically the Time Off admin.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "leave_type_id": { "description": "The company leave type ID associated with this accrual", "type": "string" }, "monetary_amount_accrued": { "anyOf": [ { "description": "The monetary value of this accrual (for policies with monetary tracking)", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "num_days": { "anyOf": [ { "description": "The number of days accrued. It can be negative for deductions. This is applicable if the policy tracks in days.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "num_hours": { "anyOf": [ { "description": "The number of hours accrued. It can be negative for deductions. This is applicable if the policy tracks in hours.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" }, "worker": { "description": "The worker for whom the accrual is for\n\nExpandable field", "properties": { "business_partners": { "description": "Worker's assigned business partners. This field is only populated when explicitly requested via the expand parameter (e.g., ?expand=business_partners). When expanded, returns an empty list ([]) if the worker has no business partners.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiBusinessPartner77b00a069c32" }, "type": "array" }, "business_partners_id": { "description": "Worker's assigned business partners unique identifiers. Returns an empty list ([]) if the worker has no business partners.", "items": { "type": "string" }, "type": "array" }, "citizenship": { "description": "The countries that the worker has citizenship in.", "type": "string" }, "compensation": { "description": "The compensation package for the worker.\n\nExpandable field", "properties": { "annual_compensation": { "description": "The worker's annual compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "annual_salary_equivalent": { "description": "The worker's annual salary equivalent, for insurance purposes. It will be equal to the worker's annual compensation, except for owners that are receiving no cashcompensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "bonus_schedule": { "description": "The worker's bonus schedule.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "hourly_wage": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "id": { "description": "Identifier field", "type": "string" }, "monthly_compensation": { "description": "The worker's monthly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "on_target_commission": { "description": "The worker's on-target commission.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "payment_terms": { "description": "The payment terms for an worker's compensation.", "type": "string" }, "payment_type": { "description": "The payment type for an worker's compensation.", "type": "string" }, "relocation_reimbursement": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "salary_effective_date": { "description": "Salary effective date", "type": "string" }, "signing_bonus": { "description": "The worker's signing bonus.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus": { "description": "The worker's target annual bonus amount.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus_percent": { "anyOf": [ { "description": "The worker's target annual bonus as a percent of annual compensation.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" }, "weekly_compensation": { "description": "The worker's weekly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "worker": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's details.\n\nExpandable field", "type": "object" }, "worker_id": { "description": "The worker's ID.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Compensation", "type": "object" }, "compensation_grade": { "description": "The compensation grade assigned to the worker, if any.", "properties": { "id": { "description": "The compensation grade's unique identifier.", "type": "string" }, "label": { "description": "The compensation grade's label.", "type": "string" } }, "title": "WorkerCompensationGrade", "type": "object" }, "compensation_id": { "description": "The compensation package for the worker.", "type": "string" }, "country": { "description": "The worker's country.", "type": "string" }, "country_fields": { "description": "Country level fields for the worker.", "properties": { "ca": { "description": "Country-wise regional fields for Canada", "properties": { "sin": { "description": "Social Insurance Number (SIN) for Canada employees.", "type": "string" } }, "title": "CanadaFields", "type": "object" }, "nz": { "description": "Country-wise regional fields for New Zealand", "properties": { "ird_number": { "description": "Inland Revenue Department (IRD) number for New Zealand employees.", "type": "string" } }, "title": "NewZealandFields", "type": "object" }, "us": { "description": "Country-wise regional fields for USA", "properties": { "ssn": { "description": "Social Security Number (SSN) for US employees.", "type": "string" } }, "title": "USFields", "type": "object" } }, "title": "CountryFields", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "custom_fields": { "description": "Custom field values defined on the Employee object for this worker\n\nExpandable field", "items": { "additionalProperties": {} }, "type": "array" }, "date_of_birth": { "description": "The worker's date of birth.", "type": "string" }, "department": { "description": "The worker's assigned department.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "department_hierarchy": { "description": "List of departments in the department hierarchy. Refer department_hierarchy_ids for department hierarchy order.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestDepartment" }, "type": "array" }, "department_hierarchy_id": { "description": "The identifier of departments in the department hierarchy ordered from parent department to child department.", "items": { "type": "string" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the department.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestDepartment", "description": "The parent department.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent department.", "type": "string" }, "reference_code": { "description": "Reference code of the department.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Department", "type": "object" }, "department_id": { "description": "The worker's assigned department.", "type": "string" }, "employment_type": { "description": "The worker's employment type.\n\nExpandable field", "properties": { "amount_worked": { "description": "The amount worked for the employment type. * `FULL-TIME`: Full-time is at least 30 hours per week. Full-time workers will typically be eligible for benefits. * `PART-TIME`: Part-time is less than 30 hours per week. These workers may be eligible for benefits, depending on company settings and hours worked. * `TEMPORARY`: These workers are hired on a temporary basis. You can specify how each worker with this employment type will be paid individually.", "type": "string" }, "compensation_time_period": { "description": "The compensation period for the employment type. * `SALARIED`: Employees that are paid a fixed amount per year. * `HOURLY`: Employees that are paid a wage per hour worked.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "label": { "description": "The display label of the employment type.", "type": "string" }, "name": { "description": "The name of the employment type for non-custom employment types.", "type": "string" }, "type": { "description": "The classification of the worker by the company. * `CONTRACTOR`: Contractors are self-employed workers who provide services on a short-term or per-project basis and are not eligible for tax-withholding or benefits. * `EMPLOYEE`: Employees are hired and managed by an employer, work under the employer's direct supervision and control, and are protected by law for wages and employment rights.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "label", "updated_at" ], "title": "CompanyEmploymentType", "type": "object" }, "employment_type_id": { "description": "The worker's employment type.", "type": "string" }, "end_date": { "description": "The end date of the worker.", "type": "string" }, "ethnicity": { "description": "The identified ethnicity of the worker, if specified.", "type": "string" }, "gender": { "description": "The gender of the worker, if specified.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_manager": { "description": "Whether the worker is a manager", "type": "boolean" }, "job_function": { "description": "The worker's job function. When expanded, this field requires `job-functions.read`.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "Displayed name of the job function", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "JobFunction", "type": "object" }, "job_function_id": { "description": "ID of the worker's job function.", "type": "string" }, "legal_entity": { "description": "The worker's associated legal entity.\n\nExpandable field", "properties": { "company": { "description": "The company or organization associated with the legal entity\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "doing_business_as_name": { "description": "The doing business as name for the company.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_entities": { "description": "A list of the company's entities.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestLegalEntity" }, "type": "array" }, "legal_entities_id": { "description": "A list of the company's entities.", "items": { "type": "string" }, "type": "array" }, "legal_name": { "description": "The legal name of the company.", "type": "string" }, "name": { "description": "The name of the company.", "type": "string" }, "parent_legal_entity": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The company's ultimate holding entity.\n\nExpandable field", "type": "object" }, "parent_legal_entity_id": { "description": "The company's ultimate holding entity.", "type": "string" }, "phone": { "description": "The phone number for the company.", "type": "string" }, "physical_address": { "description": "The physical address of the holding entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "primary_email": { "description": "The email address used when registering this company.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "legal_entities", "legal_entities_id", "name", "updated_at" ], "title": "Company", "type": "object" }, "company_id": { "description": "The company or organization associated with the legal entity", "type": "string" }, "country": { "description": "The country the legal entity is based in.", "properties": { "code": { "description": "The code of the country.", "type": "string" } }, "required": [ "code" ], "title": "Country", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "entity_level": { "description": "The legal entity's level in a hierarchy. * `PARENT`: The legal entity is considered the ultimate holding entity. * `SUBSIDIARY`: The legal entity is considered a subsidiary, fully or partially held by another. * `BRANCH`: The legal entity is considered a branch, associated with a parent legal entity.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_name": { "description": "The legal name of the legal entity.", "type": "string" }, "mailing_address": { "description": "The mailing address of the legal entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "management_type": { "description": "The legal entity management type in the case of an employer of record (EOR) or professional employment organization (PEO). * `PEO`: The legal entity is considered a Professional Employment Organization (PEO). * `EOR`: The legal entity is considered an Employer of Record (EOR).", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The parent legal entity.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent legal entity.", "type": "string" }, "physical_address": { "description": "The physical address of the legal entity, if it differs from the mailing address.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "registration_date": { "description": "The registration date of the entity.", "type": "string" }, "tax_identifier": { "description": "The tax identifier for the legal entity.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "LegalEntity", "type": "object" }, "legal_entity_id": { "description": "The worker's associated legal entity.", "type": "string" }, "level": { "description": "The level of the worker.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "description": { "description": "The description of the level.", "type": "string" }, "experience_requirements": { "description": "The experience requirements for the level.", "type": "string" }, "global_level": { "anyOf": [ { "description": "Global level is used to track the seniority of levels. The higher up a level is placed on the page, the more senior and higher-ranked the level. Global level is used in workflows, policies, and reports that use the level attribute (e.g., you can use Level Lookup to set up a workflow that notifies the nearest person in an worker's management chain at or above the specified level).", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the level. Must be unique within the company or organization.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLevel", "description": "The parent level.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent level.", "type": "string" }, "rank": { "anyOf": [ { "description": "The rank of the level within its track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "scope_of_responsibilities": { "description": "The scope of responsibilities for the level.", "type": "string" }, "track": { "description": "The track associated with the level, if it's not a global level.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_default": { "description": "Whether this is the company's default track.", "type": "boolean" }, "name": { "description": "The name of the track. Must be unique within the company or organization.", "type": "string" }, "order": { "anyOf": [ { "description": "The one-based horizontal display order of the track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "start_global_level": { "anyOf": [ { "description": "The highest global level occupied by this track. Empty tracks return null.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Track", "type": "object" }, "track_id": { "description": "The track associated with the level. Required during creation. Include global_level when changing it.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Level", "type": "object" }, "level_id": { "description": "The level of the worker.", "type": "string" }, "location": { "description": "The location that the worker is mapped to for tax purposes. In the case that a worker is remote, the location's type is remote.", "properties": { "type": { "description": "The type of location.", "type": "string" }, "work_location_id": { "description": "The work location, if the worker isn't remote.", "type": "string" } }, "required": [ "type", "work_location_id" ], "title": "WorkerLocation", "type": "object" }, "manager": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's manager.\n\nExpandable field", "type": "object" }, "manager_id": { "description": "The worker's manager.", "type": "string" }, "number": { "anyOf": [ { "description": "The worker's number within the organization.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "original_start_date": { "description": "The worker's earliest start date across their employment history, excluding INIT roles.", "type": "string" }, "overtime_exemption": { "description": "The worker's overtime exemption status.", "type": "string" }, "pay_schedule_id": { "description": "The ID of the pay schedule currently associated with the worker.", "type": "string" }, "personal_email": { "description": "The worker's associated personal email address.", "type": "string" }, "race": { "description": "The identified race of the worker, if specified.", "type": "string" }, "start_date": { "description": "The start date of the worker.", "type": "string" }, "status": { "description": "The worker's status within the organization.", "type": "string" }, "teams": { "description": "The worker's assigned teams.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiTeamcb26bc28f32f" }, "type": "array" }, "teams_id": { "description": "The worker's assigned teams.", "items": { "type": "string" }, "type": "array" }, "termination_details": { "description": "The details of the worker's termination, if applicable.", "properties": { "reason": { "description": "This is a description that will be custom to each Rippling company.", "type": "string" }, "type": { "description": "The termination type indicates whether the termination was voluntary or involuntary.", "type": "string" } }, "title": "TerminationDetails", "type": "object" }, "title": { "description": "The worker's title.", "type": "string" }, "title_effective_date": { "description": "Title effective date", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "user": { "description": "The worker's associated user.\n\nExpandable field", "properties": { "active": { "description": "Whether the user is able to access company resources, typically when they are in actively engaged with the company and not after off-boarding.", "type": "boolean" }, "addresses": { "description": "The user's addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiUserAddressedd59b9ba9a1" }, "type": "array" }, "created_at": { "description": "Record creation date", "type": "string" }, "display_name": { "description": "The display name of the user using either the concatenated preferred given and family name or username depending on availability.", "type": "string" }, "emails": { "description": "The user's email addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiEmail5284c8258dc3" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "locale": { "description": "The User's default location for purposes of localization of currency, date time format, or numerical representations pursuant to RFC5646.", "type": "string" }, "name": { "description": "The user's name.", "properties": { "family_name": { "description": "The legal family name of the user, or last name in most Western languages.", "type": "string" }, "formatted": { "description": "The user's full name.", "type": "string" }, "given_name": { "description": "The given legal name of the user, or first name in most Western languages.", "type": "string" }, "middle_name": { "description": "The middle name(s) of the user.", "type": "string" }, "preferred_family_name": { "description": "The preferred family name, or last name in most Western languages, by the user.", "type": "string" }, "preferred_given_name": { "description": "The preferred given name, or first name in most Western languages, by the user.", "type": "string" } }, "title": "UserName", "type": "object" }, "number": { "description": "The permanent profile number of the user.", "type": "string" }, "phone_numbers": { "description": "The user's phone numbers.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoneNumber12060c61ecf5" }, "type": "array" }, "photos": { "description": "The user's photos.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoto2be7c3ae3f39" }, "type": "array" }, "preferred_language": { "description": "The User's preferred written or spoken language in the same format of the HTTP Accept-Language header, pursuant to Section 5.3.5 of RFC7231.", "type": "string" }, "timezone": { "description": "The User's current time zone in IANA database Olson format", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "username": { "description": "The unique identifier across Rippling used by the User for direct authentication into their associated company. Globally unique.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "User", "type": "object" }, "user_id": { "description": "The worker's associated user.", "type": "string" }, "work_email": { "description": "The worker's associated work email address.", "type": "string" }, "work_schedule": { "additionalProperties": { "$ref": "#/components/schemas/OutputRestApiWorkScheduleDay938f88d94f20" }, "description": "The worker's scheduled working hours for each day of the week.", "type": "object" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Worker", "type": "object" }, "worker_id": { "description": "The ID of the worker for whom the accrual is for", "type": "string" } }, "required": [ "accrual_date", "created_at", "grantor_id", "id", "leave_type_id", "updated_at", "worker_id" ], "title": "LeaveAccrual", "type": "object" }, "OutputRestApiLeaveBalancea7326fca745d": { "description": "", "properties": { "balance_excluding_future_requests": { "anyOf": [ { "description": "The worker's leave balance excluding future leave requests. If the leave balance is unlimited, this field will be null.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "balance_excluding_future_requests_in_days": { "anyOf": [ { "description": "The worker's leave balance in days excluding future leave requests. If the leave balance is unlimited, this field will be null.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "balance_including_future_requests": { "anyOf": [ { "description": "The worker's leave balance including future leave requests. If the leave balance is unlimited, this field will be null.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "balance_including_future_requests_in_days": { "anyOf": [ { "description": "The worker's leave balance in days including future leave requests. If the leave balance is unlimited, this field will be null.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_balance_unlimited": { "description": "Indicates if the leave balance is unlimited.", "type": "boolean" }, "leave_type": { "description": "The leave type associated with the leave balance.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "description": { "description": "The description of the leave type.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_managed_by_external_system": { "description": "Whether the leave is managed by an external system.", "type": "boolean" }, "is_paid": { "description": "Whether the leave is paid.", "type": "boolean" }, "name": { "description": "The name of the leave type.", "type": "string" }, "type": { "description": "The type of leave.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "is_managed_by_external_system", "is_paid", "name", "type", "updated_at" ], "title": "LeaveType", "type": "object" }, "leave_type_id": { "description": "The ID of the leave type associated with the leave balance.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "worker": { "description": "The worker associated with the leave balance.\n\nExpandable field", "properties": { "business_partners": { "description": "Worker's assigned business partners. This field is only populated when explicitly requested via the expand parameter (e.g., ?expand=business_partners). When expanded, returns an empty list ([]) if the worker has no business partners.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiBusinessPartner77b00a069c32" }, "type": "array" }, "business_partners_id": { "description": "Worker's assigned business partners unique identifiers. Returns an empty list ([]) if the worker has no business partners.", "items": { "type": "string" }, "type": "array" }, "citizenship": { "description": "The countries that the worker has citizenship in.", "type": "string" }, "compensation": { "description": "The compensation package for the worker.\n\nExpandable field", "properties": { "annual_compensation": { "description": "The worker's annual compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "annual_salary_equivalent": { "description": "The worker's annual salary equivalent, for insurance purposes. It will be equal to the worker's annual compensation, except for owners that are receiving no cashcompensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "bonus_schedule": { "description": "The worker's bonus schedule.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "hourly_wage": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "id": { "description": "Identifier field", "type": "string" }, "monthly_compensation": { "description": "The worker's monthly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "on_target_commission": { "description": "The worker's on-target commission.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "payment_terms": { "description": "The payment terms for an worker's compensation.", "type": "string" }, "payment_type": { "description": "The payment type for an worker's compensation.", "type": "string" }, "relocation_reimbursement": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "salary_effective_date": { "description": "Salary effective date", "type": "string" }, "signing_bonus": { "description": "The worker's signing bonus.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus": { "description": "The worker's target annual bonus amount.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus_percent": { "anyOf": [ { "description": "The worker's target annual bonus as a percent of annual compensation.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" }, "weekly_compensation": { "description": "The worker's weekly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "worker": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's details.\n\nExpandable field", "type": "object" }, "worker_id": { "description": "The worker's ID.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Compensation", "type": "object" }, "compensation_grade": { "description": "The compensation grade assigned to the worker, if any.", "properties": { "id": { "description": "The compensation grade's unique identifier.", "type": "string" }, "label": { "description": "The compensation grade's label.", "type": "string" } }, "title": "WorkerCompensationGrade", "type": "object" }, "compensation_id": { "description": "The compensation package for the worker.", "type": "string" }, "country": { "description": "The worker's country.", "type": "string" }, "country_fields": { "description": "Country level fields for the worker.", "properties": { "ca": { "description": "Country-wise regional fields for Canada", "properties": { "sin": { "description": "Social Insurance Number (SIN) for Canada employees.", "type": "string" } }, "title": "CanadaFields", "type": "object" }, "nz": { "description": "Country-wise regional fields for New Zealand", "properties": { "ird_number": { "description": "Inland Revenue Department (IRD) number for New Zealand employees.", "type": "string" } }, "title": "NewZealandFields", "type": "object" }, "us": { "description": "Country-wise regional fields for USA", "properties": { "ssn": { "description": "Social Security Number (SSN) for US employees.", "type": "string" } }, "title": "USFields", "type": "object" } }, "title": "CountryFields", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "custom_fields": { "description": "Custom field values defined on the Employee object for this worker\n\nExpandable field", "items": { "additionalProperties": {} }, "type": "array" }, "date_of_birth": { "description": "The worker's date of birth.", "type": "string" }, "department": { "description": "The worker's assigned department.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "department_hierarchy": { "description": "List of departments in the department hierarchy. Refer department_hierarchy_ids for department hierarchy order.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestDepartment" }, "type": "array" }, "department_hierarchy_id": { "description": "The identifier of departments in the department hierarchy ordered from parent department to child department.", "items": { "type": "string" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the department.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestDepartment", "description": "The parent department.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent department.", "type": "string" }, "reference_code": { "description": "Reference code of the department.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Department", "type": "object" }, "department_id": { "description": "The worker's assigned department.", "type": "string" }, "employment_type": { "description": "The worker's employment type.\n\nExpandable field", "properties": { "amount_worked": { "description": "The amount worked for the employment type. * `FULL-TIME`: Full-time is at least 30 hours per week. Full-time workers will typically be eligible for benefits. * `PART-TIME`: Part-time is less than 30 hours per week. These workers may be eligible for benefits, depending on company settings and hours worked. * `TEMPORARY`: These workers are hired on a temporary basis. You can specify how each worker with this employment type will be paid individually.", "type": "string" }, "compensation_time_period": { "description": "The compensation period for the employment type. * `SALARIED`: Employees that are paid a fixed amount per year. * `HOURLY`: Employees that are paid a wage per hour worked.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "label": { "description": "The display label of the employment type.", "type": "string" }, "name": { "description": "The name of the employment type for non-custom employment types.", "type": "string" }, "type": { "description": "The classification of the worker by the company. * `CONTRACTOR`: Contractors are self-employed workers who provide services on a short-term or per-project basis and are not eligible for tax-withholding or benefits. * `EMPLOYEE`: Employees are hired and managed by an employer, work under the employer's direct supervision and control, and are protected by law for wages and employment rights.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "label", "updated_at" ], "title": "CompanyEmploymentType", "type": "object" }, "employment_type_id": { "description": "The worker's employment type.", "type": "string" }, "end_date": { "description": "The end date of the worker.", "type": "string" }, "ethnicity": { "description": "The identified ethnicity of the worker, if specified.", "type": "string" }, "gender": { "description": "The gender of the worker, if specified.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_manager": { "description": "Whether the worker is a manager", "type": "boolean" }, "job_function": { "description": "The worker's job function. When expanded, this field requires `job-functions.read`.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "Displayed name of the job function", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "JobFunction", "type": "object" }, "job_function_id": { "description": "ID of the worker's job function.", "type": "string" }, "legal_entity": { "description": "The worker's associated legal entity.\n\nExpandable field", "properties": { "company": { "description": "The company or organization associated with the legal entity\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "doing_business_as_name": { "description": "The doing business as name for the company.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_entities": { "description": "A list of the company's entities.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestLegalEntity" }, "type": "array" }, "legal_entities_id": { "description": "A list of the company's entities.", "items": { "type": "string" }, "type": "array" }, "legal_name": { "description": "The legal name of the company.", "type": "string" }, "name": { "description": "The name of the company.", "type": "string" }, "parent_legal_entity": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The company's ultimate holding entity.\n\nExpandable field", "type": "object" }, "parent_legal_entity_id": { "description": "The company's ultimate holding entity.", "type": "string" }, "phone": { "description": "The phone number for the company.", "type": "string" }, "physical_address": { "description": "The physical address of the holding entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "primary_email": { "description": "The email address used when registering this company.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "legal_entities", "legal_entities_id", "name", "updated_at" ], "title": "Company", "type": "object" }, "company_id": { "description": "The company or organization associated with the legal entity", "type": "string" }, "country": { "description": "The country the legal entity is based in.", "properties": { "code": { "description": "The code of the country.", "type": "string" } }, "required": [ "code" ], "title": "Country", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "entity_level": { "description": "The legal entity's level in a hierarchy. * `PARENT`: The legal entity is considered the ultimate holding entity. * `SUBSIDIARY`: The legal entity is considered a subsidiary, fully or partially held by another. * `BRANCH`: The legal entity is considered a branch, associated with a parent legal entity.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_name": { "description": "The legal name of the legal entity.", "type": "string" }, "mailing_address": { "description": "The mailing address of the legal entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "management_type": { "description": "The legal entity management type in the case of an employer of record (EOR) or professional employment organization (PEO). * `PEO`: The legal entity is considered a Professional Employment Organization (PEO). * `EOR`: The legal entity is considered an Employer of Record (EOR).", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The parent legal entity.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent legal entity.", "type": "string" }, "physical_address": { "description": "The physical address of the legal entity, if it differs from the mailing address.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "registration_date": { "description": "The registration date of the entity.", "type": "string" }, "tax_identifier": { "description": "The tax identifier for the legal entity.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "LegalEntity", "type": "object" }, "legal_entity_id": { "description": "The worker's associated legal entity.", "type": "string" }, "level": { "description": "The level of the worker.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "description": { "description": "The description of the level.", "type": "string" }, "experience_requirements": { "description": "The experience requirements for the level.", "type": "string" }, "global_level": { "anyOf": [ { "description": "Global level is used to track the seniority of levels. The higher up a level is placed on the page, the more senior and higher-ranked the level. Global level is used in workflows, policies, and reports that use the level attribute (e.g., you can use Level Lookup to set up a workflow that notifies the nearest person in an worker's management chain at or above the specified level).", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the level. Must be unique within the company or organization.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLevel", "description": "The parent level.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent level.", "type": "string" }, "rank": { "anyOf": [ { "description": "The rank of the level within its track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "scope_of_responsibilities": { "description": "The scope of responsibilities for the level.", "type": "string" }, "track": { "description": "The track associated with the level, if it's not a global level.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_default": { "description": "Whether this is the company's default track.", "type": "boolean" }, "name": { "description": "The name of the track. Must be unique within the company or organization.", "type": "string" }, "order": { "anyOf": [ { "description": "The one-based horizontal display order of the track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "start_global_level": { "anyOf": [ { "description": "The highest global level occupied by this track. Empty tracks return null.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Track", "type": "object" }, "track_id": { "description": "The track associated with the level. Required during creation. Include global_level when changing it.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Level", "type": "object" }, "level_id": { "description": "The level of the worker.", "type": "string" }, "location": { "description": "The location that the worker is mapped to for tax purposes. In the case that a worker is remote, the location's type is remote.", "properties": { "type": { "description": "The type of location.", "type": "string" }, "work_location_id": { "description": "The work location, if the worker isn't remote.", "type": "string" } }, "required": [ "type", "work_location_id" ], "title": "WorkerLocation", "type": "object" }, "manager": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's manager.\n\nExpandable field", "type": "object" }, "manager_id": { "description": "The worker's manager.", "type": "string" }, "number": { "anyOf": [ { "description": "The worker's number within the organization.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "original_start_date": { "description": "The worker's earliest start date across their employment history, excluding INIT roles.", "type": "string" }, "overtime_exemption": { "description": "The worker's overtime exemption status.", "type": "string" }, "pay_schedule_id": { "description": "The ID of the pay schedule currently associated with the worker.", "type": "string" }, "personal_email": { "description": "The worker's associated personal email address.", "type": "string" }, "race": { "description": "The identified race of the worker, if specified.", "type": "string" }, "start_date": { "description": "The start date of the worker.", "type": "string" }, "status": { "description": "The worker's status within the organization.", "type": "string" }, "teams": { "description": "The worker's assigned teams.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiTeamcb26bc28f32f" }, "type": "array" }, "teams_id": { "description": "The worker's assigned teams.", "items": { "type": "string" }, "type": "array" }, "termination_details": { "description": "The details of the worker's termination, if applicable.", "properties": { "reason": { "description": "This is a description that will be custom to each Rippling company.", "type": "string" }, "type": { "description": "The termination type indicates whether the termination was voluntary or involuntary.", "type": "string" } }, "title": "TerminationDetails", "type": "object" }, "title": { "description": "The worker's title.", "type": "string" }, "title_effective_date": { "description": "Title effective date", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "user": { "description": "The worker's associated user.\n\nExpandable field", "properties": { "active": { "description": "Whether the user is able to access company resources, typically when they are in actively engaged with the company and not after off-boarding.", "type": "boolean" }, "addresses": { "description": "The user's addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiUserAddressedd59b9ba9a1" }, "type": "array" }, "created_at": { "description": "Record creation date", "type": "string" }, "display_name": { "description": "The display name of the user using either the concatenated preferred given and family name or username depending on availability.", "type": "string" }, "emails": { "description": "The user's email addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiEmail5284c8258dc3" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "locale": { "description": "The User's default location for purposes of localization of currency, date time format, or numerical representations pursuant to RFC5646.", "type": "string" }, "name": { "description": "The user's name.", "properties": { "family_name": { "description": "The legal family name of the user, or last name in most Western languages.", "type": "string" }, "formatted": { "description": "The user's full name.", "type": "string" }, "given_name": { "description": "The given legal name of the user, or first name in most Western languages.", "type": "string" }, "middle_name": { "description": "The middle name(s) of the user.", "type": "string" }, "preferred_family_name": { "description": "The preferred family name, or last name in most Western languages, by the user.", "type": "string" }, "preferred_given_name": { "description": "The preferred given name, or first name in most Western languages, by the user.", "type": "string" } }, "title": "UserName", "type": "object" }, "number": { "description": "The permanent profile number of the user.", "type": "string" }, "phone_numbers": { "description": "The user's phone numbers.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoneNumber12060c61ecf5" }, "type": "array" }, "photos": { "description": "The user's photos.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoto2be7c3ae3f39" }, "type": "array" }, "preferred_language": { "description": "The User's preferred written or spoken language in the same format of the HTTP Accept-Language header, pursuant to Section 5.3.5 of RFC7231.", "type": "string" }, "timezone": { "description": "The User's current time zone in IANA database Olson format", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "username": { "description": "The unique identifier across Rippling used by the User for direct authentication into their associated company. Globally unique.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "User", "type": "object" }, "user_id": { "description": "The worker's associated user.", "type": "string" }, "work_email": { "description": "The worker's associated work email address.", "type": "string" }, "work_schedule": { "additionalProperties": { "$ref": "#/components/schemas/OutputRestApiWorkScheduleDay938f88d94f20" }, "description": "The worker's scheduled working hours for each day of the week.", "type": "object" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Worker", "type": "object" }, "worker_id": { "description": "The ID of the worker associated with the leave balance.", "type": "string" } }, "required": [ "created_at", "id", "updated_at", "worker_id" ], "title": "LeaveBalance", "type": "object" }, "OutputRestApiLeaveProgramResult481bd55806cf": { "description": "", "properties": { "components": { "description": "Legacy explanatory components for this program.", "items": { "$ref": "#/components/schemas/OutputRestApiResultComponent77279ce59534" }, "type": "array" }, "directives": { "description": "Bookable directives emitted by this program.", "properties": { "balance_adjustments": { "description": "Balance adjustment directives emitted by payable program results.", "items": { "$ref": "#/components/schemas/OutputRestApiBalanceAdjustmentInputab4e8d80def3" }, "type": "array" }, "earnings": { "description": "Payroll earning directives emitted by payable program results.", "items": { "$ref": "#/components/schemas/OutputRestApiEarningInput0e55076c2e04" }, "type": "array" }, "leave_request": { "description": "Leave request directive emitted by payable program results.", "properties": { "end_date": { "description": "Recommended leave request end date, if known.", "type": "string" }, "leave_type": { "description": "Leave type to use if booking a leave request from the evaluation.", "type": "string" }, "start_date": { "description": "Recommended leave request start date.", "type": "string" }, "status": { "description": "Optional leave request status to use when booking.", "type": "string" } }, "required": [ "leave_type", "start_date" ], "title": "LeaveRequestInput", "type": "object" } }, "title": "LeaveDirectives", "type": "object" }, "eligibility": { "description": "Derived eligibility status for this program.", "type": "string" }, "entitlement": { "description": "Time entitlement for this program, if any.", "properties": { "amount": { "description": "Entitlement amount serialized as a decimal string.", "type": "string" }, "leave_type": { "description": "Leave type associated with the entitlement.", "type": "string" }, "unit": { "description": "Unit for the entitlement amount, such as WEEKS, DAYS, or HOURS.", "type": "string" } }, "required": [ "amount", "leave_type", "unit" ], "title": "LeaveEntitlement", "type": "object" }, "gaps": { "description": "UNKNOWN evidence keys to fix before eligibility can be fully resolved.", "items": { "type": "string" }, "type": "array" }, "is_payable": { "description": "Whether the result is eligible and not blocked by payment-blocking requirements.", "type": "boolean" }, "job_protection": { "description": "Job-protection details for this program, if any.", "properties": { "continues_group_health": { "description": "Whether the program continues group health coverage.", "type": "boolean" }, "restoration": { "description": "Job-restoration right provided by the program.", "type": "string" } }, "required": [ "restoration" ], "title": "JobProtection", "type": "object" }, "pay_rate": { "description": "Estimated wage-replacement rate for this program, if any.", "properties": { "phases": { "description": "Wage-replacement phases for the program.", "items": { "$ref": "#/components/schemas/OutputRestApiPayPhase04495657e430" }, "type": "array" } }, "required": [ "phases" ], "title": "ProgramPayRate", "type": "object" }, "pay_source": { "description": "Who pays the employee for this program's wage-replacement slice.", "type": "string" }, "pay_summary": { "description": "Human-readable pay summary for this program.", "type": "string" }, "program_code": { "description": "Leave program code evaluated by the rules engine.", "type": "string" }, "program_requirements": { "description": "Outstanding artifacts or actions for this program.", "items": { "$ref": "#/components/schemas/OutputRestApiProgramRequirement9ceb24088439" }, "type": "array" }, "program_validations": { "description": "Eligibility and assumption validations run for this program.", "items": { "$ref": "#/components/schemas/OutputRestApiProgramValidation71fbcd5f7fcc" }, "type": "array" } }, "required": [ "eligibility", "gaps", "is_payable", "program_code", "program_validations" ], "title": "LeaveProgramResult", "type": "object" }, "OutputRestApiLeaveRequest738c6bddbfca": { "description": "", "properties": { "comments": { "description": "The comments associated with the leave request.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "days_take_off": { "description": "The specific dates taken off and the amount of time taken off for each one.", "items": { "$ref": "#/components/schemas/OutputRestApiDayOff9e4b21f07f8d" }, "type": "array" }, "end_date": { "description": "The end date of the leave request.", "type": "string" }, "end_time": { "description": "The end time of the leave request.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_managed_by_external_system": { "description": "Whether the leave request is managed by an external system.", "type": "boolean" }, "leave_event_id": { "description": "The ID of the leave event associated with the leave request, if any.", "type": "string" }, "leave_policy_id": { "description": "The ID of the leave policy associated with the leave request, either leave_policy_id or leave_type_id must be provided.", "type": "string" }, "leave_type": { "description": "The leave type associated with the leave request.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "description": { "description": "The description of the leave type.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_managed_by_external_system": { "description": "Whether the leave is managed by an external system.", "type": "boolean" }, "is_paid": { "description": "Whether the leave is paid.", "type": "boolean" }, "name": { "description": "The name of the leave type.", "type": "string" }, "type": { "description": "The type of leave.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "is_managed_by_external_system", "is_paid", "name", "type", "updated_at" ], "title": "LeaveType", "type": "object" }, "leave_type_id": { "description": "The ID of the leave type associated with the leave request, either leave_policy_id or leave_type_id must be provided.", "type": "string" }, "number_of_minutes_requested": { "anyOf": [ { "description": "The number of minutes requested for the leave request.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "reason_for_leave": { "description": "The reason for the leave request.", "type": "string" }, "requester": { "description": "The worker who requested the leave request.\n\nExpandable field", "properties": { "business_partners": { "description": "Worker's assigned business partners. This field is only populated when explicitly requested via the expand parameter (e.g., ?expand=business_partners). When expanded, returns an empty list ([]) if the worker has no business partners.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiBusinessPartner77b00a069c32" }, "type": "array" }, "business_partners_id": { "description": "Worker's assigned business partners unique identifiers. Returns an empty list ([]) if the worker has no business partners.", "items": { "type": "string" }, "type": "array" }, "citizenship": { "description": "The countries that the worker has citizenship in.", "type": "string" }, "compensation": { "description": "The compensation package for the worker.\n\nExpandable field", "properties": { "annual_compensation": { "description": "The worker's annual compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "annual_salary_equivalent": { "description": "The worker's annual salary equivalent, for insurance purposes. It will be equal to the worker's annual compensation, except for owners that are receiving no cashcompensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "bonus_schedule": { "description": "The worker's bonus schedule.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "hourly_wage": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "id": { "description": "Identifier field", "type": "string" }, "monthly_compensation": { "description": "The worker's monthly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "on_target_commission": { "description": "The worker's on-target commission.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "payment_terms": { "description": "The payment terms for an worker's compensation.", "type": "string" }, "payment_type": { "description": "The payment type for an worker's compensation.", "type": "string" }, "relocation_reimbursement": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "salary_effective_date": { "description": "Salary effective date", "type": "string" }, "signing_bonus": { "description": "The worker's signing bonus.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus": { "description": "The worker's target annual bonus amount.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus_percent": { "anyOf": [ { "description": "The worker's target annual bonus as a percent of annual compensation.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" }, "weekly_compensation": { "description": "The worker's weekly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "worker": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's details.\n\nExpandable field", "type": "object" }, "worker_id": { "description": "The worker's ID.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Compensation", "type": "object" }, "compensation_grade": { "description": "The compensation grade assigned to the worker, if any.", "properties": { "id": { "description": "The compensation grade's unique identifier.", "type": "string" }, "label": { "description": "The compensation grade's label.", "type": "string" } }, "title": "WorkerCompensationGrade", "type": "object" }, "compensation_id": { "description": "The compensation package for the worker.", "type": "string" }, "country": { "description": "The worker's country.", "type": "string" }, "country_fields": { "description": "Country level fields for the worker.", "properties": { "ca": { "description": "Country-wise regional fields for Canada", "properties": { "sin": { "description": "Social Insurance Number (SIN) for Canada employees.", "type": "string" } }, "title": "CanadaFields", "type": "object" }, "nz": { "description": "Country-wise regional fields for New Zealand", "properties": { "ird_number": { "description": "Inland Revenue Department (IRD) number for New Zealand employees.", "type": "string" } }, "title": "NewZealandFields", "type": "object" }, "us": { "description": "Country-wise regional fields for USA", "properties": { "ssn": { "description": "Social Security Number (SSN) for US employees.", "type": "string" } }, "title": "USFields", "type": "object" } }, "title": "CountryFields", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "custom_fields": { "description": "Custom field values defined on the Employee object for this worker\n\nExpandable field", "items": { "additionalProperties": {} }, "type": "array" }, "date_of_birth": { "description": "The worker's date of birth.", "type": "string" }, "department": { "description": "The worker's assigned department.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "department_hierarchy": { "description": "List of departments in the department hierarchy. Refer department_hierarchy_ids for department hierarchy order.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestDepartment" }, "type": "array" }, "department_hierarchy_id": { "description": "The identifier of departments in the department hierarchy ordered from parent department to child department.", "items": { "type": "string" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the department.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestDepartment", "description": "The parent department.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent department.", "type": "string" }, "reference_code": { "description": "Reference code of the department.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Department", "type": "object" }, "department_id": { "description": "The worker's assigned department.", "type": "string" }, "employment_type": { "description": "The worker's employment type.\n\nExpandable field", "properties": { "amount_worked": { "description": "The amount worked for the employment type. * `FULL-TIME`: Full-time is at least 30 hours per week. Full-time workers will typically be eligible for benefits. * `PART-TIME`: Part-time is less than 30 hours per week. These workers may be eligible for benefits, depending on company settings and hours worked. * `TEMPORARY`: These workers are hired on a temporary basis. You can specify how each worker with this employment type will be paid individually.", "type": "string" }, "compensation_time_period": { "description": "The compensation period for the employment type. * `SALARIED`: Employees that are paid a fixed amount per year. * `HOURLY`: Employees that are paid a wage per hour worked.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "label": { "description": "The display label of the employment type.", "type": "string" }, "name": { "description": "The name of the employment type for non-custom employment types.", "type": "string" }, "type": { "description": "The classification of the worker by the company. * `CONTRACTOR`: Contractors are self-employed workers who provide services on a short-term or per-project basis and are not eligible for tax-withholding or benefits. * `EMPLOYEE`: Employees are hired and managed by an employer, work under the employer's direct supervision and control, and are protected by law for wages and employment rights.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "label", "updated_at" ], "title": "CompanyEmploymentType", "type": "object" }, "employment_type_id": { "description": "The worker's employment type.", "type": "string" }, "end_date": { "description": "The end date of the worker.", "type": "string" }, "ethnicity": { "description": "The identified ethnicity of the worker, if specified.", "type": "string" }, "gender": { "description": "The gender of the worker, if specified.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_manager": { "description": "Whether the worker is a manager", "type": "boolean" }, "job_function": { "description": "The worker's job function. When expanded, this field requires `job-functions.read`.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "Displayed name of the job function", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "JobFunction", "type": "object" }, "job_function_id": { "description": "ID of the worker's job function.", "type": "string" }, "legal_entity": { "description": "The worker's associated legal entity.\n\nExpandable field", "properties": { "company": { "description": "The company or organization associated with the legal entity\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "doing_business_as_name": { "description": "The doing business as name for the company.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_entities": { "description": "A list of the company's entities.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestLegalEntity" }, "type": "array" }, "legal_entities_id": { "description": "A list of the company's entities.", "items": { "type": "string" }, "type": "array" }, "legal_name": { "description": "The legal name of the company.", "type": "string" }, "name": { "description": "The name of the company.", "type": "string" }, "parent_legal_entity": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The company's ultimate holding entity.\n\nExpandable field", "type": "object" }, "parent_legal_entity_id": { "description": "The company's ultimate holding entity.", "type": "string" }, "phone": { "description": "The phone number for the company.", "type": "string" }, "physical_address": { "description": "The physical address of the holding entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "primary_email": { "description": "The email address used when registering this company.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "legal_entities", "legal_entities_id", "name", "updated_at" ], "title": "Company", "type": "object" }, "company_id": { "description": "The company or organization associated with the legal entity", "type": "string" }, "country": { "description": "The country the legal entity is based in.", "properties": { "code": { "description": "The code of the country.", "type": "string" } }, "required": [ "code" ], "title": "Country", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "entity_level": { "description": "The legal entity's level in a hierarchy. * `PARENT`: The legal entity is considered the ultimate holding entity. * `SUBSIDIARY`: The legal entity is considered a subsidiary, fully or partially held by another. * `BRANCH`: The legal entity is considered a branch, associated with a parent legal entity.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_name": { "description": "The legal name of the legal entity.", "type": "string" }, "mailing_address": { "description": "The mailing address of the legal entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "management_type": { "description": "The legal entity management type in the case of an employer of record (EOR) or professional employment organization (PEO). * `PEO`: The legal entity is considered a Professional Employment Organization (PEO). * `EOR`: The legal entity is considered an Employer of Record (EOR).", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The parent legal entity.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent legal entity.", "type": "string" }, "physical_address": { "description": "The physical address of the legal entity, if it differs from the mailing address.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "registration_date": { "description": "The registration date of the entity.", "type": "string" }, "tax_identifier": { "description": "The tax identifier for the legal entity.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "LegalEntity", "type": "object" }, "legal_entity_id": { "description": "The worker's associated legal entity.", "type": "string" }, "level": { "description": "The level of the worker.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "description": { "description": "The description of the level.", "type": "string" }, "experience_requirements": { "description": "The experience requirements for the level.", "type": "string" }, "global_level": { "anyOf": [ { "description": "Global level is used to track the seniority of levels. The higher up a level is placed on the page, the more senior and higher-ranked the level. Global level is used in workflows, policies, and reports that use the level attribute (e.g., you can use Level Lookup to set up a workflow that notifies the nearest person in an worker's management chain at or above the specified level).", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the level. Must be unique within the company or organization.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLevel", "description": "The parent level.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent level.", "type": "string" }, "rank": { "anyOf": [ { "description": "The rank of the level within its track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "scope_of_responsibilities": { "description": "The scope of responsibilities for the level.", "type": "string" }, "track": { "description": "The track associated with the level, if it's not a global level.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_default": { "description": "Whether this is the company's default track.", "type": "boolean" }, "name": { "description": "The name of the track. Must be unique within the company or organization.", "type": "string" }, "order": { "anyOf": [ { "description": "The one-based horizontal display order of the track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "start_global_level": { "anyOf": [ { "description": "The highest global level occupied by this track. Empty tracks return null.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Track", "type": "object" }, "track_id": { "description": "The track associated with the level. Required during creation. Include global_level when changing it.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Level", "type": "object" }, "level_id": { "description": "The level of the worker.", "type": "string" }, "location": { "description": "The location that the worker is mapped to for tax purposes. In the case that a worker is remote, the location's type is remote.", "properties": { "type": { "description": "The type of location.", "type": "string" }, "work_location_id": { "description": "The work location, if the worker isn't remote.", "type": "string" } }, "required": [ "type", "work_location_id" ], "title": "WorkerLocation", "type": "object" }, "manager": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's manager.\n\nExpandable field", "type": "object" }, "manager_id": { "description": "The worker's manager.", "type": "string" }, "number": { "anyOf": [ { "description": "The worker's number within the organization.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "original_start_date": { "description": "The worker's earliest start date across their employment history, excluding INIT roles.", "type": "string" }, "overtime_exemption": { "description": "The worker's overtime exemption status.", "type": "string" }, "pay_schedule_id": { "description": "The ID of the pay schedule currently associated with the worker.", "type": "string" }, "personal_email": { "description": "The worker's associated personal email address.", "type": "string" }, "race": { "description": "The identified race of the worker, if specified.", "type": "string" }, "start_date": { "description": "The start date of the worker.", "type": "string" }, "status": { "description": "The worker's status within the organization.", "type": "string" }, "teams": { "description": "The worker's assigned teams.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiTeamcb26bc28f32f" }, "type": "array" }, "teams_id": { "description": "The worker's assigned teams.", "items": { "type": "string" }, "type": "array" }, "termination_details": { "description": "The details of the worker's termination, if applicable.", "properties": { "reason": { "description": "This is a description that will be custom to each Rippling company.", "type": "string" }, "type": { "description": "The termination type indicates whether the termination was voluntary or involuntary.", "type": "string" } }, "title": "TerminationDetails", "type": "object" }, "title": { "description": "The worker's title.", "type": "string" }, "title_effective_date": { "description": "Title effective date", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "user": { "description": "The worker's associated user.\n\nExpandable field", "properties": { "active": { "description": "Whether the user is able to access company resources, typically when they are in actively engaged with the company and not after off-boarding.", "type": "boolean" }, "addresses": { "description": "The user's addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiUserAddressedd59b9ba9a1" }, "type": "array" }, "created_at": { "description": "Record creation date", "type": "string" }, "display_name": { "description": "The display name of the user using either the concatenated preferred given and family name or username depending on availability.", "type": "string" }, "emails": { "description": "The user's email addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiEmail5284c8258dc3" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "locale": { "description": "The User's default location for purposes of localization of currency, date time format, or numerical representations pursuant to RFC5646.", "type": "string" }, "name": { "description": "The user's name.", "properties": { "family_name": { "description": "The legal family name of the user, or last name in most Western languages.", "type": "string" }, "formatted": { "description": "The user's full name.", "type": "string" }, "given_name": { "description": "The given legal name of the user, or first name in most Western languages.", "type": "string" }, "middle_name": { "description": "The middle name(s) of the user.", "type": "string" }, "preferred_family_name": { "description": "The preferred family name, or last name in most Western languages, by the user.", "type": "string" }, "preferred_given_name": { "description": "The preferred given name, or first name in most Western languages, by the user.", "type": "string" } }, "title": "UserName", "type": "object" }, "number": { "description": "The permanent profile number of the user.", "type": "string" }, "phone_numbers": { "description": "The user's phone numbers.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoneNumber12060c61ecf5" }, "type": "array" }, "photos": { "description": "The user's photos.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoto2be7c3ae3f39" }, "type": "array" }, "preferred_language": { "description": "The User's preferred written or spoken language in the same format of the HTTP Accept-Language header, pursuant to Section 5.3.5 of RFC7231.", "type": "string" }, "timezone": { "description": "The User's current time zone in IANA database Olson format", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "username": { "description": "The unique identifier across Rippling used by the User for direct authentication into their associated company. Globally unique.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "User", "type": "object" }, "user_id": { "description": "The worker's associated user.", "type": "string" }, "work_email": { "description": "The worker's associated work email address.", "type": "string" }, "work_schedule": { "additionalProperties": { "$ref": "#/components/schemas/OutputRestApiWorkScheduleDay938f88d94f20" }, "description": "The worker's scheduled working hours for each day of the week.", "type": "object" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Worker", "type": "object" }, "requester_id": { "description": "The ID of the worker who requested the leave request.", "type": "string" }, "reviewed_at": { "description": "The timestamp of when the leave request was reviewed.", "type": "string" }, "reviewer": { "description": "The worker who reviewed the leave request.\n\nExpandable field", "properties": { "business_partners": { "description": "Worker's assigned business partners. This field is only populated when explicitly requested via the expand parameter (e.g., ?expand=business_partners). When expanded, returns an empty list ([]) if the worker has no business partners.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiBusinessPartner77b00a069c32" }, "type": "array" }, "business_partners_id": { "description": "Worker's assigned business partners unique identifiers. Returns an empty list ([]) if the worker has no business partners.", "items": { "type": "string" }, "type": "array" }, "citizenship": { "description": "The countries that the worker has citizenship in.", "type": "string" }, "compensation": { "description": "The compensation package for the worker.\n\nExpandable field", "properties": { "annual_compensation": { "description": "The worker's annual compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "annual_salary_equivalent": { "description": "The worker's annual salary equivalent, for insurance purposes. It will be equal to the worker's annual compensation, except for owners that are receiving no cashcompensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "bonus_schedule": { "description": "The worker's bonus schedule.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "hourly_wage": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "id": { "description": "Identifier field", "type": "string" }, "monthly_compensation": { "description": "The worker's monthly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "on_target_commission": { "description": "The worker's on-target commission.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "payment_terms": { "description": "The payment terms for an worker's compensation.", "type": "string" }, "payment_type": { "description": "The payment type for an worker's compensation.", "type": "string" }, "relocation_reimbursement": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "salary_effective_date": { "description": "Salary effective date", "type": "string" }, "signing_bonus": { "description": "The worker's signing bonus.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus": { "description": "The worker's target annual bonus amount.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus_percent": { "anyOf": [ { "description": "The worker's target annual bonus as a percent of annual compensation.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" }, "weekly_compensation": { "description": "The worker's weekly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "worker": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's details.\n\nExpandable field", "type": "object" }, "worker_id": { "description": "The worker's ID.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Compensation", "type": "object" }, "compensation_grade": { "description": "The compensation grade assigned to the worker, if any.", "properties": { "id": { "description": "The compensation grade's unique identifier.", "type": "string" }, "label": { "description": "The compensation grade's label.", "type": "string" } }, "title": "WorkerCompensationGrade", "type": "object" }, "compensation_id": { "description": "The compensation package for the worker.", "type": "string" }, "country": { "description": "The worker's country.", "type": "string" }, "country_fields": { "description": "Country level fields for the worker.", "properties": { "ca": { "description": "Country-wise regional fields for Canada", "properties": { "sin": { "description": "Social Insurance Number (SIN) for Canada employees.", "type": "string" } }, "title": "CanadaFields", "type": "object" }, "nz": { "description": "Country-wise regional fields for New Zealand", "properties": { "ird_number": { "description": "Inland Revenue Department (IRD) number for New Zealand employees.", "type": "string" } }, "title": "NewZealandFields", "type": "object" }, "us": { "description": "Country-wise regional fields for USA", "properties": { "ssn": { "description": "Social Security Number (SSN) for US employees.", "type": "string" } }, "title": "USFields", "type": "object" } }, "title": "CountryFields", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "custom_fields": { "description": "Custom field values defined on the Employee object for this worker\n\nExpandable field", "items": { "additionalProperties": {} }, "type": "array" }, "date_of_birth": { "description": "The worker's date of birth.", "type": "string" }, "department": { "description": "The worker's assigned department.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "department_hierarchy": { "description": "List of departments in the department hierarchy. Refer department_hierarchy_ids for department hierarchy order.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestDepartment" }, "type": "array" }, "department_hierarchy_id": { "description": "The identifier of departments in the department hierarchy ordered from parent department to child department.", "items": { "type": "string" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the department.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestDepartment", "description": "The parent department.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent department.", "type": "string" }, "reference_code": { "description": "Reference code of the department.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Department", "type": "object" }, "department_id": { "description": "The worker's assigned department.", "type": "string" }, "employment_type": { "description": "The worker's employment type.\n\nExpandable field", "properties": { "amount_worked": { "description": "The amount worked for the employment type. * `FULL-TIME`: Full-time is at least 30 hours per week. Full-time workers will typically be eligible for benefits. * `PART-TIME`: Part-time is less than 30 hours per week. These workers may be eligible for benefits, depending on company settings and hours worked. * `TEMPORARY`: These workers are hired on a temporary basis. You can specify how each worker with this employment type will be paid individually.", "type": "string" }, "compensation_time_period": { "description": "The compensation period for the employment type. * `SALARIED`: Employees that are paid a fixed amount per year. * `HOURLY`: Employees that are paid a wage per hour worked.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "label": { "description": "The display label of the employment type.", "type": "string" }, "name": { "description": "The name of the employment type for non-custom employment types.", "type": "string" }, "type": { "description": "The classification of the worker by the company. * `CONTRACTOR`: Contractors are self-employed workers who provide services on a short-term or per-project basis and are not eligible for tax-withholding or benefits. * `EMPLOYEE`: Employees are hired and managed by an employer, work under the employer's direct supervision and control, and are protected by law for wages and employment rights.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "label", "updated_at" ], "title": "CompanyEmploymentType", "type": "object" }, "employment_type_id": { "description": "The worker's employment type.", "type": "string" }, "end_date": { "description": "The end date of the worker.", "type": "string" }, "ethnicity": { "description": "The identified ethnicity of the worker, if specified.", "type": "string" }, "gender": { "description": "The gender of the worker, if specified.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_manager": { "description": "Whether the worker is a manager", "type": "boolean" }, "job_function": { "description": "The worker's job function. When expanded, this field requires `job-functions.read`.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "Displayed name of the job function", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "JobFunction", "type": "object" }, "job_function_id": { "description": "ID of the worker's job function.", "type": "string" }, "legal_entity": { "description": "The worker's associated legal entity.\n\nExpandable field", "properties": { "company": { "description": "The company or organization associated with the legal entity\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "doing_business_as_name": { "description": "The doing business as name for the company.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_entities": { "description": "A list of the company's entities.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestLegalEntity" }, "type": "array" }, "legal_entities_id": { "description": "A list of the company's entities.", "items": { "type": "string" }, "type": "array" }, "legal_name": { "description": "The legal name of the company.", "type": "string" }, "name": { "description": "The name of the company.", "type": "string" }, "parent_legal_entity": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The company's ultimate holding entity.\n\nExpandable field", "type": "object" }, "parent_legal_entity_id": { "description": "The company's ultimate holding entity.", "type": "string" }, "phone": { "description": "The phone number for the company.", "type": "string" }, "physical_address": { "description": "The physical address of the holding entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "primary_email": { "description": "The email address used when registering this company.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "legal_entities", "legal_entities_id", "name", "updated_at" ], "title": "Company", "type": "object" }, "company_id": { "description": "The company or organization associated with the legal entity", "type": "string" }, "country": { "description": "The country the legal entity is based in.", "properties": { "code": { "description": "The code of the country.", "type": "string" } }, "required": [ "code" ], "title": "Country", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "entity_level": { "description": "The legal entity's level in a hierarchy. * `PARENT`: The legal entity is considered the ultimate holding entity. * `SUBSIDIARY`: The legal entity is considered a subsidiary, fully or partially held by another. * `BRANCH`: The legal entity is considered a branch, associated with a parent legal entity.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_name": { "description": "The legal name of the legal entity.", "type": "string" }, "mailing_address": { "description": "The mailing address of the legal entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "management_type": { "description": "The legal entity management type in the case of an employer of record (EOR) or professional employment organization (PEO). * `PEO`: The legal entity is considered a Professional Employment Organization (PEO). * `EOR`: The legal entity is considered an Employer of Record (EOR).", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The parent legal entity.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent legal entity.", "type": "string" }, "physical_address": { "description": "The physical address of the legal entity, if it differs from the mailing address.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "registration_date": { "description": "The registration date of the entity.", "type": "string" }, "tax_identifier": { "description": "The tax identifier for the legal entity.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "LegalEntity", "type": "object" }, "legal_entity_id": { "description": "The worker's associated legal entity.", "type": "string" }, "level": { "description": "The level of the worker.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "description": { "description": "The description of the level.", "type": "string" }, "experience_requirements": { "description": "The experience requirements for the level.", "type": "string" }, "global_level": { "anyOf": [ { "description": "Global level is used to track the seniority of levels. The higher up a level is placed on the page, the more senior and higher-ranked the level. Global level is used in workflows, policies, and reports that use the level attribute (e.g., you can use Level Lookup to set up a workflow that notifies the nearest person in an worker's management chain at or above the specified level).", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the level. Must be unique within the company or organization.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLevel", "description": "The parent level.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent level.", "type": "string" }, "rank": { "anyOf": [ { "description": "The rank of the level within its track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "scope_of_responsibilities": { "description": "The scope of responsibilities for the level.", "type": "string" }, "track": { "description": "The track associated with the level, if it's not a global level.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_default": { "description": "Whether this is the company's default track.", "type": "boolean" }, "name": { "description": "The name of the track. Must be unique within the company or organization.", "type": "string" }, "order": { "anyOf": [ { "description": "The one-based horizontal display order of the track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "start_global_level": { "anyOf": [ { "description": "The highest global level occupied by this track. Empty tracks return null.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Track", "type": "object" }, "track_id": { "description": "The track associated with the level. Required during creation. Include global_level when changing it.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Level", "type": "object" }, "level_id": { "description": "The level of the worker.", "type": "string" }, "location": { "description": "The location that the worker is mapped to for tax purposes. In the case that a worker is remote, the location's type is remote.", "properties": { "type": { "description": "The type of location.", "type": "string" }, "work_location_id": { "description": "The work location, if the worker isn't remote.", "type": "string" } }, "required": [ "type", "work_location_id" ], "title": "WorkerLocation", "type": "object" }, "manager": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's manager.\n\nExpandable field", "type": "object" }, "manager_id": { "description": "The worker's manager.", "type": "string" }, "number": { "anyOf": [ { "description": "The worker's number within the organization.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "original_start_date": { "description": "The worker's earliest start date across their employment history, excluding INIT roles.", "type": "string" }, "overtime_exemption": { "description": "The worker's overtime exemption status.", "type": "string" }, "pay_schedule_id": { "description": "The ID of the pay schedule currently associated with the worker.", "type": "string" }, "personal_email": { "description": "The worker's associated personal email address.", "type": "string" }, "race": { "description": "The identified race of the worker, if specified.", "type": "string" }, "start_date": { "description": "The start date of the worker.", "type": "string" }, "status": { "description": "The worker's status within the organization.", "type": "string" }, "teams": { "description": "The worker's assigned teams.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiTeamcb26bc28f32f" }, "type": "array" }, "teams_id": { "description": "The worker's assigned teams.", "items": { "type": "string" }, "type": "array" }, "termination_details": { "description": "The details of the worker's termination, if applicable.", "properties": { "reason": { "description": "This is a description that will be custom to each Rippling company.", "type": "string" }, "type": { "description": "The termination type indicates whether the termination was voluntary or involuntary.", "type": "string" } }, "title": "TerminationDetails", "type": "object" }, "title": { "description": "The worker's title.", "type": "string" }, "title_effective_date": { "description": "Title effective date", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "user": { "description": "The worker's associated user.\n\nExpandable field", "properties": { "active": { "description": "Whether the user is able to access company resources, typically when they are in actively engaged with the company and not after off-boarding.", "type": "boolean" }, "addresses": { "description": "The user's addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiUserAddressedd59b9ba9a1" }, "type": "array" }, "created_at": { "description": "Record creation date", "type": "string" }, "display_name": { "description": "The display name of the user using either the concatenated preferred given and family name or username depending on availability.", "type": "string" }, "emails": { "description": "The user's email addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiEmail5284c8258dc3" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "locale": { "description": "The User's default location for purposes of localization of currency, date time format, or numerical representations pursuant to RFC5646.", "type": "string" }, "name": { "description": "The user's name.", "properties": { "family_name": { "description": "The legal family name of the user, or last name in most Western languages.", "type": "string" }, "formatted": { "description": "The user's full name.", "type": "string" }, "given_name": { "description": "The given legal name of the user, or first name in most Western languages.", "type": "string" }, "middle_name": { "description": "The middle name(s) of the user.", "type": "string" }, "preferred_family_name": { "description": "The preferred family name, or last name in most Western languages, by the user.", "type": "string" }, "preferred_given_name": { "description": "The preferred given name, or first name in most Western languages, by the user.", "type": "string" } }, "title": "UserName", "type": "object" }, "number": { "description": "The permanent profile number of the user.", "type": "string" }, "phone_numbers": { "description": "The user's phone numbers.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoneNumber12060c61ecf5" }, "type": "array" }, "photos": { "description": "The user's photos.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoto2be7c3ae3f39" }, "type": "array" }, "preferred_language": { "description": "The User's preferred written or spoken language in the same format of the HTTP Accept-Language header, pursuant to Section 5.3.5 of RFC7231.", "type": "string" }, "timezone": { "description": "The User's current time zone in IANA database Olson format", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "username": { "description": "The unique identifier across Rippling used by the User for direct authentication into their associated company. Globally unique.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "User", "type": "object" }, "user_id": { "description": "The worker's associated user.", "type": "string" }, "work_email": { "description": "The worker's associated work email address.", "type": "string" }, "work_schedule": { "additionalProperties": { "$ref": "#/components/schemas/OutputRestApiWorkScheduleDay938f88d94f20" }, "description": "The worker's scheduled working hours for each day of the week.", "type": "object" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Worker", "type": "object" }, "reviewer_id": { "description": "The ID of the worker who reviewed the leave request.", "type": "string" }, "start_date": { "description": "The start date of the leave request.", "type": "string" }, "start_time": { "description": "The start time of the leave request.", "type": "string" }, "status": { "description": "The status of the leave request.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "worker": { "description": "The worker associated with the leave request.\n\nExpandable field", "properties": { "business_partners": { "description": "Worker's assigned business partners. This field is only populated when explicitly requested via the expand parameter (e.g., ?expand=business_partners). When expanded, returns an empty list ([]) if the worker has no business partners.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiBusinessPartner77b00a069c32" }, "type": "array" }, "business_partners_id": { "description": "Worker's assigned business partners unique identifiers. Returns an empty list ([]) if the worker has no business partners.", "items": { "type": "string" }, "type": "array" }, "citizenship": { "description": "The countries that the worker has citizenship in.", "type": "string" }, "compensation": { "description": "The compensation package for the worker.\n\nExpandable field", "properties": { "annual_compensation": { "description": "The worker's annual compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "annual_salary_equivalent": { "description": "The worker's annual salary equivalent, for insurance purposes. It will be equal to the worker's annual compensation, except for owners that are receiving no cashcompensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "bonus_schedule": { "description": "The worker's bonus schedule.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "hourly_wage": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "id": { "description": "Identifier field", "type": "string" }, "monthly_compensation": { "description": "The worker's monthly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "on_target_commission": { "description": "The worker's on-target commission.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "payment_terms": { "description": "The payment terms for an worker's compensation.", "type": "string" }, "payment_type": { "description": "The payment type for an worker's compensation.", "type": "string" }, "relocation_reimbursement": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "salary_effective_date": { "description": "Salary effective date", "type": "string" }, "signing_bonus": { "description": "The worker's signing bonus.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus": { "description": "The worker's target annual bonus amount.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus_percent": { "anyOf": [ { "description": "The worker's target annual bonus as a percent of annual compensation.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" }, "weekly_compensation": { "description": "The worker's weekly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "worker": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's details.\n\nExpandable field", "type": "object" }, "worker_id": { "description": "The worker's ID.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Compensation", "type": "object" }, "compensation_grade": { "description": "The compensation grade assigned to the worker, if any.", "properties": { "id": { "description": "The compensation grade's unique identifier.", "type": "string" }, "label": { "description": "The compensation grade's label.", "type": "string" } }, "title": "WorkerCompensationGrade", "type": "object" }, "compensation_id": { "description": "The compensation package for the worker.", "type": "string" }, "country": { "description": "The worker's country.", "type": "string" }, "country_fields": { "description": "Country level fields for the worker.", "properties": { "ca": { "description": "Country-wise regional fields for Canada", "properties": { "sin": { "description": "Social Insurance Number (SIN) for Canada employees.", "type": "string" } }, "title": "CanadaFields", "type": "object" }, "nz": { "description": "Country-wise regional fields for New Zealand", "properties": { "ird_number": { "description": "Inland Revenue Department (IRD) number for New Zealand employees.", "type": "string" } }, "title": "NewZealandFields", "type": "object" }, "us": { "description": "Country-wise regional fields for USA", "properties": { "ssn": { "description": "Social Security Number (SSN) for US employees.", "type": "string" } }, "title": "USFields", "type": "object" } }, "title": "CountryFields", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "custom_fields": { "description": "Custom field values defined on the Employee object for this worker\n\nExpandable field", "items": { "additionalProperties": {} }, "type": "array" }, "date_of_birth": { "description": "The worker's date of birth.", "type": "string" }, "department": { "description": "The worker's assigned department.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "department_hierarchy": { "description": "List of departments in the department hierarchy. Refer department_hierarchy_ids for department hierarchy order.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestDepartment" }, "type": "array" }, "department_hierarchy_id": { "description": "The identifier of departments in the department hierarchy ordered from parent department to child department.", "items": { "type": "string" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the department.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestDepartment", "description": "The parent department.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent department.", "type": "string" }, "reference_code": { "description": "Reference code of the department.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Department", "type": "object" }, "department_id": { "description": "The worker's assigned department.", "type": "string" }, "employment_type": { "description": "The worker's employment type.\n\nExpandable field", "properties": { "amount_worked": { "description": "The amount worked for the employment type. * `FULL-TIME`: Full-time is at least 30 hours per week. Full-time workers will typically be eligible for benefits. * `PART-TIME`: Part-time is less than 30 hours per week. These workers may be eligible for benefits, depending on company settings and hours worked. * `TEMPORARY`: These workers are hired on a temporary basis. You can specify how each worker with this employment type will be paid individually.", "type": "string" }, "compensation_time_period": { "description": "The compensation period for the employment type. * `SALARIED`: Employees that are paid a fixed amount per year. * `HOURLY`: Employees that are paid a wage per hour worked.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "label": { "description": "The display label of the employment type.", "type": "string" }, "name": { "description": "The name of the employment type for non-custom employment types.", "type": "string" }, "type": { "description": "The classification of the worker by the company. * `CONTRACTOR`: Contractors are self-employed workers who provide services on a short-term or per-project basis and are not eligible for tax-withholding or benefits. * `EMPLOYEE`: Employees are hired and managed by an employer, work under the employer's direct supervision and control, and are protected by law for wages and employment rights.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "label", "updated_at" ], "title": "CompanyEmploymentType", "type": "object" }, "employment_type_id": { "description": "The worker's employment type.", "type": "string" }, "end_date": { "description": "The end date of the worker.", "type": "string" }, "ethnicity": { "description": "The identified ethnicity of the worker, if specified.", "type": "string" }, "gender": { "description": "The gender of the worker, if specified.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_manager": { "description": "Whether the worker is a manager", "type": "boolean" }, "job_function": { "description": "The worker's job function. When expanded, this field requires `job-functions.read`.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "Displayed name of the job function", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "JobFunction", "type": "object" }, "job_function_id": { "description": "ID of the worker's job function.", "type": "string" }, "legal_entity": { "description": "The worker's associated legal entity.\n\nExpandable field", "properties": { "company": { "description": "The company or organization associated with the legal entity\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "doing_business_as_name": { "description": "The doing business as name for the company.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_entities": { "description": "A list of the company's entities.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestLegalEntity" }, "type": "array" }, "legal_entities_id": { "description": "A list of the company's entities.", "items": { "type": "string" }, "type": "array" }, "legal_name": { "description": "The legal name of the company.", "type": "string" }, "name": { "description": "The name of the company.", "type": "string" }, "parent_legal_entity": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The company's ultimate holding entity.\n\nExpandable field", "type": "object" }, "parent_legal_entity_id": { "description": "The company's ultimate holding entity.", "type": "string" }, "phone": { "description": "The phone number for the company.", "type": "string" }, "physical_address": { "description": "The physical address of the holding entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "primary_email": { "description": "The email address used when registering this company.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "legal_entities", "legal_entities_id", "name", "updated_at" ], "title": "Company", "type": "object" }, "company_id": { "description": "The company or organization associated with the legal entity", "type": "string" }, "country": { "description": "The country the legal entity is based in.", "properties": { "code": { "description": "The code of the country.", "type": "string" } }, "required": [ "code" ], "title": "Country", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "entity_level": { "description": "The legal entity's level in a hierarchy. * `PARENT`: The legal entity is considered the ultimate holding entity. * `SUBSIDIARY`: The legal entity is considered a subsidiary, fully or partially held by another. * `BRANCH`: The legal entity is considered a branch, associated with a parent legal entity.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_name": { "description": "The legal name of the legal entity.", "type": "string" }, "mailing_address": { "description": "The mailing address of the legal entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "management_type": { "description": "The legal entity management type in the case of an employer of record (EOR) or professional employment organization (PEO). * `PEO`: The legal entity is considered a Professional Employment Organization (PEO). * `EOR`: The legal entity is considered an Employer of Record (EOR).", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The parent legal entity.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent legal entity.", "type": "string" }, "physical_address": { "description": "The physical address of the legal entity, if it differs from the mailing address.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "registration_date": { "description": "The registration date of the entity.", "type": "string" }, "tax_identifier": { "description": "The tax identifier for the legal entity.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "LegalEntity", "type": "object" }, "legal_entity_id": { "description": "The worker's associated legal entity.", "type": "string" }, "level": { "description": "The level of the worker.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "description": { "description": "The description of the level.", "type": "string" }, "experience_requirements": { "description": "The experience requirements for the level.", "type": "string" }, "global_level": { "anyOf": [ { "description": "Global level is used to track the seniority of levels. The higher up a level is placed on the page, the more senior and higher-ranked the level. Global level is used in workflows, policies, and reports that use the level attribute (e.g., you can use Level Lookup to set up a workflow that notifies the nearest person in an worker's management chain at or above the specified level).", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the level. Must be unique within the company or organization.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLevel", "description": "The parent level.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent level.", "type": "string" }, "rank": { "anyOf": [ { "description": "The rank of the level within its track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "scope_of_responsibilities": { "description": "The scope of responsibilities for the level.", "type": "string" }, "track": { "description": "The track associated with the level, if it's not a global level.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_default": { "description": "Whether this is the company's default track.", "type": "boolean" }, "name": { "description": "The name of the track. Must be unique within the company or organization.", "type": "string" }, "order": { "anyOf": [ { "description": "The one-based horizontal display order of the track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "start_global_level": { "anyOf": [ { "description": "The highest global level occupied by this track. Empty tracks return null.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Track", "type": "object" }, "track_id": { "description": "The track associated with the level. Required during creation. Include global_level when changing it.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Level", "type": "object" }, "level_id": { "description": "The level of the worker.", "type": "string" }, "location": { "description": "The location that the worker is mapped to for tax purposes. In the case that a worker is remote, the location's type is remote.", "properties": { "type": { "description": "The type of location.", "type": "string" }, "work_location_id": { "description": "The work location, if the worker isn't remote.", "type": "string" } }, "required": [ "type", "work_location_id" ], "title": "WorkerLocation", "type": "object" }, "manager": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's manager.\n\nExpandable field", "type": "object" }, "manager_id": { "description": "The worker's manager.", "type": "string" }, "number": { "anyOf": [ { "description": "The worker's number within the organization.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "original_start_date": { "description": "The worker's earliest start date across their employment history, excluding INIT roles.", "type": "string" }, "overtime_exemption": { "description": "The worker's overtime exemption status.", "type": "string" }, "pay_schedule_id": { "description": "The ID of the pay schedule currently associated with the worker.", "type": "string" }, "personal_email": { "description": "The worker's associated personal email address.", "type": "string" }, "race": { "description": "The identified race of the worker, if specified.", "type": "string" }, "start_date": { "description": "The start date of the worker.", "type": "string" }, "status": { "description": "The worker's status within the organization.", "type": "string" }, "teams": { "description": "The worker's assigned teams.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiTeamcb26bc28f32f" }, "type": "array" }, "teams_id": { "description": "The worker's assigned teams.", "items": { "type": "string" }, "type": "array" }, "termination_details": { "description": "The details of the worker's termination, if applicable.", "properties": { "reason": { "description": "This is a description that will be custom to each Rippling company.", "type": "string" }, "type": { "description": "The termination type indicates whether the termination was voluntary or involuntary.", "type": "string" } }, "title": "TerminationDetails", "type": "object" }, "title": { "description": "The worker's title.", "type": "string" }, "title_effective_date": { "description": "Title effective date", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "user": { "description": "The worker's associated user.\n\nExpandable field", "properties": { "active": { "description": "Whether the user is able to access company resources, typically when they are in actively engaged with the company and not after off-boarding.", "type": "boolean" }, "addresses": { "description": "The user's addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiUserAddressedd59b9ba9a1" }, "type": "array" }, "created_at": { "description": "Record creation date", "type": "string" }, "display_name": { "description": "The display name of the user using either the concatenated preferred given and family name or username depending on availability.", "type": "string" }, "emails": { "description": "The user's email addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiEmail5284c8258dc3" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "locale": { "description": "The User's default location for purposes of localization of currency, date time format, or numerical representations pursuant to RFC5646.", "type": "string" }, "name": { "description": "The user's name.", "properties": { "family_name": { "description": "The legal family name of the user, or last name in most Western languages.", "type": "string" }, "formatted": { "description": "The user's full name.", "type": "string" }, "given_name": { "description": "The given legal name of the user, or first name in most Western languages.", "type": "string" }, "middle_name": { "description": "The middle name(s) of the user.", "type": "string" }, "preferred_family_name": { "description": "The preferred family name, or last name in most Western languages, by the user.", "type": "string" }, "preferred_given_name": { "description": "The preferred given name, or first name in most Western languages, by the user.", "type": "string" } }, "title": "UserName", "type": "object" }, "number": { "description": "The permanent profile number of the user.", "type": "string" }, "phone_numbers": { "description": "The user's phone numbers.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoneNumber12060c61ecf5" }, "type": "array" }, "photos": { "description": "The user's photos.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoto2be7c3ae3f39" }, "type": "array" }, "preferred_language": { "description": "The User's preferred written or spoken language in the same format of the HTTP Accept-Language header, pursuant to Section 5.3.5 of RFC7231.", "type": "string" }, "timezone": { "description": "The User's current time zone in IANA database Olson format", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "username": { "description": "The unique identifier across Rippling used by the User for direct authentication into their associated company. Globally unique.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "User", "type": "object" }, "user_id": { "description": "The worker's associated user.", "type": "string" }, "work_email": { "description": "The worker's associated work email address.", "type": "string" }, "work_schedule": { "additionalProperties": { "$ref": "#/components/schemas/OutputRestApiWorkScheduleDay938f88d94f20" }, "description": "The worker's scheduled working hours for each day of the week.", "type": "object" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Worker", "type": "object" }, "worker_id": { "description": "The ID of the worker associated with the leave request.", "type": "string" } }, "required": [ "created_at", "end_date", "id", "start_date", "status", "updated_at", "worker_id" ], "title": "LeaveRequest", "type": "object" }, "OutputRestApiLeaveType6364e802816f": { "description": "", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "description": { "description": "The description of the leave type.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_managed_by_external_system": { "description": "Whether the leave is managed by an external system.", "type": "boolean" }, "is_paid": { "description": "Whether the leave is paid.", "type": "boolean" }, "name": { "description": "The name of the leave type.", "type": "string" }, "type": { "description": "The type of leave.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "is_managed_by_external_system", "is_paid", "name", "type", "updated_at" ], "title": "LeaveType", "type": "object" }, "OutputRestApiLegalEntity2a1da2cfa26b": { "description": "", "properties": { "company": { "description": "The company or organization associated with the legal entity\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "doing_business_as_name": { "description": "The doing business as name for the company.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_entities": { "description": "A list of the company's entities.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestLegalEntity" }, "type": "array" }, "legal_entities_id": { "description": "A list of the company's entities.", "items": { "type": "string" }, "type": "array" }, "legal_name": { "description": "The legal name of the company.", "type": "string" }, "name": { "description": "The name of the company.", "type": "string" }, "parent_legal_entity": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The company's ultimate holding entity.\n\nExpandable field", "type": "object" }, "parent_legal_entity_id": { "description": "The company's ultimate holding entity.", "type": "string" }, "phone": { "description": "The phone number for the company.", "type": "string" }, "physical_address": { "description": "The physical address of the holding entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "primary_email": { "description": "The email address used when registering this company.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "legal_entities", "legal_entities_id", "name", "updated_at" ], "title": "Company", "type": "object" }, "company_id": { "description": "The company or organization associated with the legal entity", "type": "string" }, "country": { "description": "The country the legal entity is based in.", "properties": { "code": { "description": "The code of the country.", "type": "string" } }, "required": [ "code" ], "title": "Country", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "entity_level": { "description": "The legal entity's level in a hierarchy. * `PARENT`: The legal entity is considered the ultimate holding entity. * `SUBSIDIARY`: The legal entity is considered a subsidiary, fully or partially held by another. * `BRANCH`: The legal entity is considered a branch, associated with a parent legal entity.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_name": { "description": "The legal name of the legal entity.", "type": "string" }, "mailing_address": { "description": "The mailing address of the legal entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "management_type": { "description": "The legal entity management type in the case of an employer of record (EOR) or professional employment organization (PEO). * `PEO`: The legal entity is considered a Professional Employment Organization (PEO). * `EOR`: The legal entity is considered an Employer of Record (EOR).", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The parent legal entity.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent legal entity.", "type": "string" }, "physical_address": { "description": "The physical address of the legal entity, if it differs from the mailing address.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "registration_date": { "description": "The registration date of the entity.", "type": "string" }, "tax_identifier": { "description": "The tax identifier for the legal entity.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "LegalEntity", "type": "object" }, "OutputRestApiLegalEntity9c4b5c98341c": { "description": "", "properties": { "company": { "$ref": "#/components/schemas/OutputRestCompany", "description": "The company or organization associated with the legal entity\n\nExpandable field", "type": "object" }, "company_id": { "description": "The company or organization associated with the legal entity", "type": "string" }, "country": { "description": "The country the legal entity is based in.", "properties": { "code": { "description": "The code of the country.", "type": "string" } }, "required": [ "code" ], "title": "Country", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "entity_level": { "description": "The legal entity's level in a hierarchy. * `PARENT`: The legal entity is considered the ultimate holding entity. * `SUBSIDIARY`: The legal entity is considered a subsidiary, fully or partially held by another. * `BRANCH`: The legal entity is considered a branch, associated with a parent legal entity.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_name": { "description": "The legal name of the legal entity.", "type": "string" }, "mailing_address": { "description": "The mailing address of the legal entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "management_type": { "description": "The legal entity management type in the case of an employer of record (EOR) or professional employment organization (PEO). * `PEO`: The legal entity is considered a Professional Employment Organization (PEO). * `EOR`: The legal entity is considered an Employer of Record (EOR).", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The parent legal entity.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent legal entity.", "type": "string" }, "physical_address": { "description": "The physical address of the legal entity, if it differs from the mailing address.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "registration_date": { "description": "The registration date of the entity.", "type": "string" }, "tax_identifier": { "description": "The tax identifier for the legal entity.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "LegalEntity", "type": "object" }, "OutputRestApiLevel7fec16190787": { "description": "", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "description": { "description": "The description of the level.", "type": "string" }, "experience_requirements": { "description": "The experience requirements for the level.", "type": "string" }, "global_level": { "anyOf": [ { "description": "Global level is used to track the seniority of levels. The higher up a level is placed on the page, the more senior and higher-ranked the level. Global level is used in workflows, policies, and reports that use the level attribute (e.g., you can use Level Lookup to set up a workflow that notifies the nearest person in an worker's management chain at or above the specified level).", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the level. Must be unique within the company or organization.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLevel", "description": "The parent level.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent level.", "type": "string" }, "rank": { "anyOf": [ { "description": "The rank of the level within its track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "scope_of_responsibilities": { "description": "The scope of responsibilities for the level.", "type": "string" }, "track": { "description": "The track associated with the level, if it's not a global level.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_default": { "description": "Whether this is the company's default track.", "type": "boolean" }, "name": { "description": "The name of the track. Must be unique within the company or organization.", "type": "string" }, "order": { "anyOf": [ { "description": "The one-based horizontal display order of the track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "start_global_level": { "anyOf": [ { "description": "The highest global level occupied by this track. Empty tracks return null.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Track", "type": "object" }, "track_id": { "description": "The track associated with the level. Required during creation. Include global_level when changing it.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Level", "type": "object" }, "OutputRestApiLineItem8d6adc67985a": { "description": "", "properties": { "amount": { "description": "Amount of this split, in the merchant currency. The `value` is a decimal string.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "category_id": { "description": "ID of the Spend category assigned to this split. No public API is currently available to retrieve this category; its name is in `category_name`.", "type": "string" }, "category_name": { "description": "Name of the spend category.", "type": "string" }, "dimension_choices": { "additionalProperties": { "$ref": "#/components/schemas/OutputRestApiDimensionChoice299d74541a33" }, "description": "Selected dimension values, keyed by dimension ID. Includes department and work location.", "type": "object" }, "gl_billable": { "description": "Whether this split is billed to `gl_customer` in the accounting system. `BILLABLE` means it is billed, `NOT_BILLABLE` means it is not. Null when not set.", "type": "string" }, "gl_customer": { "description": "ID of the customer record in the connected accounting integration. No public Rippling API is currently available to retrieve this accounting customer.", "type": "string" }, "memo": { "description": "Memo entered on this split.", "type": "string" } }, "title": "LineItem", "type": "object" }, "OutputRestApiListingDTO158d299ad06e": { "description": "", "properties": { "created_at": { "description": "Creation timestamp.", "type": "string" }, "draft_status": { "description": "The current draft-cycle slot status.", "type": "string" }, "draft_version": { "description": "The current editable or review listing version.", "properties": { "catalog_binding_id": { "description": "The package ID tied to this listing.", "type": "string" }, "catalog_binding_version_id": { "description": "The package version ID selected by this listing version.", "type": "string" }, "created_at": { "description": "Creation timestamp.", "type": "string" }, "display_name": { "description": "The display name for this version.", "type": "string" }, "id": { "description": "The listing version ID.", "type": "string" }, "latest_submission_notes": { "description": "The latest notes submitted for review.", "type": "string" }, "metadata": { "description": "Listing metadata for this version.", "type": "object" }, "published_at": { "description": "Publish timestamp.", "type": "string" }, "status": { "description": "The lifecycle status for this version.", "type": "string" }, "updated_at": { "description": "Last update timestamp.", "type": "string" }, "version_name": { "description": "The publisher-visible version label.", "type": "string" } }, "title": "ListingVersionDTO", "type": "object" }, "draft_version_id": { "description": "The current draft-cycle version ID.", "type": "string" }, "icon": { "description": "The listing icon URL.", "type": "string" }, "listing_id": { "description": "The listing ID.", "type": "string" }, "name": { "description": "The listing name or display name.", "type": "string" }, "owner_company_id": { "description": "The publisher company ID that owns this listing.", "type": "string" }, "published_or_delisted_version": { "description": "The current published or delisted listing version.", "properties": { "catalog_binding_id": { "description": "The package ID tied to this listing.", "type": "string" }, "catalog_binding_version_id": { "description": "The package version ID selected by this listing version.", "type": "string" }, "created_at": { "description": "Creation timestamp.", "type": "string" }, "display_name": { "description": "The display name for this version.", "type": "string" }, "id": { "description": "The listing version ID.", "type": "string" }, "latest_submission_notes": { "description": "The latest notes submitted for review.", "type": "string" }, "metadata": { "description": "Listing metadata for this version.", "type": "object" }, "published_at": { "description": "Publish timestamp.", "type": "string" }, "status": { "description": "The lifecycle status for this version.", "type": "string" }, "updated_at": { "description": "Last update timestamp.", "type": "string" }, "version_name": { "description": "The publisher-visible version label.", "type": "string" } }, "title": "ListingVersionDTO", "type": "object" }, "published_status": { "description": "The current published slot status.", "type": "string" }, "published_version_id": { "description": "The current published or delisted version ID.", "type": "string" }, "status": { "description": "The listing lifecycle status.", "type": "string" }, "type": { "description": "The listing app type.", "type": "string" }, "updated_at": { "description": "Last update timestamp.", "type": "string" } }, "title": "ListingDTO", "type": "object" }, "OutputRestApiListingSubmissionDTO44917773da9e": { "description": "", "properties": { "created_at": { "description": "Creation timestamp.", "type": "string" }, "listing_id": { "description": "The parent listing ID.", "type": "string" }, "notes": { "description": "The latest submitted notes.", "type": "string" }, "status": { "description": "The submission lifecycle status.", "type": "string" }, "submission_id": { "description": "The submitted listing version ID.", "type": "string" }, "updated_at": { "description": "Last update timestamp.", "type": "string" } }, "title": "ListingSubmissionDTO", "type": "object" }, "OutputRestApiListingTransitionDTO5ffc5dcf7b52": { "description": "", "properties": { "action": { "description": "The lifecycle action recorded for this activity item.", "type": "string" }, "actor_id": { "description": "The actor role ID that performed the action.", "type": "string" }, "comment": { "description": "Optional comment recorded with the action.", "type": "string" }, "listing_id": { "description": "The parent listing ID.", "type": "string" }, "new_status": { "description": "The new lifecycle status.", "type": "string" }, "previous_status": { "description": "The previous lifecycle status.", "type": "string" }, "submission_id": { "description": "The listing version ID associated with this activity.", "type": "string" }, "timestamp": { "description": "Activity timestamp.", "type": "string" } }, "title": "ListingTransitionDTO", "type": "object" }, "OutputRestApiLocationFactoref8b04003273": { "description": "", "properties": { "adjustment_factor": { "anyOf": [ { "description": "Compensation adjustment percentage", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "country": { "description": "Country information set to the country code", "properties": { "code": { "description": "The code of the country.", "type": "string" } }, "required": [ "code" ], "title": "Country", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "display_name": { "description": "Human-readable name for the location factor", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "labour_bucket": { "description": "The labor market category (e.g., \"Engineering\", \"Marketing\", \"Sales\")", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "LocationFactor", "type": "object" }, "OutputRestApiManualTrigger01b0ac4a464d": { "additionalProperties": false, "properties": { "kind": { "type": "string" } }, "required": [ "kind" ], "title": "ManualTrigger", "type": "object" }, "OutputRestApiMetadataCommonMistake1e2d1c41f872": { "properties": { "message": { "description": "Explanation of the correction.", "type": "string" }, "right": { "description": "Corrected example.", "type": "string" }, "wrong": { "description": "Invalid or discouraged example.", "type": "string" } }, "required": [ "message", "right", "wrong" ], "title": "MetadataCommonMistake", "type": "object" }, "OutputRestApiMetadataComponentInstallation5e5fb7f67786": { "additionalProperties": true, "properties": { "identifier": { "additionalProperties": true, "description": "Installed component identifier.", "type": "object" }, "navigation_target": { "anyOf": [ { "description": "Navigation target for the installed component, when available.", "properties": { "target_type": { "description": "Type of UI target.", "type": "string" }, "title": { "description": "Display title for the navigation target.", "type": "string" }, "url": { "description": "Relative URL for the installed component.", "type": "string" } }, "required": [ "target_type", "title", "url" ], "title": "MetadataDeployNavigationTarget", "type": "object" }, { "type": "null" } ] }, "result": { "additionalProperties": true, "description": "Type-specific install result.", "type": "object" }, "status": { "description": "Per-component install result.", "type": "string" }, "type": { "description": "Metadata component type.", "type": "string" } }, "required": [ "identifier", "status", "type" ], "title": "MetadataComponentInstallation", "type": "object" }, "OutputRestApiMetadataComponentValidationResult2e20652b844a": { "additionalProperties": true, "properties": { "errors": { "items": { "$ref": "#/components/schemas/OutputRestApiMetadataIssue2141b9b78899" }, "type": "array" }, "existing": { "additionalProperties": true, "description": "Existing component config matched by the identifier, when available.", "type": "object" }, "identifier": { "additionalProperties": true, "description": "Resolved component identifier.", "type": "object" }, "merged": { "additionalProperties": true, "description": "Merged target state for updates, when available.", "type": "object" }, "normalized": { "additionalProperties": true, "description": "Schema-normalized component config.", "type": "object" }, "outcome": { "anyOf": [ { "description": "Upsert classification computed during validation.", "type": "string" }, { "type": "null" } ] }, "type": { "description": "Metadata component type.", "type": "string" }, "valid": { "description": "Whether this component passed validation.", "type": "boolean" } }, "required": [ "type", "valid" ], "title": "MetadataComponentValidationResult", "type": "object" }, "OutputRestApiMetadataComposerComponent8c0980db1208": { "additionalProperties": true, "description": "A metadata component config. The `type` field selects the concrete component schema. Fetch type-specific fields from GET /metadata/schema/?type=.", "properties": { "type": { "description": "Metadata component type, such as CUSTOM_OBJECT or CUSTOM_OBJECT_FIELD.", "type": "string" } }, "required": [ "type" ], "title": "MetadataComposerComponent", "type": "object" }, "OutputRestApiMetadataDeployResponse35168315e63e": { "properties": { "error": { "$ref": "#/components/schemas/OutputRestApiMetadataIssue2141b9b78899" }, "installations": { "description": "Per-component deployment results.", "items": { "$ref": "#/components/schemas/OutputRestApiMetadataComponentInstallation5e5fb7f67786" }, "type": "array" }, "success": { "description": "Whether the package deployment completed.", "type": "boolean" } }, "required": [ "installations", "success" ], "title": "MetadataDeployResponse", "type": "object" }, "OutputRestApiMetadataExtractByIdentifiersResponse67d1c02dc278": { "additionalProperties": false, "properties": { "component_configs": { "description": "Readable component configs for the requested roots. Unreadable dependencies are omitted, so the result may not be deployable as-is.", "items": { "$ref": "#/components/schemas/OutputRestApiMetadataComposerComponent8c0980db1208" }, "type": "array" }, "external_managed_dependencies": { "items": { "additionalProperties": true, "description": "External managed dependency.", "type": "object" }, "type": "array" }, "install_order": { "description": "Topological install order for the extracted package.", "items": { "additionalProperties": true, "description": "Component identifier.", "type": "object" }, "type": "array" } }, "required": [ "component_configs", "external_managed_dependencies", "install_order" ], "title": "MetadataExtractByIdentifiersResponse", "type": "object" }, "OutputRestApiMetadataExtractResponsedc528867e38a": { "additionalProperties": true, "properties": { "component_configs": { "description": "Readable component configs for the selected roots. Dependencies the caller cannot read are omitted, so the result may not be deployable as-is.", "items": { "$ref": "#/components/schemas/OutputRestApiMetadataComposerComponent8c0980db1208" }, "type": "array" }, "context_complete": { "description": "For search-backed extraction, whether contextual expansion completed without warnings or unreadable components being omitted.", "type": "boolean" }, "context_warnings": { "description": "Warnings from search-backed contextual expansion.", "items": { "type": "string" }, "type": "array" }, "dependency_graph": { "additionalProperties": true, "description": "Serialized dependency graph for the extracted package.", "type": "object" }, "external_managed_dependencies": { "items": { "additionalProperties": true, "description": "External managed dependency.", "type": "object" }, "type": "array" }, "install_order": { "description": "Topological install order for the extracted package.", "items": { "additionalProperties": true, "description": "Component identifier.", "type": "object" }, "type": "array" }, "root_components": { "description": "Components selected as extraction roots.", "items": { "$ref": "#/components/schemas/OutputRestApiMetadataRootComponentb5049c352360" }, "type": "array" } }, "required": [ "component_configs", "dependency_graph", "install_order", "root_components" ], "title": "MetadataExtractResponse", "type": "object" }, "OutputRestApiMetadataIssue2141b9b78899": { "additionalProperties": true, "description": "A validation, dependency, permission, or deployment issue.", "properties": { "cause": { "anyOf": [ { "description": "Lower-level cause associated with the issue, when available.", "type": "string" }, { "type": "null" } ] }, "code": { "description": "Stable machine-readable issue code.", "type": "string" }, "component_type": { "anyOf": [ { "description": "Component type associated with the issue, when available.", "type": "string" }, { "type": "null" } ] }, "message": { "description": "Human-readable remediation message.", "type": "string" } }, "required": [ "code", "message" ], "title": "MetadataIssue", "type": "object" }, "OutputRestApiMetadataRootComponentb5049c352360": { "additionalProperties": true, "description": "Selectable package root returned by metadata extraction.", "properties": { "identifier": { "additionalProperties": true, "description": "Identifier for the selected component.", "type": "object" }, "name": { "description": "Display name for the selectable component.", "type": "string" } }, "title": "MetadataRootComponent", "type": "object" }, "OutputRestApiMetadataTypeSchema11511d8b37c8": { "additionalProperties": true, "properties": { "best_practices": { "description": "Type-specific implementation guidance.", "type": "string" }, "common_mistakes": { "description": "Common invalid inputs and their corrections.", "items": { "$ref": "#/components/schemas/OutputRestApiMetadataCommonMistake1e2d1c41f872" }, "type": "array" }, "config_schema": { "additionalProperties": true, "description": "JSON Schema for a full deployable component config.", "type": "object" }, "description": { "description": "Short description of the component type.", "type": "string" }, "display_name": { "description": "Human-readable component type name.", "type": "string" }, "examples": { "description": "Valid example configs for this component type.", "items": { "additionalProperties": true, "description": "Example metadata component config.", "type": "object" }, "type": "array" }, "identifier_schema": { "additionalProperties": true, "description": "JSON Schema for identifying an existing component.", "type": "object" }, "type": { "description": "Metadata component type.", "type": "string" }, "usage_guide": { "description": "Type-specific authoring guidance.", "type": "string" } }, "required": [ "config_schema", "identifier_schema", "type" ], "title": "MetadataTypeSchema", "type": "object" }, "OutputRestApiMetadataTypeSummary66b0fa75da2b": { "properties": { "description": { "description": "Short description of the component type.", "type": "string" }, "display_name": { "description": "Human-readable component type name.", "type": "string" }, "type": { "description": "Metadata component type.", "type": "string" } }, "required": [ "description", "display_name", "type" ], "title": "MetadataTypeSummary", "type": "object" }, "OutputRestApiMetadataTypesResponseadffc1eb594f": { "properties": { "types": { "description": "Composer-enabled metadata component types.", "items": { "$ref": "#/components/schemas/OutputRestApiMetadataTypeSummary66b0fa75da2b" }, "type": "array" } }, "required": [ "types" ], "title": "MetadataTypesResponse", "type": "object" }, "OutputRestApiMetadataValidationResponse02e9eb214b0a": { "properties": { "errors": { "description": "Package-level validation issues.", "items": { "$ref": "#/components/schemas/OutputRestApiMetadataIssue2141b9b78899" }, "type": "array" }, "results": { "description": "Per-component validation results.", "items": { "$ref": "#/components/schemas/OutputRestApiMetadataComponentValidationResult2e20652b844a" }, "type": "array" }, "valid": { "description": "True only when every component and dependency check passed.", "type": "boolean" } }, "required": [ "errors", "results", "valid" ], "title": "MetadataValidationResponse", "type": "object" }, "OutputRestApiMileageLocationa042563f5468": { "description": "Start, end, or intermediate stop on a mileage trip.", "properties": { "address": { "description": "Address of this point. Null when the point has no address.", "type": "string" }, "coordinates": { "description": "Latitude and longitude of this point, in decimal degrees. Null when the point has no coordinates.", "properties": { "latitude": { "anyOf": [ { "description": "Latitude of this point, in decimal degrees.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "longitude": { "anyOf": [ { "description": "Longitude of this point, in decimal degrees.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "MileageCoordinate", "type": "object" } }, "title": "MileageLocation", "type": "object" }, "OutputRestApiMissingLeaveEvidencec3ffdc0bb742": { "description": "", "properties": { "answer_type": { "description": "Expected answer type for this evidence key.", "type": "string" }, "key": { "description": "Stable evidence key that can be supplied in supplemental_evidence.", "type": "string" }, "label": { "description": "Human-readable label for the missing evidence.", "type": "string" }, "program_codes": { "description": "Leave program codes that reported this missing evidence.", "items": { "type": "string" }, "type": "array" } }, "required": [ "answer_type", "key", "label", "program_codes" ], "title": "MissingLeaveEvidence", "type": "object" }, "OutputRestApiMonthlyOnDayOfWeekScheduleTrigger53d4b16bf970": { "additionalProperties": false, "properties": { "day_of_week": { "anyOf": [ { "maximum": 6, "minimum": 0, "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "hour": { "anyOf": [ { "maximum": 23, "minimum": 0, "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "kind": { "type": "string" }, "minute": { "anyOf": [ { "default": 0, "maximum": 59, "minimum": 0, "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "timezone": { "type": "string" }, "week_of_month": { "anyOf": [ { "maximum": 4, "minimum": 1, "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "required": [ "day_of_week", "hour", "kind", "timezone", "week_of_month" ], "title": "MonthlyOnDayOfWeekScheduleTrigger", "type": "object" }, "OutputRestApiMonthlyScheduleTrigger105d31bb71a4": { "additionalProperties": false, "properties": { "day_of_month": { "anyOf": [ { "maximum": 31, "minimum": 1, "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "hour": { "anyOf": [ { "maximum": 23, "minimum": 0, "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "kind": { "type": "string" }, "minute": { "anyOf": [ { "default": 0, "maximum": 59, "minimum": 0, "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "timezone": { "type": "string" } }, "required": [ "day_of_month", "hour", "kind", "timezone" ], "title": "MonthlyScheduleTrigger", "type": "object" }, "OutputRestApiObjectCategoryd94265f21b42": { "description": "", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "description": { "description": "The description of the Custom Category", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the Custom Category", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "ObjectCategory", "type": "object" }, "OutputRestApiObligationLedgerPayout543916963034": { "description": "", "properties": { "amount_base": { "description": "Payout amount in the worker's base currency.", "properties": { "currency_type": { "description": "Three-letter currency code.", "type": "string" }, "value": { "description": "Decimal amount encoded as a string.", "type": "string" } }, "required": [ "currency_type", "value" ], "title": "ObligationLedgerPayoutCurrency", "type": "object" }, "amount_usd": { "description": "Payout amount converted to USD.", "properties": { "currency_type": { "description": "Three-letter currency code.", "type": "string" }, "value": { "description": "Decimal amount encoded as a string.", "type": "string" } }, "required": [ "currency_type", "value" ], "title": "ObligationLedgerPayoutCurrency", "type": "object" }, "cancel_reason": { "description": "Reason provided when the payout was cancelled.", "type": "string" }, "client": { "description": "Client system that created the payout.", "type": "string" }, "created_at": { "description": "When the payout was created.", "type": "string" }, "description": { "description": "Optional payout description.", "type": "string" }, "effective_end_date": { "description": "End date of the covered pay period.", "type": "string" }, "effective_start_date": { "description": "Start date of the covered pay period.", "type": "string" }, "external_id": { "description": "External identifier unique per company and client.", "type": "string" }, "group_label_id": { "description": "Group label identifier attached to the payout. Expand is deferred from v1; use GET /variable-compensation-payout-labels/{id}/ when needed.", "type": "string" }, "id": { "description": "Unique identifier of the payout.", "type": "string" }, "name": { "description": "Optional payout name.", "type": "string" }, "pay_classification": { "description": "Payroll earning code resolved from the payout type.", "type": "string" }, "payee_id": { "description": "ID of the worker who receives this payout. Expandable payee (Worker DTO + workers.read) is deferred from v1; use GET /workers/{id}/ when needed.", "type": "string" }, "payout_type": { "description": "Key of the company payout type used for this payout. Expand is deferred from v1; enumerate valid keys via GET /variable-compensation-payout-types/.", "type": "string" }, "paystub_id": { "description": "Paystub identifier when the payout has been synced to payroll.", "type": "string" }, "scheduled_date": { "description": "Date on which the payout is scheduled.", "type": "string" }, "source_label_id": { "description": "Source label identifier attached to the payout. Expand is deferred from v1; use GET /variable-compensation-payout-labels/{id}/ when needed.", "type": "string" }, "status": { "description": "Current payout status.", "type": "string" }, "updated_at": { "description": "When the payout was last updated.", "type": "string" } }, "required": [ "amount_base", "amount_usd", "client", "created_at", "effective_end_date", "effective_start_date", "external_id", "id", "payee_id", "payout_type", "scheduled_date", "status", "updated_at" ], "title": "ObligationLedgerPayout", "type": "object" }, "OutputRestApiOffCycleRunCreationErrorResponse8b03ff00877f": { "description": "", "properties": { "code": { "description": "Stable error code; an exception does not prove that no run was created.", "type": "string" }, "company_entity_id": { "anyOf": [ { "description": "HRIS company entity relationship ID for the attempted run. Null if the relationship cannot be resolved.", "type": "string" }, { "type": "null" } ] }, "employment_split": { "description": "Employment category for the attempted run.", "type": "string" }, "message": { "description": "Safe description of the unconfirmed creation outcome and retry guidance.", "type": "string" }, "worker_ids": { "description": "Role IDs in the run whose creation could not be confirmed.", "items": { "type": "string" }, "type": "array" } }, "required": [ "code", "company_entity_id", "employment_split", "message", "worker_ids" ], "title": "OffCycleRunCreationErrorResponse", "type": "object" }, "OutputRestApiOffCycleRunCreationRunResponsec6339ffa1191": { "description": "", "properties": { "check_date": { "description": "Payment date selected for this run.", "type": "string" }, "company_entity_id": { "anyOf": [ { "description": "HRIS company entity relationship ID for this run, matching company_entity_id on payroll run retrieval. Null if the relationship cannot be resolved.", "type": "string" }, { "type": "null" } ] }, "country_code": { "description": "Country code of the payroll entity.", "type": "string" }, "employment_split": { "description": "Worker eligibility category used to split this run, such as employees or contractors.", "type": "string" }, "pay_period": { "description": "Pay period for this run.", "properties": { "end_date": { "description": "End date of this run's pay period.", "type": "string" }, "start_date": { "description": "Start date of this run's pay period.", "type": "string" } }, "required": [ "end_date", "start_date" ], "title": "OffCycleRunPayPeriodResponse", "type": "object" }, "run_configuration": { "description": "Calculation configuration used for this run.", "properties": { "pay_basis": { "description": "Amount basis used by the created run. This API currently creates gross-pay runs.", "type": "string" } }, "required": [ "pay_basis" ], "title": "OffCycleRunConfigurationResponse", "type": "object" }, "run_id": { "description": "Identifier of the created draft payroll run.", "type": "string" }, "run_status": { "description": "Status of the created payroll run.", "type": "string" }, "run_type": { "description": "Type of the created payroll run.", "type": "string" }, "worker_ids": { "description": "Role IDs included in this run.", "items": { "type": "string" }, "type": "array" } }, "required": [ "check_date", "company_entity_id", "country_code", "employment_split", "pay_period", "run_configuration", "run_id", "run_status", "run_type", "worker_ids" ], "title": "OffCycleRunCreationRunResponse", "type": "object" }, "OutputRestApiOneTimeScheduleTrigger7f8bd364e99f": { "additionalProperties": false, "properties": { "day_of_month": { "anyOf": [ { "maximum": 31, "minimum": 1, "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "hour": { "anyOf": [ { "maximum": 23, "minimum": 0, "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "kind": { "type": "string" }, "minute": { "anyOf": [ { "default": 0, "maximum": 59, "minimum": 0, "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "month_of_year": { "anyOf": [ { "maximum": 12, "minimum": 1, "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "timezone": { "type": "string" }, "year": { "anyOf": [ { "maximum": 9999, "minimum": 1, "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "required": [ "day_of_month", "hour", "kind", "month_of_year", "timezone", "year" ], "title": "OneTimeScheduleTrigger", "type": "object" }, "OutputRestApiOutputField9899f3bb9150": { "description": "An attribute (column) in the report output", "properties": { "field_id": { "description": "Stable field identifier", "type": "string" }, "field_name": { "description": "Human-readable display name of the output field", "type": "string" } }, "required": [ "field_id", "field_name" ], "title": "OutputField", "type": "object" }, "OutputRestApiPackageSandboxLink33c28a65c482": { "description": "Request to link a package to a sandbox, or poll an EDIT-mode installation tracker.", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "error_message": { "description": "Error message when EDIT-mode linking failed", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "installation_record_id": { "description": "Installation record ID when EDIT-mode linking completes", "type": "string" }, "installation_tracker_id": { "description": "The internal sandbox installation tracker ID", "type": "string" }, "mode": { "description": "How the sandbox is linked to the package (INSTALL or EDIT)", "type": "string" }, "package_key": { "description": "The package key to link into the sandbox", "type": "string" }, "package_version_id": { "description": "The package version being linked in EDIT mode", "type": "string" }, "post_install_landing_component": { "description": "Component to open after EDIT-mode linking completes", "type": "object" }, "progress": { "description": "EDIT-mode installation progress entries", "items": { "additionalProperties": {} }, "type": "array" }, "sandbox_company_id": { "description": "The company receiving the sandbox package installation", "type": "string" }, "status": { "description": "INSTALL completion status, or EDIT installation tracker status", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "mode", "package_key", "sandbox_company_id", "updated_at" ], "title": "PackageSandboxLink", "type": "object" }, "OutputRestApiPackageVersion8e4a198e8bf8": { "description": "", "properties": { "components": { "description": "Components included in this package version", "items": { "additionalProperties": {} }, "type": "array" }, "created_at": { "description": "Record creation date", "type": "string" }, "description": { "description": "The description of the package version", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_published": { "description": "Whether this package version has been published", "type": "boolean" }, "package_display_name": { "description": "The display name of the parent package", "type": "string" }, "package_id": { "description": "The ID of the parent package", "type": "string" }, "package_key": { "description": "The package key of the parent package", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "version_number": { "description": "The semantic version number for this package version", "type": "string" } }, "required": [ "created_at", "id", "updated_at", "version_number" ], "title": "PackageVersion", "type": "object" }, "OutputRestApiPackagef98f6a60f6b1": { "description": "", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "description": { "description": "The description of the package", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "latest_version_id": { "description": "The ID of the latest package version, if any", "type": "string" }, "latest_version_number": { "description": "The version number of the latest package version, if any", "type": "string" }, "package_display_name": { "description": "The display name of the package", "type": "string" }, "package_key": { "description": "The unique package key within the publisher company", "type": "string" }, "package_type": { "description": "The package type", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "package_display_name", "package_key", "package_type", "updated_at" ], "title": "Package", "type": "object" }, "OutputRestApiPageSummary831a5e01076d": { "description": "Summary of a page attached to a custom app.", "properties": { "api_name": { "description": "The unique name of the page within the app", "type": "string" }, "canvas_instance_id": { "description": "The ID of the canvas instance backing this page (canvas_page only)", "type": "string" }, "created_by": { "description": "The ID of the role that created the page", "type": "string" }, "function_id": { "description": "The ID of the Rippling Function rendering this page (sdui_page only)", "type": "string" }, "page_type": { "description": "The type of page (e.g. 'canvas_page', 'sdui_page', 'object_page')", "type": "string" }, "sdui_page_id": { "description": "The ID of the SDUI page instance (sdui_page only)", "type": "string" }, "updated_by": { "description": "The ID of the role that last modified the page", "type": "string" } }, "title": "PageSummary", "type": "object" }, "OutputRestApiPayPeriodContributionb24011515e91": { "description": "", "properties": { "carrier_total": { "description": "Total estimated carrier-paid amount in this pay period.", "properties": { "amount": { "description": "Decimal monetary amount serialized as a string.", "type": "string" }, "currency": { "description": "ISO 4217 currency code for the amount.", "type": "string" } }, "required": [ "amount", "currency" ], "title": "CurrencyAmount", "type": "object" }, "contributions": { "description": "Estimated program-level pay slices in this pay period.", "items": { "$ref": "#/components/schemas/OutputRestApiProgramPaySliceec28de08a4fd" }, "type": "array" }, "employer_total": { "description": "Total estimated employer-paid amount in this pay period.", "properties": { "amount": { "description": "Decimal monetary amount serialized as a string.", "type": "string" }, "currency": { "description": "ISO 4217 currency code for the amount.", "type": "string" } }, "required": [ "amount", "currency" ], "title": "CurrencyAmount", "type": "object" }, "government_total": { "description": "Total estimated government-paid amount in this pay period.", "properties": { "amount": { "description": "Decimal monetary amount serialized as a string.", "type": "string" }, "currency": { "description": "ISO 4217 currency code for the amount.", "type": "string" } }, "required": [ "amount", "currency" ], "title": "CurrencyAmount", "type": "object" }, "period_end": { "description": "Estimated pay period end date.", "type": "string" }, "period_start": { "description": "Estimated pay period start date.", "type": "string" }, "total": { "description": "Total estimated amount in this pay period.", "properties": { "amount": { "description": "Decimal monetary amount serialized as a string.", "type": "string" }, "currency": { "description": "ISO 4217 currency code for the amount.", "type": "string" } }, "required": [ "amount", "currency" ], "title": "CurrencyAmount", "type": "object" } }, "required": [ "contributions", "period_end", "period_start" ], "title": "PayPeriodContribution", "type": "object" }, "OutputRestApiPayPhase04495657e430": { "description": "", "properties": { "amount": { "description": "Pay amount for this phase serialized as a decimal string.", "type": "string" }, "currency": { "description": "ISO 4217 currency code for this pay phase.", "type": "string" }, "duration_days": { "anyOf": [ { "description": "Number of days this phase lasts. Null means the phase runs to the window end.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "unit": { "description": "Pay-rate unit for this phase, such as DAILY, WEEKLY, or BIWEEKLY.", "type": "string" } }, "required": [ "amount" ], "title": "PayPhase", "type": "object" }, "OutputRestApiPaymentModeChangeResponsef326e4f5c1c2": { "description": "", "properties": { "results": { "description": "Item-level results for the requested payment mode changes. Each item is either updated or rejected so callers can retry failed items independently.", "items": { "$ref": "#/components/schemas/OutputRestApiPaymentModeChangeResult5ea12ee2e8ce" }, "type": "array" }, "write_status": { "description": "Completion status for this synchronous request. This is currently always COMPLETED; the field is reserved for future status values if processing becomes asynchronous. It describes the overall request, while each result status describes an individual item.", "type": "string" } }, "title": "PaymentModeChangeResponse", "type": "object" }, "OutputRestApiPaymentModeChangeResult5ea12ee2e8ce": { "description": "", "properties": { "error": { "description": "Structured error when the item was rejected. This field is omitted for UPDATED items and is present for REJECTED items.", "properties": { "code": { "description": "Machine-readable error code for a rejected item. DUPLICATE_NO_OP means the requested change was already requested and no retry is needed; DUPLICATE_TARGET_CONFLICT, OUT_OF_SCOPE, RUN_NOT_FOUND, WORKER_NOT_IN_RUN, and PAYMENT_MODE_NOT_SUPPORTED are terminal request errors that require changing the request or authorization; RUN_NOT_WRITABLE may be retried when the run becomes writable; PAYMENT_MODE_UPDATE_FAILED is retryable after the underlying update failure is resolved.", "type": "string" }, "message": { "description": "Human-readable error message.", "type": "string" } }, "title": "PaymentModeChangeError", "type": "object" }, "payment_mode": { "description": "Requested Global Payroll payment mode code.", "type": "string" }, "run_id": { "description": "ID of the requested payroll run.", "type": "string" }, "status": { "description": "Item result: UPDATED or REJECTED.", "type": "string" }, "worker_id": { "description": "ID of the requested worker.", "type": "string" } }, "title": "PaymentModeChangeResult", "type": "object" }, "OutputRestApiPayrollRun7ba294474a8d": { "description": "\n V2 DTO representing a single payroll run.\n\n Used by:\n - GET /payroll-runs/ (list)\n - GET /payroll-runs/{id} (retrieve)\n ", "properties": { "approval_deadline": { "description": "Deadline for approving the payroll run.", "type": "string" }, "approved_at": { "description": "Timestamp when the run was approved.", "type": "string" }, "check_date": { "description": "Date the paycheck is issued.", "type": "string" }, "company_entity_id": { "description": "Identifier linking this payroll run to the company's legal entity in the HRIS system.", "type": "string" }, "country_code": { "description": "ISO country code where the payroll run applies.", "type": "string" }, "debit_date": { "description": "Date funds are debited from the company's account.", "type": "string" }, "id": { "description": "Unique identifier for the payroll run.", "type": "string" }, "lock_deadline": { "description": "Deadline after which the run is locked for changes.", "type": "string" }, "paid_at": { "description": "Timestamp when the run was marked as paid.", "type": "string" }, "pay_period": { "description": "Pay period details for this run.", "properties": { "end_date": { "description": "End date of the pay period.", "type": "string" }, "pay_frequency": { "description": "Pay frequency for this period (e.g. BI_WEEKLY, SEMI_MONTHLY, MONTHLY, WEEKLY).", "type": "string" }, "start_date": { "description": "Start date of the pay period.", "type": "string" } }, "title": "PayrollRunPayPeriod", "type": "object" }, "payment_type": { "description": "Payment method used (e.g. WIRE, ACH).", "type": "string" }, "run_state": { "description": "Current state of the run (e.g. DRAFT, PAID, APPROVED).", "type": "string" }, "run_type": { "description": "Type of the run (e.g. REGULAR, OFF_CYCLE, CORRECTION).", "type": "string" }, "title": { "description": "Human-readable title of the payroll run.", "type": "string" } }, "title": "PayrollRun", "type": "object" }, "OutputRestApiPerDiemLineItemd5ece60cf2c4": { "description": "", "properties": { "amount": { "description": "Sub-rate amount for one unit. The `value` is a decimal string.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "calculated_amount": { "description": "amount times count. The `value` is a decimal string. Negative when line_type is EXCLUDE.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "count": { "anyOf": [ { "description": "How many units.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "label": { "description": "Sub-rate label.", "type": "string" }, "line_type": { "description": "`INCLUDE`: this row is added to the reimbursement. `EXCLUDE`: this row is subtracted. `calculated_amount.value` is negative when excluded.", "type": "string" }, "sub_rate_id": { "description": "Per diem sub-rate ID.", "type": "string" }, "sub_rate_type": { "description": "`FULL_DAY`: the full daily allowance. `MEALS`: the meals portion of the daily allowance. `OTHERS`: an allowance that is not the full day or meals.", "type": "string" } }, "title": "PerDiemLineItem", "type": "object" }, "OutputRestApiPermissionProfileMembership8c7335914139": { "description": "The authenticated caller's membership in one active permission profile.", "properties": { "is_member": { "description": "Whether the authenticated caller belongs to this active permission profile in their company. False also covers nonexistent or unavailable profiles.", "type": "boolean" } }, "required": [ "is_member" ], "title": "PermissionProfileMembership", "type": "object" }, "OutputRestApiPieceRatePremiumsd68380854608": { "description": "", "properties": { "name": { "description": "The piece rate name.", "type": "string" }, "premium_rate": { "anyOf": [ { "description": "The pay rate for this piece rate premium.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "premium_units": { "anyOf": [ { "description": "The total units produced at the premium rate.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "PieceRatePremiums", "type": "object" }, "OutputRestApiPlatformCapabilityModel82ad48d1caa0": { "description": "", "properties": { "version": { "description": "Schema version", "type": "string" } }, "required": [ "version" ], "title": "PlatformCapabilityModel", "type": "object" }, "OutputRestApiPremiumsecd81efd722e": { "description": "", "properties": { "name": { "description": "The pay rate name", "type": "string" }, "premium_hours": { "anyOf": [ { "description": "The total hours worked for at the premium rate.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "premium_rate": { "anyOf": [ { "description": "The pay rate for this premium.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Premiums", "type": "object" }, "OutputRestApiProgramContributionba9b17304162": { "description": "", "properties": { "end_date": { "description": "Program placement end date, if known.", "type": "string" }, "leave_type": { "description": "Leave type associated with this program placement.", "type": "string" }, "leave_type_label": { "description": "Human-readable leave type label.", "type": "string" }, "pay_status": { "description": "Whether this program has an estimated pay rate.", "type": "string" }, "program_code": { "description": "Leave program code active on this claim window.", "type": "string" }, "start_date": { "description": "Program placement start date.", "type": "string" } }, "required": [ "pay_status", "program_code", "start_date" ], "title": "ProgramContribution", "type": "object" }, "OutputRestApiProgramPaySliceec28de08a4fd": { "description": "", "properties": { "amount": { "description": "Estimated amount for this program slice.", "properties": { "amount": { "description": "Decimal monetary amount serialized as a string.", "type": "string" }, "currency": { "description": "ISO 4217 currency code for the amount.", "type": "string" } }, "required": [ "amount", "currency" ], "title": "CurrencyAmount", "type": "object" }, "pay_source": { "description": "Who pays the employee for this program slice.", "type": "string" }, "program_code": { "description": "Program contributing pay in this pay period.", "type": "string" } }, "required": [ "amount", "pay_source", "program_code" ], "title": "ProgramPaySlice", "type": "object" }, "OutputRestApiProgramRequirement9ceb24088439": { "description": "", "properties": { "blocks_payment": { "description": "Whether this requirement blocks payment until resolved.", "type": "boolean" }, "key": { "description": "Machine-readable requirement key.", "type": "string" }, "summary": { "description": "Human-readable requirement summary.", "type": "string" } }, "required": [ "key", "summary" ], "title": "ProgramRequirement", "type": "object" }, "OutputRestApiProgramValidation71fbcd5f7fcc": { "description": "", "properties": { "data_source": { "description": "Evidence key or field path inspected by the validation.", "type": "string" }, "message": { "description": "Human-readable validation message.", "type": "string" }, "outcome": { "description": "Validation outcome.", "type": "string" }, "validation_func": { "description": "Machine-readable validation function that produced this outcome.", "type": "string" }, "value": { "description": "Observed value at evaluation time, if available.", "type": "string" } }, "required": [ "message", "outcome", "validation_func" ], "title": "ProgramValidation", "type": "object" }, "OutputRestApiQuarterlyScheduleTriggerbeb283499463": { "additionalProperties": false, "properties": { "day_of_month": { "anyOf": [ { "maximum": 31, "minimum": 1, "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "hour": { "anyOf": [ { "maximum": 23, "minimum": 0, "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "kind": { "type": "string" }, "minute": { "anyOf": [ { "default": 0, "maximum": 59, "minimum": 0, "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "month_of_year": { "anyOf": [ { "maximum": 12, "minimum": 1, "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "timezone": { "type": "string" } }, "required": [ "day_of_month", "hour", "kind", "month_of_year", "timezone" ], "title": "QuarterlyScheduleTrigger", "type": "object" }, "OutputRestApiReadOnlyWorkflowDefinitioncae0f7b70990": { "additionalProperties": false, "properties": { "kind": { "type": "string" }, "steps": { "items": { "$ref": "#/components/schemas/OutputRestApiReadOnlyWorkflowStep64665073f488" }, "type": "array" }, "trigger": { "$ref": "#/components/schemas/OutputRestApiReadOnlyWorkflowTrigger870ec700d5da" } }, "required": [ "kind", "steps", "trigger" ], "title": "ReadOnlyWorkflowDefinition", "type": "object" }, "OutputRestApiReadOnlyWorkflowStep64665073f488": { "additionalProperties": false, "properties": { "id": { "type": "string" }, "kind": { "type": "string" }, "name": { "type": "string" }, "next_ids": { "items": { "type": "string" }, "type": "array" }, "source_type": { "type": "string" } }, "required": [ "id", "kind", "name", "next_ids", "source_type" ], "title": "ReadOnlyWorkflowStep", "type": "object" }, "OutputRestApiReadOnlyWorkflowTrigger870ec700d5da": { "additionalProperties": false, "properties": { "kind": { "type": "string" }, "source_type": { "type": "string" }, "summary": { "type": "string" } }, "required": [ "kind", "source_type", "summary" ], "title": "ReadOnlyWorkflowTrigger", "type": "object" }, "OutputRestApiRecordCapabilitiesf64b19ca4ee9": { "description": "Permissions and lock state for this caller.", "properties": { "editable": { "description": "Whether at least one field can be edited by this caller.", "type": "boolean" }, "locked": { "description": "Whether the record is locked against changes.", "type": "boolean" } }, "required": [ "editable", "locked" ], "title": "RecordCapabilities", "type": "object" }, "OutputRestApiRecordDetail6a8b7442b05d": { "description": "Record values, edit capabilities, and the effective page layout for one readable Custom Object record.", "properties": { "capabilities": { "$ref": "#/components/schemas/OutputRestApiRecordCapabilitiesf64b19ca4ee9" }, "fields": { "additionalProperties": { "anyOf": [ { "$ref": "#/components/schemas/OutputRestApiDetailTextField90ae801b552e" }, { "$ref": "#/components/schemas/OutputRestApiDetailNumberField70754b498c34" }, { "$ref": "#/components/schemas/OutputRestApiDetailBooleanField900976202e0f" }, { "$ref": "#/components/schemas/OutputRestApiDetailDateField47aa52ba8268" }, { "$ref": "#/components/schemas/OutputRestApiDetailDateTimeFieldf7deeeec114e" }, { "$ref": "#/components/schemas/OutputRestApiDetailCurrencyField4e872a664276" }, { "$ref": "#/components/schemas/OutputRestApiDetailChoiceField7ad9d5cfc201" }, { "$ref": "#/components/schemas/OutputRestApiDetailMultiChoiceFielde8f2b5b3e40b" }, { "$ref": "#/components/schemas/OutputRestApiDetailReferenceField13e7da96f7f1" }, { "$ref": "#/components/schemas/OutputRestApiDetailUnsupportedField8bc3be1db840" } ] }, "description": "Permission-visible direct fields plus read-only related fields used by the layout.", "type": "object" }, "id": { "description": "Stable record identifier returned by the canonical Custom Object record list or query endpoint. Use it with object_api_name for canonical record GET and PATCH.", "type": "string" }, "layout": { "$ref": "#/components/schemas/OutputRestApiDetailLayout926395a1dabf" }, "object_api_name": { "description": "Custom Object API name, such as equipment__c, used to address this record's collection. Obtain it from the Custom Object definition or grid configuration.", "type": "string" }, "updated_at": { "description": "ISO 8601 UTC timestamp of the loaded record version. Pass this exact value as lock_update_time in the canonical record PATCH to detect stale writes.", "format": "date-time", "type": "string" } }, "required": [ "capabilities", "fields", "id", "layout", "object_api_name", "updated_at" ], "title": "RecordDetail", "type": "object" }, "OutputRestApiRecordDetailCurrencydaf3debf90df": { "description": "Platform Currency serialized with a decimal string amount to preserve precision.", "properties": { "currency_type": { "description": "ISO 4217 currency code, for example USD or EUR.", "pattern": "^[A-Z]{3}$", "type": "string" }, "value": { "description": "Decimal monetary amount in currency units, for example 25.00; not integer cents.", "pattern": "^[+-]?(?:\\d+(?:\\.\\d*)?|\\.\\d+)(?:[eE][+-]?\\d+)?$", "type": "string" } }, "required": [ "currency_type", "value" ], "title": "RecordDetailCurrency", "type": "object" }, "OutputRestApiRedactedField21788a25ef22": { "description": "Info about the redacted fields.", "properties": { "name": { "description": "The name for the redacted field", "type": "string" }, "reason": { "description": "The reason for the redaction", "type": "string" } }, "title": "RedactedField", "type": "object" }, "OutputRestApiRedactedFields9f7657dc2a2f": { "description": "A list of redacted fields.", "properties": { "redacted_fields": { "items": { "properties": { "name": { "description": "The name for the redacted field", "type": "string" }, "reason": { "description": "The reason for the redaction", "type": "string" } }, "type": "object" }, "type": "array" } }, "title": "RedactedFields", "type": "object" }, "OutputRestApiRegisteredCallbackActionf36112ca9efd": { "additionalProperties": false, "properties": { "id": { "minLength": 1, "type": "string" }, "implementation_config": { "minLength": 1, "type": "string" }, "kind": { "type": "string" }, "owner_id": { "minLength": 1, "type": "string" }, "owner_type": { "minLength": 1, "type": "string" } }, "required": [ "id", "implementation_config", "kind", "owner_id", "owner_type" ], "title": "RegisteredCallbackAction", "type": "object" }, "OutputRestApiRelatedRecordbb98d854728b": { "description": "A related Custom Object record with the readable fields configured by a saved related-list section.", "properties": { "fields": { "additionalProperties": { "anyOf": [ { "$ref": "#/components/schemas/OutputRestApiDetailTextField90ae801b552e" }, { "$ref": "#/components/schemas/OutputRestApiDetailNumberField70754b498c34" }, { "$ref": "#/components/schemas/OutputRestApiDetailBooleanField900976202e0f" }, { "$ref": "#/components/schemas/OutputRestApiDetailDateField47aa52ba8268" }, { "$ref": "#/components/schemas/OutputRestApiDetailDateTimeFieldf7deeeec114e" }, { "$ref": "#/components/schemas/OutputRestApiDetailCurrencyField4e872a664276" }, { "$ref": "#/components/schemas/OutputRestApiDetailChoiceField7ad9d5cfc201" }, { "$ref": "#/components/schemas/OutputRestApiDetailMultiChoiceFielde8f2b5b3e40b" }, { "$ref": "#/components/schemas/OutputRestApiDetailReferenceField13e7da96f7f1" }, { "$ref": "#/components/schemas/OutputRestApiDetailUnsupportedField8bc3be1db840" } ] }, "description": "Permission-visible fields configured for this list.", "type": "object" }, "id": { "description": "Stable identifier of a readable related record. Use it with object_api_name in the canonical record GET or record-details endpoint.", "type": "string" }, "object_api_name": { "description": "Related Custom Object API name.", "type": "string" } }, "required": [ "fields", "id", "object_api_name" ], "title": "RelatedRecord", "type": "object" }, "OutputRestApiResultComponent77279ce59534": { "description": "", "properties": { "data": { "description": "Additional component-specific data.", "type": "object" }, "kind": { "description": "Category of explanatory result component.", "type": "string" }, "subkind": { "description": "Optional machine-readable subtype for the component.", "type": "string" }, "summary": { "description": "Human-readable summary for this component.", "type": "string" } }, "required": [ "kind", "summary" ], "title": "ResultComponent", "type": "object" }, "OutputRestApiSandbox7b89bdaf4d00": { "description": "", "properties": { "config_override": { "description": "Type-specific sandbox configuration. Optional for developer sandboxes.", "properties": { "custom_objects": { "description": "Custom objects copied into the sandbox.", "properties": { "co_api_names": { "description": "Custom object API names copied into the sandbox.", "items": { "type": "string" }, "type": "array" } }, "title": "CustomObjectsConfig", "type": "object" }, "developer": { "description": "Required for developer sandboxes and omitted for full-data sandboxes.", "properties": { "company_size": { "description": "Seed company size for the developer sandbox. MEDIUM is the supported value for new sandboxes. SMALL is retained for existing sandboxes only and is not supported on create.", "type": "string" } }, "required": [ "company_size" ], "title": "DeveloperConfig", "type": "object" }, "general_notifications": { "description": "General outbound notification controls.", "properties": { "email": { "description": "Email notification configuration.", "properties": { "allowed_users": { "description": "Users allowed to receive outbound messages.", "items": { "type": "string" }, "type": "array" }, "outbound_behavior": { "description": "Whether outbound messages are allowed or suppressed.", "type": "string" } }, "required": [ "outbound_behavior" ], "title": "ChannelConfig", "type": "object" }, "push_notifications": { "description": "Push notification configuration.", "properties": { "allowed_users": { "description": "Users allowed to receive outbound messages.", "items": { "type": "string" }, "type": "array" }, "outbound_behavior": { "description": "Whether outbound messages are allowed or suppressed.", "type": "string" } }, "required": [ "outbound_behavior" ], "title": "ChannelConfig", "type": "object" }, "slack": { "description": "Slack notification configuration.", "properties": { "allowed_public_channels": { "description": "Public channels allowed to receive outbound messages.", "items": { "type": "string" }, "type": "array" }, "allowed_users": { "description": "Users allowed to receive outbound messages.", "items": { "type": "string" }, "type": "array" }, "outbound_behavior": { "description": "Whether outbound messages are allowed or suppressed.", "type": "string" } }, "required": [ "outbound_behavior" ], "title": "PublicChannelConfig", "type": "object" }, "sms": { "description": "SMS notification configuration.", "properties": { "allowed_users": { "description": "Users allowed to receive outbound messages.", "items": { "type": "string" }, "type": "array" }, "outbound_behavior": { "description": "Whether outbound messages are allowed or suppressed.", "type": "string" } }, "required": [ "outbound_behavior" ], "title": "ChannelConfig", "type": "object" }, "teams": { "description": "Microsoft Teams notification configuration.", "properties": { "allowed_public_channels": { "description": "Public channels allowed to receive outbound messages.", "items": { "type": "string" }, "type": "array" }, "allowed_users": { "description": "Users allowed to receive outbound messages.", "items": { "type": "string" }, "type": "array" }, "outbound_behavior": { "description": "Whether outbound messages are allowed or suppressed.", "type": "string" } }, "required": [ "outbound_behavior" ], "title": "PublicChannelConfig", "type": "object" } }, "required": [ "email", "push_notifications", "sms" ], "title": "GeneralNotificationsConfig", "type": "object" }, "integrations": { "description": "Required for connected full-data sandboxes.", "properties": { "is_risk_acknowledged": { "description": "Confirms acceptance of the risks of connected third-party integrations.", "type": "boolean" } }, "required": [ "is_risk_acknowledged" ], "title": "IntegrationsConfig", "type": "object" }, "sandbox_mode": { "description": "Required for full-data sandboxes. Developer sandboxes default to CONNECTED.", "type": "string" }, "workflow_webhooks": { "description": "Workflow webhook controls.", "properties": { "allowed_ips": { "description": "IP addresses allowed to receive workflow webhooks.", "items": { "type": "string" }, "type": "array" }, "allowlisted_webhook_urls": { "description": "Webhook URLs allowed in the sandbox.", "items": { "type": "string" }, "type": "array" }, "outbound_behavior": { "description": "Whether workflow webhook traffic is allowed or suppressed.", "type": "string" } }, "title": "WorkflowWebhookConfig", "type": "object" } }, "title": "SandboxConfig", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "description": { "description": "Optional sandbox description.", "type": "string" }, "handle": { "description": "Server-generated sandbox handle.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "Display name of the sandbox.", "type": "string" }, "status": { "description": "Current lifecycle status.", "type": "string" }, "type": { "description": "Sandbox type: developer or full data.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "type", "updated_at" ], "title": "Sandbox", "type": "object" }, "OutputRestApiSavedFilter1a953728ee2c": { "description": "A filter currently saved on the report", "properties": { "field_id": { "description": "Stable field identifier the filter applies to", "type": "string" }, "field_name": { "description": "Human-readable display name of the filtered field", "type": "string" }, "operator": { "description": "Filter operator applied to the field", "type": "string" }, "value": { "anyOf": [ { "description": "Filter value; shape depends on the operator" }, { "type": "null" } ] } }, "required": [ "field_id", "field_name", "operator" ], "title": "SavedFilter", "type": "object" }, "OutputRestApiSchedule22a5141801cb": { "description": "", "properties": { "can_edit": { "description": "Whether the requesting role can edit the schedule.", "type": "boolean" }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "managers": { "description": "The managers of the schedule.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiWorker75ef4092b644" }, "type": "array" }, "managers_id": { "description": "The IDs of the managers of the schedule.", "items": { "type": "string" }, "type": "array" }, "members": { "description": "The members of the schedule.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiWorker75ef4092b644" }, "type": "array" }, "members_id": { "description": "The IDs of the members of the schedule.", "items": { "type": "string" }, "type": "array" }, "name": { "description": "The name of the schedule.", "type": "string" }, "observers": { "description": "The observers of the schedule.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiWorker75ef4092b644" }, "type": "array" }, "observers_id": { "description": "The IDs of the observers of the schedule.", "items": { "type": "string" }, "type": "array" }, "settings": { "description": "The settings of the schedule.", "properties": { "timezone": { "description": "The IANA timezone identifier for the schedule (e.g., 'America/New_York'). Accepted values are defined by the tz database, listed here: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones", "type": "string" } }, "title": "ScheduleSettings", "type": "object" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Schedule", "type": "object" }, "OutputRestApiScheduledJobAssignment3f875c1b8e55": { "description": "Platform API DTO for a scheduled job assignment or unassignment change.", "properties": { "change_type": { "description": "Type of scheduled change: ASSIGN or UNASSIGN.", "type": "string" }, "changed_by_id": { "description": "The ID of the role that created this scheduled change.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "effective_from": { "description": "When the scheduled change will be applied (ISO 8601).", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "job_code_id": { "description": "The ID of the job code.", "type": "string" }, "job_code_name": { "description": "Display name of the job code.", "type": "string" }, "job_dimension_id": { "description": "The ID of the job dimension.", "type": "string" }, "job_dimension_name": { "description": "Display name of the job dimension.", "type": "string" }, "pay_rate": { "anyOf": [ { "description": "New pay rate value, if the change includes a pay rate.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "reason": { "description": "Reason provided when the scheduled change was created.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "worker_id": { "description": "The ID of the worker (role) the scheduled changes target.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "ScheduledJobAssignment", "type": "object" }, "OutputRestApiSegmentse33b0ae25a0a": { "description": "", "properties": { "break_type_id": { "description": "The ID of the break type.", "type": "string" }, "display_name": { "description": "Name of the final earning for the segment.", "type": "string" }, "end_time": { "description": "The end time of the segment.", "type": "string" }, "job_codes_id": { "description": "The IDs of the job codes associated with the segment.", "items": { "type": "string" }, "type": "array" }, "ot_multiplier": { "anyOf": [ { "description": "The multiplier for overtime hours in this segment.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "pay_rate": { "anyOf": [ { "description": "The pay rate for this segment.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "start_time": { "description": "The start time of the segment.", "type": "string" } }, "title": "Segments", "type": "object" }, "OutputRestApiSetting595200321ea7": { "description": "", "properties": { "api_name": { "description": "The unique api name of the setting", "type": "string" }, "boolean_value": { "description": "Boolean value of the setting, if it has boolean data type", "type": "boolean" }, "created_at": { "description": "Record creation date", "type": "string" }, "data_type": { "description": "Data type of the setting", "type": "string" }, "display_name": { "description": "The display name of setting", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "number_value": { "anyOf": [ { "description": "Number value of the setting, if it has number data type", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "secret_value": { "description": "Secret value of the setting, if it has secret data type", "type": "string" }, "string_value": { "description": "String value of the setting, if it has string data type", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Setting", "type": "object" }, "OutputRestApiShiftAssignmentd0bfafbeb81e": { "description": "", "properties": { "can_edit": { "description": "Whether the shift assignment can be edited", "type": "boolean" }, "created_at": { "description": "Record creation date", "type": "string" }, "custom_fields": { "description": "Custom fields for the shift assignment", "items": { "additionalProperties": {} }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "is_published": { "description": "Whether the shift assignment is published. If true, the published_version will be the same as the shift_data", "type": "boolean" }, "published_version": { "description": "The published version of the shift assignment, if it exists. If filled but is_published is false, the shift_data is the latest version.", "properties": { "end_time": { "description": "The end time of the shift", "type": "string" }, "notes": { "description": "Notes for the shift, max length 256 characters", "maxLength": 256, "type": "string" }, "shift_breaks": { "description": "The breaks of the shift", "items": { "$ref": "#/components/schemas/OutputRestApiShiftBreak314820414f10" }, "type": "array" }, "shift_segments": { "description": "The segments of the shift", "items": { "$ref": "#/components/schemas/OutputRestApiShiftSegment2a530a829033" }, "type": "array" }, "start_time": { "description": "The start time of the shift", "type": "string" } }, "required": [ "end_time", "start_time" ], "title": "ShiftData", "type": "object" }, "schedule": { "description": "The schedule\n\nExpandable field", "properties": { "can_edit": { "description": "Whether the requesting role can edit the schedule.", "type": "boolean" }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "managers": { "description": "The managers of the schedule.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiWorker75ef4092b644" }, "type": "array" }, "managers_id": { "description": "The IDs of the managers of the schedule.", "items": { "type": "string" }, "type": "array" }, "members": { "description": "The members of the schedule.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiWorker75ef4092b644" }, "type": "array" }, "members_id": { "description": "The IDs of the members of the schedule.", "items": { "type": "string" }, "type": "array" }, "name": { "description": "The name of the schedule.", "type": "string" }, "observers": { "description": "The observers of the schedule.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiWorker75ef4092b644" }, "type": "array" }, "observers_id": { "description": "The IDs of the observers of the schedule.", "items": { "type": "string" }, "type": "array" }, "settings": { "description": "The settings of the schedule.", "properties": { "timezone": { "description": "The IANA timezone identifier for the schedule (e.g., 'America/New_York'). Accepted values are defined by the tz database, listed here: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones", "type": "string" } }, "title": "ScheduleSettings", "type": "object" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Schedule", "type": "object" }, "schedule_id": { "description": "The ID of the schedule", "type": "string" }, "shift_data": { "description": "The data of the shift", "properties": { "end_time": { "description": "The end time of the shift", "type": "string" }, "notes": { "description": "Notes for the shift, max length 256 characters", "maxLength": 256, "type": "string" }, "shift_breaks": { "description": "The breaks of the shift", "items": { "$ref": "#/components/schemas/OutputRestApiShiftBreak314820414f10" }, "type": "array" }, "shift_segments": { "description": "The segments of the shift", "items": { "$ref": "#/components/schemas/OutputRestApiShiftSegment2a530a829033" }, "type": "array" }, "start_time": { "description": "The start time of the shift", "type": "string" } }, "required": [ "end_time", "start_time" ], "title": "ShiftData", "type": "object" }, "updated_at": { "description": "Record update date", "type": "string" }, "worker": { "description": "The worker\n\nExpandable field", "properties": { "business_partners": { "description": "Worker's assigned business partners. This field is only populated when explicitly requested via the expand parameter (e.g., ?expand=business_partners). When expanded, returns an empty list ([]) if the worker has no business partners.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiBusinessPartner77b00a069c32" }, "type": "array" }, "business_partners_id": { "description": "Worker's assigned business partners unique identifiers. Returns an empty list ([]) if the worker has no business partners.", "items": { "type": "string" }, "type": "array" }, "citizenship": { "description": "The countries that the worker has citizenship in.", "type": "string" }, "compensation": { "description": "The compensation package for the worker.\n\nExpandable field", "properties": { "annual_compensation": { "description": "The worker's annual compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "annual_salary_equivalent": { "description": "The worker's annual salary equivalent, for insurance purposes. It will be equal to the worker's annual compensation, except for owners that are receiving no cashcompensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "bonus_schedule": { "description": "The worker's bonus schedule.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "hourly_wage": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "id": { "description": "Identifier field", "type": "string" }, "monthly_compensation": { "description": "The worker's monthly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "on_target_commission": { "description": "The worker's on-target commission.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "payment_terms": { "description": "The payment terms for an worker's compensation.", "type": "string" }, "payment_type": { "description": "The payment type for an worker's compensation.", "type": "string" }, "relocation_reimbursement": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "salary_effective_date": { "description": "Salary effective date", "type": "string" }, "signing_bonus": { "description": "The worker's signing bonus.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus": { "description": "The worker's target annual bonus amount.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus_percent": { "anyOf": [ { "description": "The worker's target annual bonus as a percent of annual compensation.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" }, "weekly_compensation": { "description": "The worker's weekly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "worker": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's details.\n\nExpandable field", "type": "object" }, "worker_id": { "description": "The worker's ID.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Compensation", "type": "object" }, "compensation_grade": { "description": "The compensation grade assigned to the worker, if any.", "properties": { "id": { "description": "The compensation grade's unique identifier.", "type": "string" }, "label": { "description": "The compensation grade's label.", "type": "string" } }, "title": "WorkerCompensationGrade", "type": "object" }, "compensation_id": { "description": "The compensation package for the worker.", "type": "string" }, "country": { "description": "The worker's country.", "type": "string" }, "country_fields": { "description": "Country level fields for the worker.", "properties": { "ca": { "description": "Country-wise regional fields for Canada", "properties": { "sin": { "description": "Social Insurance Number (SIN) for Canada employees.", "type": "string" } }, "title": "CanadaFields", "type": "object" }, "nz": { "description": "Country-wise regional fields for New Zealand", "properties": { "ird_number": { "description": "Inland Revenue Department (IRD) number for New Zealand employees.", "type": "string" } }, "title": "NewZealandFields", "type": "object" }, "us": { "description": "Country-wise regional fields for USA", "properties": { "ssn": { "description": "Social Security Number (SSN) for US employees.", "type": "string" } }, "title": "USFields", "type": "object" } }, "title": "CountryFields", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "custom_fields": { "description": "Custom field values defined on the Employee object for this worker\n\nExpandable field", "items": { "additionalProperties": {} }, "type": "array" }, "date_of_birth": { "description": "The worker's date of birth.", "type": "string" }, "department": { "description": "The worker's assigned department.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "department_hierarchy": { "description": "List of departments in the department hierarchy. Refer department_hierarchy_ids for department hierarchy order.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestDepartment" }, "type": "array" }, "department_hierarchy_id": { "description": "The identifier of departments in the department hierarchy ordered from parent department to child department.", "items": { "type": "string" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the department.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestDepartment", "description": "The parent department.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent department.", "type": "string" }, "reference_code": { "description": "Reference code of the department.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Department", "type": "object" }, "department_id": { "description": "The worker's assigned department.", "type": "string" }, "employment_type": { "description": "The worker's employment type.\n\nExpandable field", "properties": { "amount_worked": { "description": "The amount worked for the employment type. * `FULL-TIME`: Full-time is at least 30 hours per week. Full-time workers will typically be eligible for benefits. * `PART-TIME`: Part-time is less than 30 hours per week. These workers may be eligible for benefits, depending on company settings and hours worked. * `TEMPORARY`: These workers are hired on a temporary basis. You can specify how each worker with this employment type will be paid individually.", "type": "string" }, "compensation_time_period": { "description": "The compensation period for the employment type. * `SALARIED`: Employees that are paid a fixed amount per year. * `HOURLY`: Employees that are paid a wage per hour worked.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "label": { "description": "The display label of the employment type.", "type": "string" }, "name": { "description": "The name of the employment type for non-custom employment types.", "type": "string" }, "type": { "description": "The classification of the worker by the company. * `CONTRACTOR`: Contractors are self-employed workers who provide services on a short-term or per-project basis and are not eligible for tax-withholding or benefits. * `EMPLOYEE`: Employees are hired and managed by an employer, work under the employer's direct supervision and control, and are protected by law for wages and employment rights.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "label", "updated_at" ], "title": "CompanyEmploymentType", "type": "object" }, "employment_type_id": { "description": "The worker's employment type.", "type": "string" }, "end_date": { "description": "The end date of the worker.", "type": "string" }, "ethnicity": { "description": "The identified ethnicity of the worker, if specified.", "type": "string" }, "gender": { "description": "The gender of the worker, if specified.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_manager": { "description": "Whether the worker is a manager", "type": "boolean" }, "job_function": { "description": "The worker's job function. When expanded, this field requires `job-functions.read`.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "Displayed name of the job function", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "JobFunction", "type": "object" }, "job_function_id": { "description": "ID of the worker's job function.", "type": "string" }, "legal_entity": { "description": "The worker's associated legal entity.\n\nExpandable field", "properties": { "company": { "description": "The company or organization associated with the legal entity\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "doing_business_as_name": { "description": "The doing business as name for the company.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_entities": { "description": "A list of the company's entities.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestLegalEntity" }, "type": "array" }, "legal_entities_id": { "description": "A list of the company's entities.", "items": { "type": "string" }, "type": "array" }, "legal_name": { "description": "The legal name of the company.", "type": "string" }, "name": { "description": "The name of the company.", "type": "string" }, "parent_legal_entity": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The company's ultimate holding entity.\n\nExpandable field", "type": "object" }, "parent_legal_entity_id": { "description": "The company's ultimate holding entity.", "type": "string" }, "phone": { "description": "The phone number for the company.", "type": "string" }, "physical_address": { "description": "The physical address of the holding entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "primary_email": { "description": "The email address used when registering this company.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "legal_entities", "legal_entities_id", "name", "updated_at" ], "title": "Company", "type": "object" }, "company_id": { "description": "The company or organization associated with the legal entity", "type": "string" }, "country": { "description": "The country the legal entity is based in.", "properties": { "code": { "description": "The code of the country.", "type": "string" } }, "required": [ "code" ], "title": "Country", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "entity_level": { "description": "The legal entity's level in a hierarchy. * `PARENT`: The legal entity is considered the ultimate holding entity. * `SUBSIDIARY`: The legal entity is considered a subsidiary, fully or partially held by another. * `BRANCH`: The legal entity is considered a branch, associated with a parent legal entity.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_name": { "description": "The legal name of the legal entity.", "type": "string" }, "mailing_address": { "description": "The mailing address of the legal entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "management_type": { "description": "The legal entity management type in the case of an employer of record (EOR) or professional employment organization (PEO). * `PEO`: The legal entity is considered a Professional Employment Organization (PEO). * `EOR`: The legal entity is considered an Employer of Record (EOR).", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The parent legal entity.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent legal entity.", "type": "string" }, "physical_address": { "description": "The physical address of the legal entity, if it differs from the mailing address.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "registration_date": { "description": "The registration date of the entity.", "type": "string" }, "tax_identifier": { "description": "The tax identifier for the legal entity.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "LegalEntity", "type": "object" }, "legal_entity_id": { "description": "The worker's associated legal entity.", "type": "string" }, "level": { "description": "The level of the worker.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "description": { "description": "The description of the level.", "type": "string" }, "experience_requirements": { "description": "The experience requirements for the level.", "type": "string" }, "global_level": { "anyOf": [ { "description": "Global level is used to track the seniority of levels. The higher up a level is placed on the page, the more senior and higher-ranked the level. Global level is used in workflows, policies, and reports that use the level attribute (e.g., you can use Level Lookup to set up a workflow that notifies the nearest person in an worker's management chain at or above the specified level).", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the level. Must be unique within the company or organization.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLevel", "description": "The parent level.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent level.", "type": "string" }, "rank": { "anyOf": [ { "description": "The rank of the level within its track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "scope_of_responsibilities": { "description": "The scope of responsibilities for the level.", "type": "string" }, "track": { "description": "The track associated with the level, if it's not a global level.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_default": { "description": "Whether this is the company's default track.", "type": "boolean" }, "name": { "description": "The name of the track. Must be unique within the company or organization.", "type": "string" }, "order": { "anyOf": [ { "description": "The one-based horizontal display order of the track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "start_global_level": { "anyOf": [ { "description": "The highest global level occupied by this track. Empty tracks return null.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Track", "type": "object" }, "track_id": { "description": "The track associated with the level. Required during creation. Include global_level when changing it.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Level", "type": "object" }, "level_id": { "description": "The level of the worker.", "type": "string" }, "location": { "description": "The location that the worker is mapped to for tax purposes. In the case that a worker is remote, the location's type is remote.", "properties": { "type": { "description": "The type of location.", "type": "string" }, "work_location_id": { "description": "The work location, if the worker isn't remote.", "type": "string" } }, "required": [ "type", "work_location_id" ], "title": "WorkerLocation", "type": "object" }, "manager": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's manager.\n\nExpandable field", "type": "object" }, "manager_id": { "description": "The worker's manager.", "type": "string" }, "number": { "anyOf": [ { "description": "The worker's number within the organization.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "original_start_date": { "description": "The worker's earliest start date across their employment history, excluding INIT roles.", "type": "string" }, "overtime_exemption": { "description": "The worker's overtime exemption status.", "type": "string" }, "pay_schedule_id": { "description": "The ID of the pay schedule currently associated with the worker.", "type": "string" }, "personal_email": { "description": "The worker's associated personal email address.", "type": "string" }, "race": { "description": "The identified race of the worker, if specified.", "type": "string" }, "start_date": { "description": "The start date of the worker.", "type": "string" }, "status": { "description": "The worker's status within the organization.", "type": "string" }, "teams": { "description": "The worker's assigned teams.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiTeamcb26bc28f32f" }, "type": "array" }, "teams_id": { "description": "The worker's assigned teams.", "items": { "type": "string" }, "type": "array" }, "termination_details": { "description": "The details of the worker's termination, if applicable.", "properties": { "reason": { "description": "This is a description that will be custom to each Rippling company.", "type": "string" }, "type": { "description": "The termination type indicates whether the termination was voluntary or involuntary.", "type": "string" } }, "title": "TerminationDetails", "type": "object" }, "title": { "description": "The worker's title.", "type": "string" }, "title_effective_date": { "description": "Title effective date", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "user": { "description": "The worker's associated user.\n\nExpandable field", "properties": { "active": { "description": "Whether the user is able to access company resources, typically when they are in actively engaged with the company and not after off-boarding.", "type": "boolean" }, "addresses": { "description": "The user's addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiUserAddressedd59b9ba9a1" }, "type": "array" }, "created_at": { "description": "Record creation date", "type": "string" }, "display_name": { "description": "The display name of the user using either the concatenated preferred given and family name or username depending on availability.", "type": "string" }, "emails": { "description": "The user's email addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiEmail5284c8258dc3" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "locale": { "description": "The User's default location for purposes of localization of currency, date time format, or numerical representations pursuant to RFC5646.", "type": "string" }, "name": { "description": "The user's name.", "properties": { "family_name": { "description": "The legal family name of the user, or last name in most Western languages.", "type": "string" }, "formatted": { "description": "The user's full name.", "type": "string" }, "given_name": { "description": "The given legal name of the user, or first name in most Western languages.", "type": "string" }, "middle_name": { "description": "The middle name(s) of the user.", "type": "string" }, "preferred_family_name": { "description": "The preferred family name, or last name in most Western languages, by the user.", "type": "string" }, "preferred_given_name": { "description": "The preferred given name, or first name in most Western languages, by the user.", "type": "string" } }, "title": "UserName", "type": "object" }, "number": { "description": "The permanent profile number of the user.", "type": "string" }, "phone_numbers": { "description": "The user's phone numbers.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoneNumber12060c61ecf5" }, "type": "array" }, "photos": { "description": "The user's photos.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoto2be7c3ae3f39" }, "type": "array" }, "preferred_language": { "description": "The User's preferred written or spoken language in the same format of the HTTP Accept-Language header, pursuant to Section 5.3.5 of RFC7231.", "type": "string" }, "timezone": { "description": "The User's current time zone in IANA database Olson format", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "username": { "description": "The unique identifier across Rippling used by the User for direct authentication into their associated company. Globally unique.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "User", "type": "object" }, "user_id": { "description": "The worker's associated user.", "type": "string" }, "work_email": { "description": "The worker's associated work email address.", "type": "string" }, "work_schedule": { "additionalProperties": { "$ref": "#/components/schemas/OutputRestApiWorkScheduleDay938f88d94f20" }, "description": "The worker's scheduled working hours for each day of the week.", "type": "object" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Worker", "type": "object" }, "worker_id": { "description": "The ID of the worker. Empty string '' to unassign if shift is from an open/empty shift.", "type": "string" } }, "required": [ "created_at", "id", "is_published", "schedule_id", "shift_data", "updated_at", "worker_id" ], "title": "ShiftAssignment", "type": "object" }, "OutputRestApiShiftBreak314820414f10": { "description": "", "properties": { "duration_minutes": { "anyOf": [ { "description": "The duration of the shift break in minutes (input only for creation)", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "end_time": { "description": "The end time of the shift break (calculated from start_time + duration_minutes)", "type": "string" }, "start_time": { "description": "The start time of the shift break", "type": "string" }, "type": { "description": "The type of the shift break", "type": "string" } }, "required": [ "duration_minutes", "start_time", "type" ], "title": "ShiftBreak", "type": "object" }, "OutputRestApiShiftInput68722b7ca765": { "description": "", "properties": { "country_code": { "description": "Two letter string designating country code which the shift input is associated.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "creator": { "description": "The creator associated with the shift input.\n\nExpandable field", "properties": { "business_partners": { "description": "Worker's assigned business partners. This field is only populated when explicitly requested via the expand parameter (e.g., ?expand=business_partners). When expanded, returns an empty list ([]) if the worker has no business partners.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiBusinessPartner77b00a069c32" }, "type": "array" }, "business_partners_id": { "description": "Worker's assigned business partners unique identifiers. Returns an empty list ([]) if the worker has no business partners.", "items": { "type": "string" }, "type": "array" }, "citizenship": { "description": "The countries that the worker has citizenship in.", "type": "string" }, "compensation": { "description": "The compensation package for the worker.\n\nExpandable field", "properties": { "annual_compensation": { "description": "The worker's annual compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "annual_salary_equivalent": { "description": "The worker's annual salary equivalent, for insurance purposes. It will be equal to the worker's annual compensation, except for owners that are receiving no cashcompensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "bonus_schedule": { "description": "The worker's bonus schedule.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "hourly_wage": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "id": { "description": "Identifier field", "type": "string" }, "monthly_compensation": { "description": "The worker's monthly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "on_target_commission": { "description": "The worker's on-target commission.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "payment_terms": { "description": "The payment terms for an worker's compensation.", "type": "string" }, "payment_type": { "description": "The payment type for an worker's compensation.", "type": "string" }, "relocation_reimbursement": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "salary_effective_date": { "description": "Salary effective date", "type": "string" }, "signing_bonus": { "description": "The worker's signing bonus.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus": { "description": "The worker's target annual bonus amount.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus_percent": { "anyOf": [ { "description": "The worker's target annual bonus as a percent of annual compensation.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" }, "weekly_compensation": { "description": "The worker's weekly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "worker": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's details.\n\nExpandable field", "type": "object" }, "worker_id": { "description": "The worker's ID.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Compensation", "type": "object" }, "compensation_grade": { "description": "The compensation grade assigned to the worker, if any.", "properties": { "id": { "description": "The compensation grade's unique identifier.", "type": "string" }, "label": { "description": "The compensation grade's label.", "type": "string" } }, "title": "WorkerCompensationGrade", "type": "object" }, "compensation_id": { "description": "The compensation package for the worker.", "type": "string" }, "country": { "description": "The worker's country.", "type": "string" }, "country_fields": { "description": "Country level fields for the worker.", "properties": { "ca": { "description": "Country-wise regional fields for Canada", "properties": { "sin": { "description": "Social Insurance Number (SIN) for Canada employees.", "type": "string" } }, "title": "CanadaFields", "type": "object" }, "nz": { "description": "Country-wise regional fields for New Zealand", "properties": { "ird_number": { "description": "Inland Revenue Department (IRD) number for New Zealand employees.", "type": "string" } }, "title": "NewZealandFields", "type": "object" }, "us": { "description": "Country-wise regional fields for USA", "properties": { "ssn": { "description": "Social Security Number (SSN) for US employees.", "type": "string" } }, "title": "USFields", "type": "object" } }, "title": "CountryFields", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "custom_fields": { "description": "Custom field values defined on the Employee object for this worker\n\nExpandable field", "items": { "additionalProperties": {} }, "type": "array" }, "date_of_birth": { "description": "The worker's date of birth.", "type": "string" }, "department": { "description": "The worker's assigned department.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "department_hierarchy": { "description": "List of departments in the department hierarchy. Refer department_hierarchy_ids for department hierarchy order.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestDepartment" }, "type": "array" }, "department_hierarchy_id": { "description": "The identifier of departments in the department hierarchy ordered from parent department to child department.", "items": { "type": "string" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the department.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestDepartment", "description": "The parent department.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent department.", "type": "string" }, "reference_code": { "description": "Reference code of the department.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Department", "type": "object" }, "department_id": { "description": "The worker's assigned department.", "type": "string" }, "employment_type": { "description": "The worker's employment type.\n\nExpandable field", "properties": { "amount_worked": { "description": "The amount worked for the employment type. * `FULL-TIME`: Full-time is at least 30 hours per week. Full-time workers will typically be eligible for benefits. * `PART-TIME`: Part-time is less than 30 hours per week. These workers may be eligible for benefits, depending on company settings and hours worked. * `TEMPORARY`: These workers are hired on a temporary basis. You can specify how each worker with this employment type will be paid individually.", "type": "string" }, "compensation_time_period": { "description": "The compensation period for the employment type. * `SALARIED`: Employees that are paid a fixed amount per year. * `HOURLY`: Employees that are paid a wage per hour worked.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "label": { "description": "The display label of the employment type.", "type": "string" }, "name": { "description": "The name of the employment type for non-custom employment types.", "type": "string" }, "type": { "description": "The classification of the worker by the company. * `CONTRACTOR`: Contractors are self-employed workers who provide services on a short-term or per-project basis and are not eligible for tax-withholding or benefits. * `EMPLOYEE`: Employees are hired and managed by an employer, work under the employer's direct supervision and control, and are protected by law for wages and employment rights.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "label", "updated_at" ], "title": "CompanyEmploymentType", "type": "object" }, "employment_type_id": { "description": "The worker's employment type.", "type": "string" }, "end_date": { "description": "The end date of the worker.", "type": "string" }, "ethnicity": { "description": "The identified ethnicity of the worker, if specified.", "type": "string" }, "gender": { "description": "The gender of the worker, if specified.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_manager": { "description": "Whether the worker is a manager", "type": "boolean" }, "job_function": { "description": "The worker's job function. When expanded, this field requires `job-functions.read`.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "Displayed name of the job function", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "JobFunction", "type": "object" }, "job_function_id": { "description": "ID of the worker's job function.", "type": "string" }, "legal_entity": { "description": "The worker's associated legal entity.\n\nExpandable field", "properties": { "company": { "description": "The company or organization associated with the legal entity\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "doing_business_as_name": { "description": "The doing business as name for the company.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_entities": { "description": "A list of the company's entities.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestLegalEntity" }, "type": "array" }, "legal_entities_id": { "description": "A list of the company's entities.", "items": { "type": "string" }, "type": "array" }, "legal_name": { "description": "The legal name of the company.", "type": "string" }, "name": { "description": "The name of the company.", "type": "string" }, "parent_legal_entity": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The company's ultimate holding entity.\n\nExpandable field", "type": "object" }, "parent_legal_entity_id": { "description": "The company's ultimate holding entity.", "type": "string" }, "phone": { "description": "The phone number for the company.", "type": "string" }, "physical_address": { "description": "The physical address of the holding entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "primary_email": { "description": "The email address used when registering this company.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "legal_entities", "legal_entities_id", "name", "updated_at" ], "title": "Company", "type": "object" }, "company_id": { "description": "The company or organization associated with the legal entity", "type": "string" }, "country": { "description": "The country the legal entity is based in.", "properties": { "code": { "description": "The code of the country.", "type": "string" } }, "required": [ "code" ], "title": "Country", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "entity_level": { "description": "The legal entity's level in a hierarchy. * `PARENT`: The legal entity is considered the ultimate holding entity. * `SUBSIDIARY`: The legal entity is considered a subsidiary, fully or partially held by another. * `BRANCH`: The legal entity is considered a branch, associated with a parent legal entity.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_name": { "description": "The legal name of the legal entity.", "type": "string" }, "mailing_address": { "description": "The mailing address of the legal entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "management_type": { "description": "The legal entity management type in the case of an employer of record (EOR) or professional employment organization (PEO). * `PEO`: The legal entity is considered a Professional Employment Organization (PEO). * `EOR`: The legal entity is considered an Employer of Record (EOR).", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The parent legal entity.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent legal entity.", "type": "string" }, "physical_address": { "description": "The physical address of the legal entity, if it differs from the mailing address.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "registration_date": { "description": "The registration date of the entity.", "type": "string" }, "tax_identifier": { "description": "The tax identifier for the legal entity.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "LegalEntity", "type": "object" }, "legal_entity_id": { "description": "The worker's associated legal entity.", "type": "string" }, "level": { "description": "The level of the worker.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "description": { "description": "The description of the level.", "type": "string" }, "experience_requirements": { "description": "The experience requirements for the level.", "type": "string" }, "global_level": { "anyOf": [ { "description": "Global level is used to track the seniority of levels. The higher up a level is placed on the page, the more senior and higher-ranked the level. Global level is used in workflows, policies, and reports that use the level attribute (e.g., you can use Level Lookup to set up a workflow that notifies the nearest person in an worker's management chain at or above the specified level).", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the level. Must be unique within the company or organization.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLevel", "description": "The parent level.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent level.", "type": "string" }, "rank": { "anyOf": [ { "description": "The rank of the level within its track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "scope_of_responsibilities": { "description": "The scope of responsibilities for the level.", "type": "string" }, "track": { "description": "The track associated with the level, if it's not a global level.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_default": { "description": "Whether this is the company's default track.", "type": "boolean" }, "name": { "description": "The name of the track. Must be unique within the company or organization.", "type": "string" }, "order": { "anyOf": [ { "description": "The one-based horizontal display order of the track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "start_global_level": { "anyOf": [ { "description": "The highest global level occupied by this track. Empty tracks return null.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Track", "type": "object" }, "track_id": { "description": "The track associated with the level. Required during creation. Include global_level when changing it.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Level", "type": "object" }, "level_id": { "description": "The level of the worker.", "type": "string" }, "location": { "description": "The location that the worker is mapped to for tax purposes. In the case that a worker is remote, the location's type is remote.", "properties": { "type": { "description": "The type of location.", "type": "string" }, "work_location_id": { "description": "The work location, if the worker isn't remote.", "type": "string" } }, "required": [ "type", "work_location_id" ], "title": "WorkerLocation", "type": "object" }, "manager": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's manager.\n\nExpandable field", "type": "object" }, "manager_id": { "description": "The worker's manager.", "type": "string" }, "number": { "anyOf": [ { "description": "The worker's number within the organization.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "original_start_date": { "description": "The worker's earliest start date across their employment history, excluding INIT roles.", "type": "string" }, "overtime_exemption": { "description": "The worker's overtime exemption status.", "type": "string" }, "pay_schedule_id": { "description": "The ID of the pay schedule currently associated with the worker.", "type": "string" }, "personal_email": { "description": "The worker's associated personal email address.", "type": "string" }, "race": { "description": "The identified race of the worker, if specified.", "type": "string" }, "start_date": { "description": "The start date of the worker.", "type": "string" }, "status": { "description": "The worker's status within the organization.", "type": "string" }, "teams": { "description": "The worker's assigned teams.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiTeamcb26bc28f32f" }, "type": "array" }, "teams_id": { "description": "The worker's assigned teams.", "items": { "type": "string" }, "type": "array" }, "termination_details": { "description": "The details of the worker's termination, if applicable.", "properties": { "reason": { "description": "This is a description that will be custom to each Rippling company.", "type": "string" }, "type": { "description": "The termination type indicates whether the termination was voluntary or involuntary.", "type": "string" } }, "title": "TerminationDetails", "type": "object" }, "title": { "description": "The worker's title.", "type": "string" }, "title_effective_date": { "description": "Title effective date", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "user": { "description": "The worker's associated user.\n\nExpandable field", "properties": { "active": { "description": "Whether the user is able to access company resources, typically when they are in actively engaged with the company and not after off-boarding.", "type": "boolean" }, "addresses": { "description": "The user's addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiUserAddressedd59b9ba9a1" }, "type": "array" }, "created_at": { "description": "Record creation date", "type": "string" }, "display_name": { "description": "The display name of the user using either the concatenated preferred given and family name or username depending on availability.", "type": "string" }, "emails": { "description": "The user's email addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiEmail5284c8258dc3" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "locale": { "description": "The User's default location for purposes of localization of currency, date time format, or numerical representations pursuant to RFC5646.", "type": "string" }, "name": { "description": "The user's name.", "properties": { "family_name": { "description": "The legal family name of the user, or last name in most Western languages.", "type": "string" }, "formatted": { "description": "The user's full name.", "type": "string" }, "given_name": { "description": "The given legal name of the user, or first name in most Western languages.", "type": "string" }, "middle_name": { "description": "The middle name(s) of the user.", "type": "string" }, "preferred_family_name": { "description": "The preferred family name, or last name in most Western languages, by the user.", "type": "string" }, "preferred_given_name": { "description": "The preferred given name, or first name in most Western languages, by the user.", "type": "string" } }, "title": "UserName", "type": "object" }, "number": { "description": "The permanent profile number of the user.", "type": "string" }, "phone_numbers": { "description": "The user's phone numbers.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoneNumber12060c61ecf5" }, "type": "array" }, "photos": { "description": "The user's photos.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoto2be7c3ae3f39" }, "type": "array" }, "preferred_language": { "description": "The User's preferred written or spoken language in the same format of the HTTP Accept-Language header, pursuant to Section 5.3.5 of RFC7231.", "type": "string" }, "timezone": { "description": "The User's current time zone in IANA database Olson format", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "username": { "description": "The unique identifier across Rippling used by the User for direct authentication into their associated company. Globally unique.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "User", "type": "object" }, "user_id": { "description": "The worker's associated user.", "type": "string" }, "work_email": { "description": "The worker's associated work email address.", "type": "string" }, "work_schedule": { "additionalProperties": { "$ref": "#/components/schemas/OutputRestApiWorkScheduleDay938f88d94f20" }, "description": "The worker's scheduled working hours for each day of the week.", "type": "object" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Worker", "type": "object" }, "creator_id": { "description": "The creator id associated with the shift input.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "managed_by": { "description": "The party that manages this shift input", "type": "string" }, "name": { "description": "Name of the shift unit.", "type": "string" }, "prompt": { "description": "Prompt for the shift unit.", "type": "string" }, "type": { "description": "Type of shift unit.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "country_code", "created_at", "id", "name", "prompt", "type", "updated_at" ], "title": "ShiftInput", "type": "object" }, "OutputRestApiShiftInputValued170635510cb": { "description": "", "properties": { "author_id": { "description": "The id of the role that last added/updated this input.", "type": "string" }, "shift_input_id": { "description": "The id of the relevant shift input", "type": "string" }, "value": { "description": "The value of the shift input.", "type": "object" } }, "required": [ "shift_input_id", "value" ], "title": "ShiftInputValue", "type": "object" }, "OutputRestApiShiftSegment2a530a829033": { "description": "", "properties": { "duration_minutes": { "anyOf": [ { "description": "The duration of the shift segment in minutes (input only for creation)", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "end_time": { "description": "The end time of the shift segment (calculated from start_time + duration_minutes)", "type": "string" }, "job_codes_id": { "description": "The IDs of the job codes associated with the shift segment", "items": { "type": "string" }, "type": "array" }, "start_time": { "description": "The start time of the shift segment", "type": "string" } }, "required": [ "duration_minutes", "start_time" ], "title": "ShiftSegment", "type": "object" }, "OutputRestApiSite17f973608cc3": { "description": "Response/resource shape for a custom site.", "properties": { "admin_group_id": { "description": "The admin group id for the custom site", "type": "string" }, "api_name": { "description": "The unique api name of the custom site", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "created_by": { "description": "The ID of the role that created the custom site", "type": "string" }, "current_bundle_id": { "description": "The active bundle id for the custom site", "type": "string" }, "description": { "description": "The optional description of the custom site", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "logo": { "description": "A Rippling-owned logo URL for the custom site", "type": "string" }, "name": { "description": "The display name of the custom site", "type": "string" }, "viewer_group_id": { "description": "The viewer group id for the custom site", "type": "string" } }, "title": "Site", "type": "object" }, "OutputRestApiSiteBundleDirectory139b2007444e": { "description": "", "properties": { "name": { "description": "Directory name.", "type": "string" }, "parent_path": { "description": "Parent directory path.", "type": "string" }, "path": { "description": "Normalized directory path inside the active bundle.", "type": "string" } }, "title": "SiteBundleDirectory", "type": "object" }, "OutputRestApiSiteBundleFile13251ce38f51": { "description": "", "properties": { "content_type": { "description": "MIME content type.", "type": "string" }, "name": { "description": "File name.", "type": "string" }, "parent_path": { "description": "Parent directory path.", "type": "string" }, "path": { "description": "Normalized file path inside the active bundle.", "type": "string" }, "sha256": { "description": "SHA-256 hash of the file contents.", "type": "string" }, "size_bytes": { "anyOf": [ { "description": "File size in bytes.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "SiteBundleFile", "type": "object" }, "OutputRestApiSiteFileListResponse500885ed9596": { "description": "", "properties": { "bundle_id": { "description": "Active bundle identifier.", "type": "string" }, "directories": { "description": "Directories in the listing scope.", "items": { "$ref": "#/components/schemas/OutputRestApiSiteBundleDirectory139b2007444e" }, "type": "array" }, "entry_path": { "description": "Entry path for the active bundle.", "type": "string" }, "files": { "description": "Files in the listing scope.", "items": { "$ref": "#/components/schemas/OutputRestApiSiteBundleFile13251ce38f51" }, "type": "array" }, "parent_path": { "description": "Directory path used for the listing.", "type": "string" }, "recursive": { "description": "Whether the listing was recursive.", "type": "boolean" } }, "title": "SiteFileListResponse", "type": "object" }, "OutputRestApiSiteStagedUploadBatchResponse2260ba5ee8b1": { "description": "", "properties": { "files": { "description": "Staged files created by the upload batch.", "items": { "$ref": "#/components/schemas/OutputRestApiSiteStagedUploadFilec86173c79116" }, "type": "array" }, "upload_batch_id": { "description": "Identifier for the staged upload batch.", "type": "string" } }, "title": "SiteStagedUploadBatchResponse", "type": "object" }, "OutputRestApiSiteStagedUploadFilec86173c79116": { "description": "", "properties": { "client_ref": { "description": "Any unique client-chosen id echoed with the staged file_id for correlation. Not used server-side beyond the response.", "type": "string" }, "file_id": { "description": "Staged upload identifier for use in create, update, or file operations after uploading bytes to S3. The id can be reused for 1 hour from presign, each attach copies the bytes into that site's bundle, a repeat attach before expiry creates another bundle, and the staged object is removed after expiry.", "type": "string" }, "file_name": { "description": "Staged file name from the presign file_name intent.", "type": "string" }, "status": { "description": "Upload status. Returns awaiting_upload after presign until the file is uploaded to S3. After the object exists in S3, status becomes active on first use. Attach does not consume the staged upload; it is removed after expiry.", "type": "string" }, "upload_fields": { "description": "Form fields required for the S3 POST (send these before the file part).", "type": "object" }, "upload_url": { "description": "Presigned S3 POST URL for uploading the file bytes.", "type": "string" } }, "title": "SiteStagedUploadFile", "type": "object" }, "OutputRestApiSlackTriggerf09888f51404": { "additionalProperties": false, "properties": { "allowed_sender_group_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "channel_ids": { "items": { "type": "string" }, "minItems": 1, "type": "array" }, "event_type": { "type": "string" }, "include_thread_replies": { "default": false, "type": "boolean" }, "kind": { "type": "string" }, "message_text_regex": { "anyOf": [ { "maxLength": 512, "type": "string" }, { "type": "null" } ] }, "reaction_names": { "items": { "type": "string" }, "type": "array" } }, "required": [ "channel_ids", "event_type", "kind" ], "title": "SlackTrigger", "type": "object" }, "OutputRestApiSoftwareDeployment2f2360103426": { "description": "", "properties": { "active_group_type": { "description": "Type of group targeting: 'Role' or 'Device'.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "group_id": { "description": "Group ID for role-based targeting. Required if active_group_type is 'Role'. Must be null if 'Device'.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_report_syncing_in_progress": { "description": "Whether installation report syncing is in progress. When true, deployment status may be temporarily inconsistent.", "type": "boolean" }, "ma_device_group_id": { "description": "Device group ID for device-based targeting. Required if active_group_type is 'Device'. Must be null if 'Role'.", "type": "string" }, "software": { "description": "The software being deployed. Expandable to get software name, icon, and metadata.\n\nExpandable field", "properties": { "available_platforms": { "description": "Platforms this software is available on (macOS, Windows, etc).", "items": { "type": "string" }, "type": "array" }, "category": { "description": "Category of the software.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "description": { "description": "Description of the software.", "type": "string" }, "display_name": { "description": "Custom display name for the software.", "type": "string" }, "icon_url": { "description": "URL for the software icon.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the software.", "type": "string" }, "scope": { "description": "Scope of the software (PUBLIC, CUSTOM, INTERNAL).", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "SFMSoftware", "type": "object" }, "software_id": { "description": "The ID of the software to deploy.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "software_id", "updated_at" ], "title": "SoftwareDeployment", "type": "object" }, "OutputRestApiSplit283f489e3a65": { "description": "A single split row representing a percentage allocation across one or more job codes.", "properties": { "job_code_ids": { "description": "IDs of canonical /job-codes/ resources in this split row.", "items": { "type": "string" }, "type": "array" }, "split_percentage": { "description": "Percentage allocated to this split row. Decimal string with precision 2; must be greater than zero per row. All rows must sum to 100.00 when is_enabled is true.", "type": "string" } }, "title": "Split", "type": "object" }, "OutputRestApiSupergroup02a67f7960e9": { "description": "", "properties": { "allow_non_employees": { "description": "Whether the group allows non employees", "type": "boolean" }, "app_owner_id": { "description": "The id of the group's app owner.", "type": "string" }, "can_override_role_states": { "description": "Whether the group can override role states", "type": "boolean" }, "created_at": { "description": "Record creation date", "type": "string" }, "cumulatively_exhaustive_default": { "description": "Whether the group is the cumulatively exhaustive default", "type": "boolean" }, "description": { "description": "The group's description.", "type": "string" }, "display_name": { "description": "The group's display name.", "type": "string" }, "group_type": { "description": "The group type", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "ignore_prov_group_matching": { "description": "Whether to ignore provisioning group matching when determining group membership", "type": "boolean" }, "include_terminated": { "description": "Whether the group include terminated roles", "type": "boolean" }, "is_invisible": { "description": "Whether the group is invisible", "type": "boolean" }, "mutually_exclusive_key": { "description": "The group's mutually exclusive key", "type": "string" }, "name": { "description": "The group's name.", "type": "string" }, "parent": { "description": "The group's parent.", "type": "string" }, "priority": { "anyOf": [ { "description": "The group's priority when calculating mutual exclusivity", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "read_only": { "description": "Whether the group is read only.", "type": "boolean" }, "sub_group_type": { "description": "The sub group type", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Supergroup", "type": "object" }, "OutputRestApiTeamcb26bc28f32f": { "description": "", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the team.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestTeam", "description": "The parent team\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent team", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Team", "type": "object" }, "OutputRestApiTimeCard1831ec89697c": { "description": "", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "pay_period": { "description": "The pay period associated with the time card.", "properties": { "end_date": { "description": "The end date of the pay period.", "type": "string" }, "pay_schedule_id": { "description": "The ID of the pay schedule associated with the pay period.", "type": "string" }, "start_date": { "description": "The start date of the pay period.", "type": "string" } }, "title": "PayPeriod", "type": "object" }, "summary": { "description": "The summary of the time card.", "properties": { "approved_hours": { "anyOf": [ { "description": "The approved hours for the pay period.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "double_overtime_hours": { "anyOf": [ { "description": "The total number of doubletime hours worked during the pay period.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "earnings": { "anyOf": [ { "description": "The earnings for the pay period.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "hours_worked_by_job_code": { "description": "The amount of hours worked for each job code for the pay period.", "items": { "$ref": "#/components/schemas/OutputRestApiJobCodeSummary73cdc3312543" }, "type": "array" }, "overtime_hours": { "anyOf": [ { "description": "The total number of overtime hours worked during the pay period.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "paid_hours": { "anyOf": [ { "description": "The paid hours for the pay period.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "premiums": { "anyOf": [ { "description": "The premiums for the pay period.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "regular_hours": { "anyOf": [ { "description": "The total number of regular hours worked during the pay period.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "total_holiday_hours": { "anyOf": [ { "description": "The total holiday hours for the pay period.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "total_hours": { "anyOf": [ { "description": "The total hours for the pay period.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "total_paid_time_off_hours": { "anyOf": [ { "description": "The total paid time off hours for the pay period.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "total_unpaid_time_off_hours": { "anyOf": [ { "description": "The total unpaid time off hours for the pay period.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "unpaid_break_hours_by_entry": { "anyOf": [ { "description": "The map of time entry to unpaidBreakHours in seconds", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "TimeCardSummary", "type": "object" }, "updated_at": { "description": "Record update date", "type": "string" }, "worker": { "description": "The worker associated with the time card.\n\nExpandable field", "properties": { "business_partners": { "description": "Worker's assigned business partners. This field is only populated when explicitly requested via the expand parameter (e.g., ?expand=business_partners). When expanded, returns an empty list ([]) if the worker has no business partners.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiBusinessPartner77b00a069c32" }, "type": "array" }, "business_partners_id": { "description": "Worker's assigned business partners unique identifiers. Returns an empty list ([]) if the worker has no business partners.", "items": { "type": "string" }, "type": "array" }, "citizenship": { "description": "The countries that the worker has citizenship in.", "type": "string" }, "compensation": { "description": "The compensation package for the worker.\n\nExpandable field", "properties": { "annual_compensation": { "description": "The worker's annual compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "annual_salary_equivalent": { "description": "The worker's annual salary equivalent, for insurance purposes. It will be equal to the worker's annual compensation, except for owners that are receiving no cashcompensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "bonus_schedule": { "description": "The worker's bonus schedule.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "hourly_wage": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "id": { "description": "Identifier field", "type": "string" }, "monthly_compensation": { "description": "The worker's monthly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "on_target_commission": { "description": "The worker's on-target commission.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "payment_terms": { "description": "The payment terms for an worker's compensation.", "type": "string" }, "payment_type": { "description": "The payment type for an worker's compensation.", "type": "string" }, "relocation_reimbursement": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "salary_effective_date": { "description": "Salary effective date", "type": "string" }, "signing_bonus": { "description": "The worker's signing bonus.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus": { "description": "The worker's target annual bonus amount.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus_percent": { "anyOf": [ { "description": "The worker's target annual bonus as a percent of annual compensation.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" }, "weekly_compensation": { "description": "The worker's weekly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "worker": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's details.\n\nExpandable field", "type": "object" }, "worker_id": { "description": "The worker's ID.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Compensation", "type": "object" }, "compensation_grade": { "description": "The compensation grade assigned to the worker, if any.", "properties": { "id": { "description": "The compensation grade's unique identifier.", "type": "string" }, "label": { "description": "The compensation grade's label.", "type": "string" } }, "title": "WorkerCompensationGrade", "type": "object" }, "compensation_id": { "description": "The compensation package for the worker.", "type": "string" }, "country": { "description": "The worker's country.", "type": "string" }, "country_fields": { "description": "Country level fields for the worker.", "properties": { "ca": { "description": "Country-wise regional fields for Canada", "properties": { "sin": { "description": "Social Insurance Number (SIN) for Canada employees.", "type": "string" } }, "title": "CanadaFields", "type": "object" }, "nz": { "description": "Country-wise regional fields for New Zealand", "properties": { "ird_number": { "description": "Inland Revenue Department (IRD) number for New Zealand employees.", "type": "string" } }, "title": "NewZealandFields", "type": "object" }, "us": { "description": "Country-wise regional fields for USA", "properties": { "ssn": { "description": "Social Security Number (SSN) for US employees.", "type": "string" } }, "title": "USFields", "type": "object" } }, "title": "CountryFields", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "custom_fields": { "description": "Custom field values defined on the Employee object for this worker\n\nExpandable field", "items": { "additionalProperties": {} }, "type": "array" }, "date_of_birth": { "description": "The worker's date of birth.", "type": "string" }, "department": { "description": "The worker's assigned department.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "department_hierarchy": { "description": "List of departments in the department hierarchy. Refer department_hierarchy_ids for department hierarchy order.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestDepartment" }, "type": "array" }, "department_hierarchy_id": { "description": "The identifier of departments in the department hierarchy ordered from parent department to child department.", "items": { "type": "string" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the department.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestDepartment", "description": "The parent department.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent department.", "type": "string" }, "reference_code": { "description": "Reference code of the department.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Department", "type": "object" }, "department_id": { "description": "The worker's assigned department.", "type": "string" }, "employment_type": { "description": "The worker's employment type.\n\nExpandable field", "properties": { "amount_worked": { "description": "The amount worked for the employment type. * `FULL-TIME`: Full-time is at least 30 hours per week. Full-time workers will typically be eligible for benefits. * `PART-TIME`: Part-time is less than 30 hours per week. These workers may be eligible for benefits, depending on company settings and hours worked. * `TEMPORARY`: These workers are hired on a temporary basis. You can specify how each worker with this employment type will be paid individually.", "type": "string" }, "compensation_time_period": { "description": "The compensation period for the employment type. * `SALARIED`: Employees that are paid a fixed amount per year. * `HOURLY`: Employees that are paid a wage per hour worked.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "label": { "description": "The display label of the employment type.", "type": "string" }, "name": { "description": "The name of the employment type for non-custom employment types.", "type": "string" }, "type": { "description": "The classification of the worker by the company. * `CONTRACTOR`: Contractors are self-employed workers who provide services on a short-term or per-project basis and are not eligible for tax-withholding or benefits. * `EMPLOYEE`: Employees are hired and managed by an employer, work under the employer's direct supervision and control, and are protected by law for wages and employment rights.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "label", "updated_at" ], "title": "CompanyEmploymentType", "type": "object" }, "employment_type_id": { "description": "The worker's employment type.", "type": "string" }, "end_date": { "description": "The end date of the worker.", "type": "string" }, "ethnicity": { "description": "The identified ethnicity of the worker, if specified.", "type": "string" }, "gender": { "description": "The gender of the worker, if specified.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_manager": { "description": "Whether the worker is a manager", "type": "boolean" }, "job_function": { "description": "The worker's job function. When expanded, this field requires `job-functions.read`.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "Displayed name of the job function", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "JobFunction", "type": "object" }, "job_function_id": { "description": "ID of the worker's job function.", "type": "string" }, "legal_entity": { "description": "The worker's associated legal entity.\n\nExpandable field", "properties": { "company": { "description": "The company or organization associated with the legal entity\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "doing_business_as_name": { "description": "The doing business as name for the company.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_entities": { "description": "A list of the company's entities.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestLegalEntity" }, "type": "array" }, "legal_entities_id": { "description": "A list of the company's entities.", "items": { "type": "string" }, "type": "array" }, "legal_name": { "description": "The legal name of the company.", "type": "string" }, "name": { "description": "The name of the company.", "type": "string" }, "parent_legal_entity": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The company's ultimate holding entity.\n\nExpandable field", "type": "object" }, "parent_legal_entity_id": { "description": "The company's ultimate holding entity.", "type": "string" }, "phone": { "description": "The phone number for the company.", "type": "string" }, "physical_address": { "description": "The physical address of the holding entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "primary_email": { "description": "The email address used when registering this company.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "legal_entities", "legal_entities_id", "name", "updated_at" ], "title": "Company", "type": "object" }, "company_id": { "description": "The company or organization associated with the legal entity", "type": "string" }, "country": { "description": "The country the legal entity is based in.", "properties": { "code": { "description": "The code of the country.", "type": "string" } }, "required": [ "code" ], "title": "Country", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "entity_level": { "description": "The legal entity's level in a hierarchy. * `PARENT`: The legal entity is considered the ultimate holding entity. * `SUBSIDIARY`: The legal entity is considered a subsidiary, fully or partially held by another. * `BRANCH`: The legal entity is considered a branch, associated with a parent legal entity.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_name": { "description": "The legal name of the legal entity.", "type": "string" }, "mailing_address": { "description": "The mailing address of the legal entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "management_type": { "description": "The legal entity management type in the case of an employer of record (EOR) or professional employment organization (PEO). * `PEO`: The legal entity is considered a Professional Employment Organization (PEO). * `EOR`: The legal entity is considered an Employer of Record (EOR).", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The parent legal entity.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent legal entity.", "type": "string" }, "physical_address": { "description": "The physical address of the legal entity, if it differs from the mailing address.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "registration_date": { "description": "The registration date of the entity.", "type": "string" }, "tax_identifier": { "description": "The tax identifier for the legal entity.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "LegalEntity", "type": "object" }, "legal_entity_id": { "description": "The worker's associated legal entity.", "type": "string" }, "level": { "description": "The level of the worker.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "description": { "description": "The description of the level.", "type": "string" }, "experience_requirements": { "description": "The experience requirements for the level.", "type": "string" }, "global_level": { "anyOf": [ { "description": "Global level is used to track the seniority of levels. The higher up a level is placed on the page, the more senior and higher-ranked the level. Global level is used in workflows, policies, and reports that use the level attribute (e.g., you can use Level Lookup to set up a workflow that notifies the nearest person in an worker's management chain at or above the specified level).", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the level. Must be unique within the company or organization.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLevel", "description": "The parent level.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent level.", "type": "string" }, "rank": { "anyOf": [ { "description": "The rank of the level within its track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "scope_of_responsibilities": { "description": "The scope of responsibilities for the level.", "type": "string" }, "track": { "description": "The track associated with the level, if it's not a global level.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_default": { "description": "Whether this is the company's default track.", "type": "boolean" }, "name": { "description": "The name of the track. Must be unique within the company or organization.", "type": "string" }, "order": { "anyOf": [ { "description": "The one-based horizontal display order of the track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "start_global_level": { "anyOf": [ { "description": "The highest global level occupied by this track. Empty tracks return null.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Track", "type": "object" }, "track_id": { "description": "The track associated with the level. Required during creation. Include global_level when changing it.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Level", "type": "object" }, "level_id": { "description": "The level of the worker.", "type": "string" }, "location": { "description": "The location that the worker is mapped to for tax purposes. In the case that a worker is remote, the location's type is remote.", "properties": { "type": { "description": "The type of location.", "type": "string" }, "work_location_id": { "description": "The work location, if the worker isn't remote.", "type": "string" } }, "required": [ "type", "work_location_id" ], "title": "WorkerLocation", "type": "object" }, "manager": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's manager.\n\nExpandable field", "type": "object" }, "manager_id": { "description": "The worker's manager.", "type": "string" }, "number": { "anyOf": [ { "description": "The worker's number within the organization.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "original_start_date": { "description": "The worker's earliest start date across their employment history, excluding INIT roles.", "type": "string" }, "overtime_exemption": { "description": "The worker's overtime exemption status.", "type": "string" }, "pay_schedule_id": { "description": "The ID of the pay schedule currently associated with the worker.", "type": "string" }, "personal_email": { "description": "The worker's associated personal email address.", "type": "string" }, "race": { "description": "The identified race of the worker, if specified.", "type": "string" }, "start_date": { "description": "The start date of the worker.", "type": "string" }, "status": { "description": "The worker's status within the organization.", "type": "string" }, "teams": { "description": "The worker's assigned teams.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiTeamcb26bc28f32f" }, "type": "array" }, "teams_id": { "description": "The worker's assigned teams.", "items": { "type": "string" }, "type": "array" }, "termination_details": { "description": "The details of the worker's termination, if applicable.", "properties": { "reason": { "description": "This is a description that will be custom to each Rippling company.", "type": "string" }, "type": { "description": "The termination type indicates whether the termination was voluntary or involuntary.", "type": "string" } }, "title": "TerminationDetails", "type": "object" }, "title": { "description": "The worker's title.", "type": "string" }, "title_effective_date": { "description": "Title effective date", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "user": { "description": "The worker's associated user.\n\nExpandable field", "properties": { "active": { "description": "Whether the user is able to access company resources, typically when they are in actively engaged with the company and not after off-boarding.", "type": "boolean" }, "addresses": { "description": "The user's addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiUserAddressedd59b9ba9a1" }, "type": "array" }, "created_at": { "description": "Record creation date", "type": "string" }, "display_name": { "description": "The display name of the user using either the concatenated preferred given and family name or username depending on availability.", "type": "string" }, "emails": { "description": "The user's email addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiEmail5284c8258dc3" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "locale": { "description": "The User's default location for purposes of localization of currency, date time format, or numerical representations pursuant to RFC5646.", "type": "string" }, "name": { "description": "The user's name.", "properties": { "family_name": { "description": "The legal family name of the user, or last name in most Western languages.", "type": "string" }, "formatted": { "description": "The user's full name.", "type": "string" }, "given_name": { "description": "The given legal name of the user, or first name in most Western languages.", "type": "string" }, "middle_name": { "description": "The middle name(s) of the user.", "type": "string" }, "preferred_family_name": { "description": "The preferred family name, or last name in most Western languages, by the user.", "type": "string" }, "preferred_given_name": { "description": "The preferred given name, or first name in most Western languages, by the user.", "type": "string" } }, "title": "UserName", "type": "object" }, "number": { "description": "The permanent profile number of the user.", "type": "string" }, "phone_numbers": { "description": "The user's phone numbers.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoneNumber12060c61ecf5" }, "type": "array" }, "photos": { "description": "The user's photos.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoto2be7c3ae3f39" }, "type": "array" }, "preferred_language": { "description": "The User's preferred written or spoken language in the same format of the HTTP Accept-Language header, pursuant to Section 5.3.5 of RFC7231.", "type": "string" }, "timezone": { "description": "The User's current time zone in IANA database Olson format", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "username": { "description": "The unique identifier across Rippling used by the User for direct authentication into their associated company. Globally unique.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "User", "type": "object" }, "user_id": { "description": "The worker's associated user.", "type": "string" }, "work_email": { "description": "The worker's associated work email address.", "type": "string" }, "work_schedule": { "additionalProperties": { "$ref": "#/components/schemas/OutputRestApiWorkScheduleDay938f88d94f20" }, "description": "The worker's scheduled working hours for each day of the week.", "type": "object" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Worker", "type": "object" }, "worker_id": { "description": "The ID of the worker associated with the time card.", "type": "string" } }, "required": [ "created_at", "id", "updated_at", "worker_id" ], "title": "TimeCard", "type": "object" }, "OutputRestApiTimeEntryCommente521151255bf": { "description": "", "properties": { "author_id": { "description": "The ID of the worker who made of the comment.", "type": "string" }, "created_at": { "description": "The time the comment was created.", "type": "string" }, "text": { "description": "The text of the comment.", "type": "string" } }, "title": "TimeEntryComment", "type": "object" }, "OutputRestApiTimeEntryc217c7a2a3ac": { "description": "", "properties": { "breaks": { "description": "The breaks taken during the time entry.", "items": { "$ref": "#/components/schemas/OutputRestApiBreak50f807167b82" }, "type": "array" }, "comments": { "description": "The comments associated with the time entry.", "items": { "$ref": "#/components/schemas/OutputRestApiTimeEntryCommente521151255bf" }, "type": "array" }, "create_extra_hours_run": { "description": "Whether the time entry should create an extra hours run.", "type": "boolean" }, "created_at": { "description": "Record creation date", "type": "string" }, "end_time": { "description": "The end time of the time entry.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "idempotency_key": { "description": "The unique key of the time entry in an outside system. If set, no other time entry with the same key can be created.", "type": "string" }, "job_shifts": { "description": "The job shifts worked during the time entry.", "items": { "$ref": "#/components/schemas/OutputRestApiJobShift87137d8a0daa" }, "type": "array" }, "pay_period": { "description": "The pay period associated with the time card.", "properties": { "end_date": { "description": "The end date of the pay period.", "type": "string" }, "pay_schedule_id": { "description": "The ID of the pay schedule associated with the pay period.", "type": "string" }, "start_date": { "description": "The start date of the pay period.", "type": "string" } }, "title": "PayPeriod", "type": "object" }, "piece_rate_premiums": { "description": "The piece-rate premiums earned during the time entry.", "items": { "$ref": "#/components/schemas/OutputRestApiPieceRatePremiumsd68380854608" }, "type": "array" }, "premiums": { "description": "The premiums earned during the time entry.", "items": { "$ref": "#/components/schemas/OutputRestApiPremiumsecd81efd722e" }, "type": "array" }, "segments": { "description": "The pay rates for each segment of the time entry.", "items": { "$ref": "#/components/schemas/OutputRestApiSegmentse33b0ae25a0a" }, "type": "array" }, "shift_input_values": { "description": "Arbitrary shift inputs collected on the time entry", "items": { "$ref": "#/components/schemas/OutputRestApiShiftInputValued170635510cb" }, "type": "array" }, "start_time": { "description": "The start time of the time entry.", "type": "string" }, "status": { "description": "The status of the time entry.", "type": "string" }, "tags": { "description": "The tags associated with the time entry.", "items": { "type": "string" }, "type": "array" }, "time_card": { "description": "The time card associated with the time entry.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "pay_period": { "description": "The pay period associated with the time card.", "properties": { "end_date": { "description": "The end date of the pay period.", "type": "string" }, "pay_schedule_id": { "description": "The ID of the pay schedule associated with the pay period.", "type": "string" }, "start_date": { "description": "The start date of the pay period.", "type": "string" } }, "title": "PayPeriod", "type": "object" }, "summary": { "description": "The summary of the time card.", "properties": { "approved_hours": { "anyOf": [ { "description": "The approved hours for the pay period.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "double_overtime_hours": { "anyOf": [ { "description": "The total number of doubletime hours worked during the pay period.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "earnings": { "anyOf": [ { "description": "The earnings for the pay period.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "hours_worked_by_job_code": { "description": "The amount of hours worked for each job code for the pay period.", "items": { "$ref": "#/components/schemas/OutputRestApiJobCodeSummary73cdc3312543" }, "type": "array" }, "overtime_hours": { "anyOf": [ { "description": "The total number of overtime hours worked during the pay period.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "paid_hours": { "anyOf": [ { "description": "The paid hours for the pay period.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "premiums": { "anyOf": [ { "description": "The premiums for the pay period.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "regular_hours": { "anyOf": [ { "description": "The total number of regular hours worked during the pay period.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "total_holiday_hours": { "anyOf": [ { "description": "The total holiday hours for the pay period.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "total_hours": { "anyOf": [ { "description": "The total hours for the pay period.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "total_paid_time_off_hours": { "anyOf": [ { "description": "The total paid time off hours for the pay period.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "total_unpaid_time_off_hours": { "anyOf": [ { "description": "The total unpaid time off hours for the pay period.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "unpaid_break_hours_by_entry": { "anyOf": [ { "description": "The map of time entry to unpaidBreakHours in seconds", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "TimeCardSummary", "type": "object" }, "updated_at": { "description": "Record update date", "type": "string" }, "worker": { "description": "The worker associated with the time card.\n\nExpandable field", "properties": { "business_partners": { "description": "Worker's assigned business partners. This field is only populated when explicitly requested via the expand parameter (e.g., ?expand=business_partners). When expanded, returns an empty list ([]) if the worker has no business partners.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiBusinessPartner77b00a069c32" }, "type": "array" }, "business_partners_id": { "description": "Worker's assigned business partners unique identifiers. Returns an empty list ([]) if the worker has no business partners.", "items": { "type": "string" }, "type": "array" }, "citizenship": { "description": "The countries that the worker has citizenship in.", "type": "string" }, "compensation": { "description": "The compensation package for the worker.\n\nExpandable field", "properties": { "annual_compensation": { "description": "The worker's annual compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "annual_salary_equivalent": { "description": "The worker's annual salary equivalent, for insurance purposes. It will be equal to the worker's annual compensation, except for owners that are receiving no cashcompensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "bonus_schedule": { "description": "The worker's bonus schedule.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "hourly_wage": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "id": { "description": "Identifier field", "type": "string" }, "monthly_compensation": { "description": "The worker's monthly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "on_target_commission": { "description": "The worker's on-target commission.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "payment_terms": { "description": "The payment terms for an worker's compensation.", "type": "string" }, "payment_type": { "description": "The payment type for an worker's compensation.", "type": "string" }, "relocation_reimbursement": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "salary_effective_date": { "description": "Salary effective date", "type": "string" }, "signing_bonus": { "description": "The worker's signing bonus.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus": { "description": "The worker's target annual bonus amount.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus_percent": { "anyOf": [ { "description": "The worker's target annual bonus as a percent of annual compensation.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" }, "weekly_compensation": { "description": "The worker's weekly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "worker": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's details.\n\nExpandable field", "type": "object" }, "worker_id": { "description": "The worker's ID.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Compensation", "type": "object" }, "compensation_grade": { "description": "The compensation grade assigned to the worker, if any.", "properties": { "id": { "description": "The compensation grade's unique identifier.", "type": "string" }, "label": { "description": "The compensation grade's label.", "type": "string" } }, "title": "WorkerCompensationGrade", "type": "object" }, "compensation_id": { "description": "The compensation package for the worker.", "type": "string" }, "country": { "description": "The worker's country.", "type": "string" }, "country_fields": { "description": "Country level fields for the worker.", "properties": { "ca": { "description": "Country-wise regional fields for Canada", "properties": { "sin": { "description": "Social Insurance Number (SIN) for Canada employees.", "type": "string" } }, "title": "CanadaFields", "type": "object" }, "nz": { "description": "Country-wise regional fields for New Zealand", "properties": { "ird_number": { "description": "Inland Revenue Department (IRD) number for New Zealand employees.", "type": "string" } }, "title": "NewZealandFields", "type": "object" }, "us": { "description": "Country-wise regional fields for USA", "properties": { "ssn": { "description": "Social Security Number (SSN) for US employees.", "type": "string" } }, "title": "USFields", "type": "object" } }, "title": "CountryFields", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "custom_fields": { "description": "Custom field values defined on the Employee object for this worker\n\nExpandable field", "items": { "additionalProperties": {} }, "type": "array" }, "date_of_birth": { "description": "The worker's date of birth.", "type": "string" }, "department": { "description": "The worker's assigned department.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "department_hierarchy": { "description": "List of departments in the department hierarchy. Refer department_hierarchy_ids for department hierarchy order.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestDepartment" }, "type": "array" }, "department_hierarchy_id": { "description": "The identifier of departments in the department hierarchy ordered from parent department to child department.", "items": { "type": "string" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the department.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestDepartment", "description": "The parent department.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent department.", "type": "string" }, "reference_code": { "description": "Reference code of the department.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Department", "type": "object" }, "department_id": { "description": "The worker's assigned department.", "type": "string" }, "employment_type": { "description": "The worker's employment type.\n\nExpandable field", "properties": { "amount_worked": { "description": "The amount worked for the employment type. * `FULL-TIME`: Full-time is at least 30 hours per week. Full-time workers will typically be eligible for benefits. * `PART-TIME`: Part-time is less than 30 hours per week. These workers may be eligible for benefits, depending on company settings and hours worked. * `TEMPORARY`: These workers are hired on a temporary basis. You can specify how each worker with this employment type will be paid individually.", "type": "string" }, "compensation_time_period": { "description": "The compensation period for the employment type. * `SALARIED`: Employees that are paid a fixed amount per year. * `HOURLY`: Employees that are paid a wage per hour worked.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "label": { "description": "The display label of the employment type.", "type": "string" }, "name": { "description": "The name of the employment type for non-custom employment types.", "type": "string" }, "type": { "description": "The classification of the worker by the company. * `CONTRACTOR`: Contractors are self-employed workers who provide services on a short-term or per-project basis and are not eligible for tax-withholding or benefits. * `EMPLOYEE`: Employees are hired and managed by an employer, work under the employer's direct supervision and control, and are protected by law for wages and employment rights.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "label", "updated_at" ], "title": "CompanyEmploymentType", "type": "object" }, "employment_type_id": { "description": "The worker's employment type.", "type": "string" }, "end_date": { "description": "The end date of the worker.", "type": "string" }, "ethnicity": { "description": "The identified ethnicity of the worker, if specified.", "type": "string" }, "gender": { "description": "The gender of the worker, if specified.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_manager": { "description": "Whether the worker is a manager", "type": "boolean" }, "job_function": { "description": "The worker's job function. When expanded, this field requires `job-functions.read`.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "Displayed name of the job function", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "JobFunction", "type": "object" }, "job_function_id": { "description": "ID of the worker's job function.", "type": "string" }, "legal_entity": { "description": "The worker's associated legal entity.\n\nExpandable field", "properties": { "company": { "description": "The company or organization associated with the legal entity\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "doing_business_as_name": { "description": "The doing business as name for the company.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_entities": { "description": "A list of the company's entities.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestLegalEntity" }, "type": "array" }, "legal_entities_id": { "description": "A list of the company's entities.", "items": { "type": "string" }, "type": "array" }, "legal_name": { "description": "The legal name of the company.", "type": "string" }, "name": { "description": "The name of the company.", "type": "string" }, "parent_legal_entity": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The company's ultimate holding entity.\n\nExpandable field", "type": "object" }, "parent_legal_entity_id": { "description": "The company's ultimate holding entity.", "type": "string" }, "phone": { "description": "The phone number for the company.", "type": "string" }, "physical_address": { "description": "The physical address of the holding entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "primary_email": { "description": "The email address used when registering this company.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "legal_entities", "legal_entities_id", "name", "updated_at" ], "title": "Company", "type": "object" }, "company_id": { "description": "The company or organization associated with the legal entity", "type": "string" }, "country": { "description": "The country the legal entity is based in.", "properties": { "code": { "description": "The code of the country.", "type": "string" } }, "required": [ "code" ], "title": "Country", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "entity_level": { "description": "The legal entity's level in a hierarchy. * `PARENT`: The legal entity is considered the ultimate holding entity. * `SUBSIDIARY`: The legal entity is considered a subsidiary, fully or partially held by another. * `BRANCH`: The legal entity is considered a branch, associated with a parent legal entity.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_name": { "description": "The legal name of the legal entity.", "type": "string" }, "mailing_address": { "description": "The mailing address of the legal entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "management_type": { "description": "The legal entity management type in the case of an employer of record (EOR) or professional employment organization (PEO). * `PEO`: The legal entity is considered a Professional Employment Organization (PEO). * `EOR`: The legal entity is considered an Employer of Record (EOR).", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The parent legal entity.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent legal entity.", "type": "string" }, "physical_address": { "description": "The physical address of the legal entity, if it differs from the mailing address.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "registration_date": { "description": "The registration date of the entity.", "type": "string" }, "tax_identifier": { "description": "The tax identifier for the legal entity.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "LegalEntity", "type": "object" }, "legal_entity_id": { "description": "The worker's associated legal entity.", "type": "string" }, "level": { "description": "The level of the worker.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "description": { "description": "The description of the level.", "type": "string" }, "experience_requirements": { "description": "The experience requirements for the level.", "type": "string" }, "global_level": { "anyOf": [ { "description": "Global level is used to track the seniority of levels. The higher up a level is placed on the page, the more senior and higher-ranked the level. Global level is used in workflows, policies, and reports that use the level attribute (e.g., you can use Level Lookup to set up a workflow that notifies the nearest person in an worker's management chain at or above the specified level).", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the level. Must be unique within the company or organization.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLevel", "description": "The parent level.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent level.", "type": "string" }, "rank": { "anyOf": [ { "description": "The rank of the level within its track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "scope_of_responsibilities": { "description": "The scope of responsibilities for the level.", "type": "string" }, "track": { "description": "The track associated with the level, if it's not a global level.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_default": { "description": "Whether this is the company's default track.", "type": "boolean" }, "name": { "description": "The name of the track. Must be unique within the company or organization.", "type": "string" }, "order": { "anyOf": [ { "description": "The one-based horizontal display order of the track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "start_global_level": { "anyOf": [ { "description": "The highest global level occupied by this track. Empty tracks return null.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Track", "type": "object" }, "track_id": { "description": "The track associated with the level. Required during creation. Include global_level when changing it.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Level", "type": "object" }, "level_id": { "description": "The level of the worker.", "type": "string" }, "location": { "description": "The location that the worker is mapped to for tax purposes. In the case that a worker is remote, the location's type is remote.", "properties": { "type": { "description": "The type of location.", "type": "string" }, "work_location_id": { "description": "The work location, if the worker isn't remote.", "type": "string" } }, "required": [ "type", "work_location_id" ], "title": "WorkerLocation", "type": "object" }, "manager": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's manager.\n\nExpandable field", "type": "object" }, "manager_id": { "description": "The worker's manager.", "type": "string" }, "number": { "anyOf": [ { "description": "The worker's number within the organization.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "original_start_date": { "description": "The worker's earliest start date across their employment history, excluding INIT roles.", "type": "string" }, "overtime_exemption": { "description": "The worker's overtime exemption status.", "type": "string" }, "pay_schedule_id": { "description": "The ID of the pay schedule currently associated with the worker.", "type": "string" }, "personal_email": { "description": "The worker's associated personal email address.", "type": "string" }, "race": { "description": "The identified race of the worker, if specified.", "type": "string" }, "start_date": { "description": "The start date of the worker.", "type": "string" }, "status": { "description": "The worker's status within the organization.", "type": "string" }, "teams": { "description": "The worker's assigned teams.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiTeamcb26bc28f32f" }, "type": "array" }, "teams_id": { "description": "The worker's assigned teams.", "items": { "type": "string" }, "type": "array" }, "termination_details": { "description": "The details of the worker's termination, if applicable.", "properties": { "reason": { "description": "This is a description that will be custom to each Rippling company.", "type": "string" }, "type": { "description": "The termination type indicates whether the termination was voluntary or involuntary.", "type": "string" } }, "title": "TerminationDetails", "type": "object" }, "title": { "description": "The worker's title.", "type": "string" }, "title_effective_date": { "description": "Title effective date", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "user": { "description": "The worker's associated user.\n\nExpandable field", "properties": { "active": { "description": "Whether the user is able to access company resources, typically when they are in actively engaged with the company and not after off-boarding.", "type": "boolean" }, "addresses": { "description": "The user's addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiUserAddressedd59b9ba9a1" }, "type": "array" }, "created_at": { "description": "Record creation date", "type": "string" }, "display_name": { "description": "The display name of the user using either the concatenated preferred given and family name or username depending on availability.", "type": "string" }, "emails": { "description": "The user's email addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiEmail5284c8258dc3" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "locale": { "description": "The User's default location for purposes of localization of currency, date time format, or numerical representations pursuant to RFC5646.", "type": "string" }, "name": { "description": "The user's name.", "properties": { "family_name": { "description": "The legal family name of the user, or last name in most Western languages.", "type": "string" }, "formatted": { "description": "The user's full name.", "type": "string" }, "given_name": { "description": "The given legal name of the user, or first name in most Western languages.", "type": "string" }, "middle_name": { "description": "The middle name(s) of the user.", "type": "string" }, "preferred_family_name": { "description": "The preferred family name, or last name in most Western languages, by the user.", "type": "string" }, "preferred_given_name": { "description": "The preferred given name, or first name in most Western languages, by the user.", "type": "string" } }, "title": "UserName", "type": "object" }, "number": { "description": "The permanent profile number of the user.", "type": "string" }, "phone_numbers": { "description": "The user's phone numbers.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoneNumber12060c61ecf5" }, "type": "array" }, "photos": { "description": "The user's photos.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoto2be7c3ae3f39" }, "type": "array" }, "preferred_language": { "description": "The User's preferred written or spoken language in the same format of the HTTP Accept-Language header, pursuant to Section 5.3.5 of RFC7231.", "type": "string" }, "timezone": { "description": "The User's current time zone in IANA database Olson format", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "username": { "description": "The unique identifier across Rippling used by the User for direct authentication into their associated company. Globally unique.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "User", "type": "object" }, "user_id": { "description": "The worker's associated user.", "type": "string" }, "work_email": { "description": "The worker's associated work email address.", "type": "string" }, "work_schedule": { "additionalProperties": { "$ref": "#/components/schemas/OutputRestApiWorkScheduleDay938f88d94f20" }, "description": "The worker's scheduled working hours for each day of the week.", "type": "object" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Worker", "type": "object" }, "worker_id": { "description": "The ID of the worker associated with the time card.", "type": "string" } }, "required": [ "created_at", "id", "updated_at", "worker_id" ], "title": "TimeCard", "type": "object" }, "time_card_id": { "description": "The ID of the time card associated with the time entry.", "type": "string" }, "time_entry_summary": { "description": "A summary of the time entry.", "properties": { "double_over_time_hours": { "anyOf": [ { "description": "The number of double overtime hours worked during this time entry.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "duration": { "anyOf": [ { "description": "The duration of the time entry.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "over_time_hours": { "anyOf": [ { "description": "The number of overtime hours worked during this time entry.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "regular_hours": { "anyOf": [ { "description": "The number of regular hours worked during this time entry.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "TimeEntrySummary", "type": "object" }, "updated_at": { "description": "Record update date", "type": "string" }, "worker": { "description": "The worker associated with the time entry.\n\nExpandable field", "properties": { "business_partners": { "description": "Worker's assigned business partners. This field is only populated when explicitly requested via the expand parameter (e.g., ?expand=business_partners). When expanded, returns an empty list ([]) if the worker has no business partners.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiBusinessPartner77b00a069c32" }, "type": "array" }, "business_partners_id": { "description": "Worker's assigned business partners unique identifiers. Returns an empty list ([]) if the worker has no business partners.", "items": { "type": "string" }, "type": "array" }, "citizenship": { "description": "The countries that the worker has citizenship in.", "type": "string" }, "compensation": { "description": "The compensation package for the worker.\n\nExpandable field", "properties": { "annual_compensation": { "description": "The worker's annual compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "annual_salary_equivalent": { "description": "The worker's annual salary equivalent, for insurance purposes. It will be equal to the worker's annual compensation, except for owners that are receiving no cashcompensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "bonus_schedule": { "description": "The worker's bonus schedule.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "hourly_wage": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "id": { "description": "Identifier field", "type": "string" }, "monthly_compensation": { "description": "The worker's monthly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "on_target_commission": { "description": "The worker's on-target commission.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "payment_terms": { "description": "The payment terms for an worker's compensation.", "type": "string" }, "payment_type": { "description": "The payment type for an worker's compensation.", "type": "string" }, "relocation_reimbursement": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "salary_effective_date": { "description": "Salary effective date", "type": "string" }, "signing_bonus": { "description": "The worker's signing bonus.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus": { "description": "The worker's target annual bonus amount.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus_percent": { "anyOf": [ { "description": "The worker's target annual bonus as a percent of annual compensation.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" }, "weekly_compensation": { "description": "The worker's weekly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "worker": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's details.\n\nExpandable field", "type": "object" }, "worker_id": { "description": "The worker's ID.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Compensation", "type": "object" }, "compensation_grade": { "description": "The compensation grade assigned to the worker, if any.", "properties": { "id": { "description": "The compensation grade's unique identifier.", "type": "string" }, "label": { "description": "The compensation grade's label.", "type": "string" } }, "title": "WorkerCompensationGrade", "type": "object" }, "compensation_id": { "description": "The compensation package for the worker.", "type": "string" }, "country": { "description": "The worker's country.", "type": "string" }, "country_fields": { "description": "Country level fields for the worker.", "properties": { "ca": { "description": "Country-wise regional fields for Canada", "properties": { "sin": { "description": "Social Insurance Number (SIN) for Canada employees.", "type": "string" } }, "title": "CanadaFields", "type": "object" }, "nz": { "description": "Country-wise regional fields for New Zealand", "properties": { "ird_number": { "description": "Inland Revenue Department (IRD) number for New Zealand employees.", "type": "string" } }, "title": "NewZealandFields", "type": "object" }, "us": { "description": "Country-wise regional fields for USA", "properties": { "ssn": { "description": "Social Security Number (SSN) for US employees.", "type": "string" } }, "title": "USFields", "type": "object" } }, "title": "CountryFields", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "custom_fields": { "description": "Custom field values defined on the Employee object for this worker\n\nExpandable field", "items": { "additionalProperties": {} }, "type": "array" }, "date_of_birth": { "description": "The worker's date of birth.", "type": "string" }, "department": { "description": "The worker's assigned department.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "department_hierarchy": { "description": "List of departments in the department hierarchy. Refer department_hierarchy_ids for department hierarchy order.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestDepartment" }, "type": "array" }, "department_hierarchy_id": { "description": "The identifier of departments in the department hierarchy ordered from parent department to child department.", "items": { "type": "string" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the department.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestDepartment", "description": "The parent department.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent department.", "type": "string" }, "reference_code": { "description": "Reference code of the department.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Department", "type": "object" }, "department_id": { "description": "The worker's assigned department.", "type": "string" }, "employment_type": { "description": "The worker's employment type.\n\nExpandable field", "properties": { "amount_worked": { "description": "The amount worked for the employment type. * `FULL-TIME`: Full-time is at least 30 hours per week. Full-time workers will typically be eligible for benefits. * `PART-TIME`: Part-time is less than 30 hours per week. These workers may be eligible for benefits, depending on company settings and hours worked. * `TEMPORARY`: These workers are hired on a temporary basis. You can specify how each worker with this employment type will be paid individually.", "type": "string" }, "compensation_time_period": { "description": "The compensation period for the employment type. * `SALARIED`: Employees that are paid a fixed amount per year. * `HOURLY`: Employees that are paid a wage per hour worked.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "label": { "description": "The display label of the employment type.", "type": "string" }, "name": { "description": "The name of the employment type for non-custom employment types.", "type": "string" }, "type": { "description": "The classification of the worker by the company. * `CONTRACTOR`: Contractors are self-employed workers who provide services on a short-term or per-project basis and are not eligible for tax-withholding or benefits. * `EMPLOYEE`: Employees are hired and managed by an employer, work under the employer's direct supervision and control, and are protected by law for wages and employment rights.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "label", "updated_at" ], "title": "CompanyEmploymentType", "type": "object" }, "employment_type_id": { "description": "The worker's employment type.", "type": "string" }, "end_date": { "description": "The end date of the worker.", "type": "string" }, "ethnicity": { "description": "The identified ethnicity of the worker, if specified.", "type": "string" }, "gender": { "description": "The gender of the worker, if specified.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_manager": { "description": "Whether the worker is a manager", "type": "boolean" }, "job_function": { "description": "The worker's job function. When expanded, this field requires `job-functions.read`.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "Displayed name of the job function", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "JobFunction", "type": "object" }, "job_function_id": { "description": "ID of the worker's job function.", "type": "string" }, "legal_entity": { "description": "The worker's associated legal entity.\n\nExpandable field", "properties": { "company": { "description": "The company or organization associated with the legal entity\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "doing_business_as_name": { "description": "The doing business as name for the company.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_entities": { "description": "A list of the company's entities.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestLegalEntity" }, "type": "array" }, "legal_entities_id": { "description": "A list of the company's entities.", "items": { "type": "string" }, "type": "array" }, "legal_name": { "description": "The legal name of the company.", "type": "string" }, "name": { "description": "The name of the company.", "type": "string" }, "parent_legal_entity": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The company's ultimate holding entity.\n\nExpandable field", "type": "object" }, "parent_legal_entity_id": { "description": "The company's ultimate holding entity.", "type": "string" }, "phone": { "description": "The phone number for the company.", "type": "string" }, "physical_address": { "description": "The physical address of the holding entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "primary_email": { "description": "The email address used when registering this company.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "legal_entities", "legal_entities_id", "name", "updated_at" ], "title": "Company", "type": "object" }, "company_id": { "description": "The company or organization associated with the legal entity", "type": "string" }, "country": { "description": "The country the legal entity is based in.", "properties": { "code": { "description": "The code of the country.", "type": "string" } }, "required": [ "code" ], "title": "Country", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "entity_level": { "description": "The legal entity's level in a hierarchy. * `PARENT`: The legal entity is considered the ultimate holding entity. * `SUBSIDIARY`: The legal entity is considered a subsidiary, fully or partially held by another. * `BRANCH`: The legal entity is considered a branch, associated with a parent legal entity.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_name": { "description": "The legal name of the legal entity.", "type": "string" }, "mailing_address": { "description": "The mailing address of the legal entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "management_type": { "description": "The legal entity management type in the case of an employer of record (EOR) or professional employment organization (PEO). * `PEO`: The legal entity is considered a Professional Employment Organization (PEO). * `EOR`: The legal entity is considered an Employer of Record (EOR).", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The parent legal entity.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent legal entity.", "type": "string" }, "physical_address": { "description": "The physical address of the legal entity, if it differs from the mailing address.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "registration_date": { "description": "The registration date of the entity.", "type": "string" }, "tax_identifier": { "description": "The tax identifier for the legal entity.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "LegalEntity", "type": "object" }, "legal_entity_id": { "description": "The worker's associated legal entity.", "type": "string" }, "level": { "description": "The level of the worker.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "description": { "description": "The description of the level.", "type": "string" }, "experience_requirements": { "description": "The experience requirements for the level.", "type": "string" }, "global_level": { "anyOf": [ { "description": "Global level is used to track the seniority of levels. The higher up a level is placed on the page, the more senior and higher-ranked the level. Global level is used in workflows, policies, and reports that use the level attribute (e.g., you can use Level Lookup to set up a workflow that notifies the nearest person in an worker's management chain at or above the specified level).", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the level. Must be unique within the company or organization.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLevel", "description": "The parent level.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent level.", "type": "string" }, "rank": { "anyOf": [ { "description": "The rank of the level within its track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "scope_of_responsibilities": { "description": "The scope of responsibilities for the level.", "type": "string" }, "track": { "description": "The track associated with the level, if it's not a global level.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_default": { "description": "Whether this is the company's default track.", "type": "boolean" }, "name": { "description": "The name of the track. Must be unique within the company or organization.", "type": "string" }, "order": { "anyOf": [ { "description": "The one-based horizontal display order of the track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "start_global_level": { "anyOf": [ { "description": "The highest global level occupied by this track. Empty tracks return null.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Track", "type": "object" }, "track_id": { "description": "The track associated with the level. Required during creation. Include global_level when changing it.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Level", "type": "object" }, "level_id": { "description": "The level of the worker.", "type": "string" }, "location": { "description": "The location that the worker is mapped to for tax purposes. In the case that a worker is remote, the location's type is remote.", "properties": { "type": { "description": "The type of location.", "type": "string" }, "work_location_id": { "description": "The work location, if the worker isn't remote.", "type": "string" } }, "required": [ "type", "work_location_id" ], "title": "WorkerLocation", "type": "object" }, "manager": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's manager.\n\nExpandable field", "type": "object" }, "manager_id": { "description": "The worker's manager.", "type": "string" }, "number": { "anyOf": [ { "description": "The worker's number within the organization.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "original_start_date": { "description": "The worker's earliest start date across their employment history, excluding INIT roles.", "type": "string" }, "overtime_exemption": { "description": "The worker's overtime exemption status.", "type": "string" }, "pay_schedule_id": { "description": "The ID of the pay schedule currently associated with the worker.", "type": "string" }, "personal_email": { "description": "The worker's associated personal email address.", "type": "string" }, "race": { "description": "The identified race of the worker, if specified.", "type": "string" }, "start_date": { "description": "The start date of the worker.", "type": "string" }, "status": { "description": "The worker's status within the organization.", "type": "string" }, "teams": { "description": "The worker's assigned teams.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiTeamcb26bc28f32f" }, "type": "array" }, "teams_id": { "description": "The worker's assigned teams.", "items": { "type": "string" }, "type": "array" }, "termination_details": { "description": "The details of the worker's termination, if applicable.", "properties": { "reason": { "description": "This is a description that will be custom to each Rippling company.", "type": "string" }, "type": { "description": "The termination type indicates whether the termination was voluntary or involuntary.", "type": "string" } }, "title": "TerminationDetails", "type": "object" }, "title": { "description": "The worker's title.", "type": "string" }, "title_effective_date": { "description": "Title effective date", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "user": { "description": "The worker's associated user.\n\nExpandable field", "properties": { "active": { "description": "Whether the user is able to access company resources, typically when they are in actively engaged with the company and not after off-boarding.", "type": "boolean" }, "addresses": { "description": "The user's addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiUserAddressedd59b9ba9a1" }, "type": "array" }, "created_at": { "description": "Record creation date", "type": "string" }, "display_name": { "description": "The display name of the user using either the concatenated preferred given and family name or username depending on availability.", "type": "string" }, "emails": { "description": "The user's email addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiEmail5284c8258dc3" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "locale": { "description": "The User's default location for purposes of localization of currency, date time format, or numerical representations pursuant to RFC5646.", "type": "string" }, "name": { "description": "The user's name.", "properties": { "family_name": { "description": "The legal family name of the user, or last name in most Western languages.", "type": "string" }, "formatted": { "description": "The user's full name.", "type": "string" }, "given_name": { "description": "The given legal name of the user, or first name in most Western languages.", "type": "string" }, "middle_name": { "description": "The middle name(s) of the user.", "type": "string" }, "preferred_family_name": { "description": "The preferred family name, or last name in most Western languages, by the user.", "type": "string" }, "preferred_given_name": { "description": "The preferred given name, or first name in most Western languages, by the user.", "type": "string" } }, "title": "UserName", "type": "object" }, "number": { "description": "The permanent profile number of the user.", "type": "string" }, "phone_numbers": { "description": "The user's phone numbers.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoneNumber12060c61ecf5" }, "type": "array" }, "photos": { "description": "The user's photos.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoto2be7c3ae3f39" }, "type": "array" }, "preferred_language": { "description": "The User's preferred written or spoken language in the same format of the HTTP Accept-Language header, pursuant to Section 5.3.5 of RFC7231.", "type": "string" }, "timezone": { "description": "The User's current time zone in IANA database Olson format", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "username": { "description": "The unique identifier across Rippling used by the User for direct authentication into their associated company. Globally unique.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "User", "type": "object" }, "user_id": { "description": "The worker's associated user.", "type": "string" }, "work_email": { "description": "The worker's associated work email address.", "type": "string" }, "work_schedule": { "additionalProperties": { "$ref": "#/components/schemas/OutputRestApiWorkScheduleDay938f88d94f20" }, "description": "The worker's scheduled working hours for each day of the week.", "type": "object" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Worker", "type": "object" }, "worker_id": { "description": "The ID of the worker associated with the time entry.", "type": "string" } }, "required": [ "created_at", "id", "updated_at", "worker_id" ], "title": "TimeEntry", "type": "object" }, "OutputRestApiTimeKioskBadgeaf0bfaa20b9b": { "description": "", "properties": { "badge_id": { "description": "The ID associated with the badge. Not to be confused with the record's ID.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_enabled": { "description": "Whether this badge can be used with the Kiosk app.", "type": "boolean" }, "updated_at": { "description": "Record update date", "type": "string" }, "worker": { "description": "The worker associated with the badge.\n\nExpandable field", "properties": { "business_partners": { "description": "Worker's assigned business partners. This field is only populated when explicitly requested via the expand parameter (e.g., ?expand=business_partners). When expanded, returns an empty list ([]) if the worker has no business partners.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiBusinessPartner77b00a069c32" }, "type": "array" }, "business_partners_id": { "description": "Worker's assigned business partners unique identifiers. Returns an empty list ([]) if the worker has no business partners.", "items": { "type": "string" }, "type": "array" }, "citizenship": { "description": "The countries that the worker has citizenship in.", "type": "string" }, "compensation": { "description": "The compensation package for the worker.\n\nExpandable field", "properties": { "annual_compensation": { "description": "The worker's annual compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "annual_salary_equivalent": { "description": "The worker's annual salary equivalent, for insurance purposes. It will be equal to the worker's annual compensation, except for owners that are receiving no cashcompensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "bonus_schedule": { "description": "The worker's bonus schedule.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "hourly_wage": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "id": { "description": "Identifier field", "type": "string" }, "monthly_compensation": { "description": "The worker's monthly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "on_target_commission": { "description": "The worker's on-target commission.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "payment_terms": { "description": "The payment terms for an worker's compensation.", "type": "string" }, "payment_type": { "description": "The payment type for an worker's compensation.", "type": "string" }, "relocation_reimbursement": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "salary_effective_date": { "description": "Salary effective date", "type": "string" }, "signing_bonus": { "description": "The worker's signing bonus.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus": { "description": "The worker's target annual bonus amount.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus_percent": { "anyOf": [ { "description": "The worker's target annual bonus as a percent of annual compensation.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" }, "weekly_compensation": { "description": "The worker's weekly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "worker": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's details.\n\nExpandable field", "type": "object" }, "worker_id": { "description": "The worker's ID.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Compensation", "type": "object" }, "compensation_grade": { "description": "The compensation grade assigned to the worker, if any.", "properties": { "id": { "description": "The compensation grade's unique identifier.", "type": "string" }, "label": { "description": "The compensation grade's label.", "type": "string" } }, "title": "WorkerCompensationGrade", "type": "object" }, "compensation_id": { "description": "The compensation package for the worker.", "type": "string" }, "country": { "description": "The worker's country.", "type": "string" }, "country_fields": { "description": "Country level fields for the worker.", "properties": { "ca": { "description": "Country-wise regional fields for Canada", "properties": { "sin": { "description": "Social Insurance Number (SIN) for Canada employees.", "type": "string" } }, "title": "CanadaFields", "type": "object" }, "nz": { "description": "Country-wise regional fields for New Zealand", "properties": { "ird_number": { "description": "Inland Revenue Department (IRD) number for New Zealand employees.", "type": "string" } }, "title": "NewZealandFields", "type": "object" }, "us": { "description": "Country-wise regional fields for USA", "properties": { "ssn": { "description": "Social Security Number (SSN) for US employees.", "type": "string" } }, "title": "USFields", "type": "object" } }, "title": "CountryFields", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "custom_fields": { "description": "Custom field values defined on the Employee object for this worker\n\nExpandable field", "items": { "additionalProperties": {} }, "type": "array" }, "date_of_birth": { "description": "The worker's date of birth.", "type": "string" }, "department": { "description": "The worker's assigned department.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "department_hierarchy": { "description": "List of departments in the department hierarchy. Refer department_hierarchy_ids for department hierarchy order.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestDepartment" }, "type": "array" }, "department_hierarchy_id": { "description": "The identifier of departments in the department hierarchy ordered from parent department to child department.", "items": { "type": "string" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the department.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestDepartment", "description": "The parent department.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent department.", "type": "string" }, "reference_code": { "description": "Reference code of the department.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Department", "type": "object" }, "department_id": { "description": "The worker's assigned department.", "type": "string" }, "employment_type": { "description": "The worker's employment type.\n\nExpandable field", "properties": { "amount_worked": { "description": "The amount worked for the employment type. * `FULL-TIME`: Full-time is at least 30 hours per week. Full-time workers will typically be eligible for benefits. * `PART-TIME`: Part-time is less than 30 hours per week. These workers may be eligible for benefits, depending on company settings and hours worked. * `TEMPORARY`: These workers are hired on a temporary basis. You can specify how each worker with this employment type will be paid individually.", "type": "string" }, "compensation_time_period": { "description": "The compensation period for the employment type. * `SALARIED`: Employees that are paid a fixed amount per year. * `HOURLY`: Employees that are paid a wage per hour worked.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "label": { "description": "The display label of the employment type.", "type": "string" }, "name": { "description": "The name of the employment type for non-custom employment types.", "type": "string" }, "type": { "description": "The classification of the worker by the company. * `CONTRACTOR`: Contractors are self-employed workers who provide services on a short-term or per-project basis and are not eligible for tax-withholding or benefits. * `EMPLOYEE`: Employees are hired and managed by an employer, work under the employer's direct supervision and control, and are protected by law for wages and employment rights.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "label", "updated_at" ], "title": "CompanyEmploymentType", "type": "object" }, "employment_type_id": { "description": "The worker's employment type.", "type": "string" }, "end_date": { "description": "The end date of the worker.", "type": "string" }, "ethnicity": { "description": "The identified ethnicity of the worker, if specified.", "type": "string" }, "gender": { "description": "The gender of the worker, if specified.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_manager": { "description": "Whether the worker is a manager", "type": "boolean" }, "job_function": { "description": "The worker's job function. When expanded, this field requires `job-functions.read`.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "Displayed name of the job function", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "JobFunction", "type": "object" }, "job_function_id": { "description": "ID of the worker's job function.", "type": "string" }, "legal_entity": { "description": "The worker's associated legal entity.\n\nExpandable field", "properties": { "company": { "description": "The company or organization associated with the legal entity\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "doing_business_as_name": { "description": "The doing business as name for the company.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_entities": { "description": "A list of the company's entities.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestLegalEntity" }, "type": "array" }, "legal_entities_id": { "description": "A list of the company's entities.", "items": { "type": "string" }, "type": "array" }, "legal_name": { "description": "The legal name of the company.", "type": "string" }, "name": { "description": "The name of the company.", "type": "string" }, "parent_legal_entity": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The company's ultimate holding entity.\n\nExpandable field", "type": "object" }, "parent_legal_entity_id": { "description": "The company's ultimate holding entity.", "type": "string" }, "phone": { "description": "The phone number for the company.", "type": "string" }, "physical_address": { "description": "The physical address of the holding entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "primary_email": { "description": "The email address used when registering this company.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "legal_entities", "legal_entities_id", "name", "updated_at" ], "title": "Company", "type": "object" }, "company_id": { "description": "The company or organization associated with the legal entity", "type": "string" }, "country": { "description": "The country the legal entity is based in.", "properties": { "code": { "description": "The code of the country.", "type": "string" } }, "required": [ "code" ], "title": "Country", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "entity_level": { "description": "The legal entity's level in a hierarchy. * `PARENT`: The legal entity is considered the ultimate holding entity. * `SUBSIDIARY`: The legal entity is considered a subsidiary, fully or partially held by another. * `BRANCH`: The legal entity is considered a branch, associated with a parent legal entity.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_name": { "description": "The legal name of the legal entity.", "type": "string" }, "mailing_address": { "description": "The mailing address of the legal entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "management_type": { "description": "The legal entity management type in the case of an employer of record (EOR) or professional employment organization (PEO). * `PEO`: The legal entity is considered a Professional Employment Organization (PEO). * `EOR`: The legal entity is considered an Employer of Record (EOR).", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The parent legal entity.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent legal entity.", "type": "string" }, "physical_address": { "description": "The physical address of the legal entity, if it differs from the mailing address.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "registration_date": { "description": "The registration date of the entity.", "type": "string" }, "tax_identifier": { "description": "The tax identifier for the legal entity.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "LegalEntity", "type": "object" }, "legal_entity_id": { "description": "The worker's associated legal entity.", "type": "string" }, "level": { "description": "The level of the worker.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "description": { "description": "The description of the level.", "type": "string" }, "experience_requirements": { "description": "The experience requirements for the level.", "type": "string" }, "global_level": { "anyOf": [ { "description": "Global level is used to track the seniority of levels. The higher up a level is placed on the page, the more senior and higher-ranked the level. Global level is used in workflows, policies, and reports that use the level attribute (e.g., you can use Level Lookup to set up a workflow that notifies the nearest person in an worker's management chain at or above the specified level).", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the level. Must be unique within the company or organization.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLevel", "description": "The parent level.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent level.", "type": "string" }, "rank": { "anyOf": [ { "description": "The rank of the level within its track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "scope_of_responsibilities": { "description": "The scope of responsibilities for the level.", "type": "string" }, "track": { "description": "The track associated with the level, if it's not a global level.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_default": { "description": "Whether this is the company's default track.", "type": "boolean" }, "name": { "description": "The name of the track. Must be unique within the company or organization.", "type": "string" }, "order": { "anyOf": [ { "description": "The one-based horizontal display order of the track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "start_global_level": { "anyOf": [ { "description": "The highest global level occupied by this track. Empty tracks return null.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Track", "type": "object" }, "track_id": { "description": "The track associated with the level. Required during creation. Include global_level when changing it.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Level", "type": "object" }, "level_id": { "description": "The level of the worker.", "type": "string" }, "location": { "description": "The location that the worker is mapped to for tax purposes. In the case that a worker is remote, the location's type is remote.", "properties": { "type": { "description": "The type of location.", "type": "string" }, "work_location_id": { "description": "The work location, if the worker isn't remote.", "type": "string" } }, "required": [ "type", "work_location_id" ], "title": "WorkerLocation", "type": "object" }, "manager": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's manager.\n\nExpandable field", "type": "object" }, "manager_id": { "description": "The worker's manager.", "type": "string" }, "number": { "anyOf": [ { "description": "The worker's number within the organization.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "original_start_date": { "description": "The worker's earliest start date across their employment history, excluding INIT roles.", "type": "string" }, "overtime_exemption": { "description": "The worker's overtime exemption status.", "type": "string" }, "pay_schedule_id": { "description": "The ID of the pay schedule currently associated with the worker.", "type": "string" }, "personal_email": { "description": "The worker's associated personal email address.", "type": "string" }, "race": { "description": "The identified race of the worker, if specified.", "type": "string" }, "start_date": { "description": "The start date of the worker.", "type": "string" }, "status": { "description": "The worker's status within the organization.", "type": "string" }, "teams": { "description": "The worker's assigned teams.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiTeamcb26bc28f32f" }, "type": "array" }, "teams_id": { "description": "The worker's assigned teams.", "items": { "type": "string" }, "type": "array" }, "termination_details": { "description": "The details of the worker's termination, if applicable.", "properties": { "reason": { "description": "This is a description that will be custom to each Rippling company.", "type": "string" }, "type": { "description": "The termination type indicates whether the termination was voluntary or involuntary.", "type": "string" } }, "title": "TerminationDetails", "type": "object" }, "title": { "description": "The worker's title.", "type": "string" }, "title_effective_date": { "description": "Title effective date", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "user": { "description": "The worker's associated user.\n\nExpandable field", "properties": { "active": { "description": "Whether the user is able to access company resources, typically when they are in actively engaged with the company and not after off-boarding.", "type": "boolean" }, "addresses": { "description": "The user's addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiUserAddressedd59b9ba9a1" }, "type": "array" }, "created_at": { "description": "Record creation date", "type": "string" }, "display_name": { "description": "The display name of the user using either the concatenated preferred given and family name or username depending on availability.", "type": "string" }, "emails": { "description": "The user's email addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiEmail5284c8258dc3" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "locale": { "description": "The User's default location for purposes of localization of currency, date time format, or numerical representations pursuant to RFC5646.", "type": "string" }, "name": { "description": "The user's name.", "properties": { "family_name": { "description": "The legal family name of the user, or last name in most Western languages.", "type": "string" }, "formatted": { "description": "The user's full name.", "type": "string" }, "given_name": { "description": "The given legal name of the user, or first name in most Western languages.", "type": "string" }, "middle_name": { "description": "The middle name(s) of the user.", "type": "string" }, "preferred_family_name": { "description": "The preferred family name, or last name in most Western languages, by the user.", "type": "string" }, "preferred_given_name": { "description": "The preferred given name, or first name in most Western languages, by the user.", "type": "string" } }, "title": "UserName", "type": "object" }, "number": { "description": "The permanent profile number of the user.", "type": "string" }, "phone_numbers": { "description": "The user's phone numbers.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoneNumber12060c61ecf5" }, "type": "array" }, "photos": { "description": "The user's photos.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoto2be7c3ae3f39" }, "type": "array" }, "preferred_language": { "description": "The User's preferred written or spoken language in the same format of the HTTP Accept-Language header, pursuant to Section 5.3.5 of RFC7231.", "type": "string" }, "timezone": { "description": "The User's current time zone in IANA database Olson format", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "username": { "description": "The unique identifier across Rippling used by the User for direct authentication into their associated company. Globally unique.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "User", "type": "object" }, "user_id": { "description": "The worker's associated user.", "type": "string" }, "work_email": { "description": "The worker's associated work email address.", "type": "string" }, "work_schedule": { "additionalProperties": { "$ref": "#/components/schemas/OutputRestApiWorkScheduleDay938f88d94f20" }, "description": "The worker's scheduled working hours for each day of the week.", "type": "object" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Worker", "type": "object" }, "worker_id": { "description": "The ID of the worker associated with the badge.", "type": "string" }, "worker_number": { "anyOf": [ { "description": "The employee number of the worker associated with the badge.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "required": [ "badge_id", "created_at", "id", "updated_at" ], "title": "TimeKioskBadge", "type": "object" }, "OutputRestApiTitled2a56118f5cc": { "description": "", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the title.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Title", "type": "object" }, "OutputRestApiTrack10bd1355aacd": { "description": "", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_default": { "description": "Whether this is the company's default track.", "type": "boolean" }, "name": { "description": "The name of the track. Must be unique within the company or organization.", "type": "string" }, "order": { "anyOf": [ { "description": "The one-based horizontal display order of the track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "start_global_level": { "anyOf": [ { "description": "The highest global level occupied by this track. Empty tracks return null.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Track", "type": "object" }, "OutputRestApiUnassignedShift1e04623002e0": { "description": "", "properties": { "assigned_count": { "anyOf": [ { "description": "The number of assigned shifts", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "assigned_shift_ids": { "description": "The IDs of the assigned shifts that are part of this unassigned shift", "items": { "type": "string" }, "type": "array" }, "created_at": { "description": "Record creation date", "type": "string" }, "custom_fields": { "description": "Custom fields for the unassigned shift", "items": { "additionalProperties": {} }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "is_published": { "description": "Whether the shift is published", "type": "boolean" }, "open_shift_config": { "description": "Configuration for an open shift. If present, this is an open shift (workers can sign up). If absent/None, this is an empty shift (placeholder).", "properties": {}, "title": "OpenShiftConfig", "type": "object" }, "published_version": { "description": "The published version of the shift", "properties": { "end_time": { "description": "The end time of the shift", "type": "string" }, "notes": { "description": "Notes for the shift, max length 256 characters", "maxLength": 256, "type": "string" }, "shift_breaks": { "description": "The breaks of the shift", "items": { "$ref": "#/components/schemas/OutputRestApiShiftBreak314820414f10" }, "type": "array" }, "shift_segments": { "description": "The segments of the shift", "items": { "$ref": "#/components/schemas/OutputRestApiShiftSegment2a530a829033" }, "type": "array" }, "start_time": { "description": "The start time of the shift", "type": "string" } }, "required": [ "end_time", "start_time" ], "title": "ShiftData", "type": "object" }, "schedule": { "description": "The schedule\n\nExpandable field", "properties": { "can_edit": { "description": "Whether the requesting role can edit the schedule.", "type": "boolean" }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "managers": { "description": "The managers of the schedule.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiWorker75ef4092b644" }, "type": "array" }, "managers_id": { "description": "The IDs of the managers of the schedule.", "items": { "type": "string" }, "type": "array" }, "members": { "description": "The members of the schedule.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiWorker75ef4092b644" }, "type": "array" }, "members_id": { "description": "The IDs of the members of the schedule.", "items": { "type": "string" }, "type": "array" }, "name": { "description": "The name of the schedule.", "type": "string" }, "observers": { "description": "The observers of the schedule.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiWorker75ef4092b644" }, "type": "array" }, "observers_id": { "description": "The IDs of the observers of the schedule.", "items": { "type": "string" }, "type": "array" }, "settings": { "description": "The settings of the schedule.", "properties": { "timezone": { "description": "The IANA timezone identifier for the schedule (e.g., 'America/New_York'). Accepted values are defined by the tz database, listed here: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones", "type": "string" } }, "title": "ScheduleSettings", "type": "object" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Schedule", "type": "object" }, "schedule_id": { "description": "The ID of the schedule", "type": "string" }, "shift_data": { "description": "The data of the shift", "properties": { "end_time": { "description": "The end time of the shift", "type": "string" }, "notes": { "description": "Notes for the shift, max length 256 characters", "maxLength": 256, "type": "string" }, "shift_breaks": { "description": "The breaks of the shift", "items": { "$ref": "#/components/schemas/OutputRestApiShiftBreak314820414f10" }, "type": "array" }, "shift_segments": { "description": "The segments of the shift", "items": { "$ref": "#/components/schemas/OutputRestApiShiftSegment2a530a829033" }, "type": "array" }, "start_time": { "description": "The start time of the shift", "type": "string" } }, "required": [ "end_time", "start_time" ], "title": "ShiftData", "type": "object" }, "target_count": { "anyOf": [ { "description": "The target count of the shift", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "is_published", "schedule_id", "shift_data", "target_count", "updated_at" ], "title": "UnassignedShift", "type": "object" }, "OutputRestApiUser48488eefe451": { "description": "", "properties": { "active": { "description": "Whether the user is able to access company resources, typically when they are in actively engaged with the company and not after off-boarding.", "type": "boolean" }, "addresses": { "description": "The user's addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiUserAddressedd59b9ba9a1" }, "type": "array" }, "created_at": { "description": "Record creation date", "type": "string" }, "display_name": { "description": "The display name of the user using either the concatenated preferred given and family name or username depending on availability.", "type": "string" }, "emails": { "description": "The user's email addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiEmail5284c8258dc3" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "locale": { "description": "The User's default location for purposes of localization of currency, date time format, or numerical representations pursuant to RFC5646.", "type": "string" }, "name": { "description": "The user's name.", "properties": { "family_name": { "description": "The legal family name of the user, or last name in most Western languages.", "type": "string" }, "formatted": { "description": "The user's full name.", "type": "string" }, "given_name": { "description": "The given legal name of the user, or first name in most Western languages.", "type": "string" }, "middle_name": { "description": "The middle name(s) of the user.", "type": "string" }, "preferred_family_name": { "description": "The preferred family name, or last name in most Western languages, by the user.", "type": "string" }, "preferred_given_name": { "description": "The preferred given name, or first name in most Western languages, by the user.", "type": "string" } }, "title": "UserName", "type": "object" }, "number": { "description": "The permanent profile number of the user.", "type": "string" }, "phone_numbers": { "description": "The user's phone numbers.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoneNumber12060c61ecf5" }, "type": "array" }, "photos": { "description": "The user's photos.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoto2be7c3ae3f39" }, "type": "array" }, "preferred_language": { "description": "The User's preferred written or spoken language in the same format of the HTTP Accept-Language header, pursuant to Section 5.3.5 of RFC7231.", "type": "string" }, "timezone": { "description": "The User's current time zone in IANA database Olson format", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "username": { "description": "The unique identifier across Rippling used by the User for direct authentication into their associated company. Globally unique.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "User", "type": "object" }, "OutputRestApiUserAddressedd59b9ba9a1": { "description": "", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "UserAddress", "type": "object" }, "OutputRestApiUserPhoneNumber12060c61ecf5": { "description": "", "properties": { "display": { "description": "The display value of the phone number.", "type": "string" }, "type": { "description": "The classification of the phone number, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "value": { "description": "The canonical global phone number pursuant to RFC3966.", "type": "string" } }, "title": "UserPhoneNumber", "type": "object" }, "OutputRestApiUserPhoto2be7c3ae3f39": { "description": "", "properties": { "type": { "description": "The classification of the photo.", "type": "string" }, "value": { "description": "The URL of the photo.", "type": "string" } }, "title": "UserPhoto", "type": "object" }, "OutputRestApiVariableCompensationPayoutLabelac9fd58b0f9b": { "description": "", "properties": { "client": { "description": "Client system that created the label.", "type": "string" }, "external_id": { "description": "External identifier unique per company and client.", "type": "string" }, "id": { "description": "Unique identifier of the payout label.", "type": "string" }, "name": { "description": "Display name of the label.", "type": "string" } }, "required": [ "client", "external_id", "id", "name" ], "title": "VariableCompensationPayoutLabel", "type": "object" }, "OutputRestApiVariableCompensationPayoutTypeMapping70ecab311989": { "description": "", "properties": { "earning_code": { "description": "Mapped earning code for the payroll entity.", "type": "string" }, "earning_display_name": { "description": "Display name of the mapped earning code at response time. Convenience snapshot for the mapping matrix; authoritative earning metadata lives in payroll, not this field.", "type": "string" }, "entity_id": { "description": "ID of the payroll entity this mapping applies to.", "type": "string" }, "entity_name": { "description": "Display name of the payroll entity at response time. Convenience snapshot for the mapping matrix; authoritative entity data lives on payroll entities, not this field.", "type": "string" }, "health": { "description": "Mapping health status.", "type": "string" } }, "required": [ "entity_id", "health" ], "title": "VariableCompensationPayoutTypeMapping", "type": "object" }, "OutputRestApiVariableCompensationPayoutTypee8efc0d38fe3": { "description": "", "properties": { "created_by": { "description": "ID of the worker who created this custom payout type.", "type": "string" }, "display_name": { "description": "Display name of the payout type.", "type": "string" }, "id": { "description": "Unique identifier of the payout type. Same as key.", "type": "string" }, "is_system": { "description": "Whether this is a built-in payout type.", "type": "boolean" }, "key": { "description": "Stable payout type key assigned by the server on create.", "type": "string" }, "mappings": { "description": "Per-entity earning code mappings.", "items": { "$ref": "#/components/schemas/OutputRestApiVariableCompensationPayoutTypeMapping70ecab311989" }, "type": "array" } }, "required": [ "display_name", "id", "is_system", "key" ], "title": "VariableCompensationPayoutType", "type": "object" }, "OutputRestApiVendorResourcef5479c61c57f": { "description": "A vendor in the company's Spend directory.\n\n Stub and archived vendors are included so historical transactions can still resolve their vendor.\n ", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_archived": { "description": "Whether the vendor is archived. Archived vendors remain available for historical references.", "type": "boolean" }, "logo": { "description": "URL of the vendor's logo. Null when no logo is available.", "type": "string" }, "name": { "description": "Canonical name of the Spend vendor. Name eq, ne, and in filters also match alternate names.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "VendorResource", "type": "object" }, "OutputRestApiWeekdayScheduleTriggera236cc90a54c": { "additionalProperties": false, "properties": { "hour": { "anyOf": [ { "maximum": 23, "minimum": 0, "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "kind": { "type": "string" }, "minute": { "anyOf": [ { "default": 0, "maximum": 59, "minimum": 0, "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "timezone": { "type": "string" } }, "required": [ "hour", "kind", "timezone" ], "title": "WeekdayScheduleTrigger", "type": "object" }, "OutputRestApiWeeklyScheduleTrigger9d2e794637bc": { "additionalProperties": false, "properties": { "days_of_week": { "items": { "anyOf": [ { "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "type": "array" }, "hour": { "anyOf": [ { "maximum": 23, "minimum": 0, "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "kind": { "type": "string" }, "minute": { "anyOf": [ { "default": 0, "maximum": 59, "minimum": 0, "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "timezone": { "type": "string" } }, "required": [ "days_of_week", "hour", "kind", "timezone" ], "title": "WeeklyScheduleTrigger", "type": "object" }, "OutputRestApiWorkLocation3725da8ca0f2": { "description": "", "properties": { "address": { "description": "The address for the work location.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the work location.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "address", "created_at", "id", "name", "updated_at" ], "title": "WorkLocation", "type": "object" }, "OutputRestApiWorkScheduleDay938f88d94f20": { "description": "The scheduled working hours for a day of the week.", "properties": { "hours": { "anyOf": [ { "description": "The number of scheduled working hours for the day.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "WorkScheduleDay", "type": "object" }, "OutputRestApiWorker75ef4092b644": { "description": "", "properties": { "business_partners": { "description": "Worker's assigned business partners. This field is only populated when explicitly requested via the expand parameter (e.g., ?expand=business_partners). When expanded, returns an empty list ([]) if the worker has no business partners.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiBusinessPartner77b00a069c32" }, "type": "array" }, "business_partners_id": { "description": "Worker's assigned business partners unique identifiers. Returns an empty list ([]) if the worker has no business partners.", "items": { "type": "string" }, "type": "array" }, "citizenship": { "description": "The countries that the worker has citizenship in.", "type": "string" }, "compensation": { "description": "The compensation package for the worker.\n\nExpandable field", "properties": { "annual_compensation": { "description": "The worker's annual compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "annual_salary_equivalent": { "description": "The worker's annual salary equivalent, for insurance purposes. It will be equal to the worker's annual compensation, except for owners that are receiving no cashcompensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "bonus_schedule": { "description": "The worker's bonus schedule.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "hourly_wage": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "id": { "description": "Identifier field", "type": "string" }, "monthly_compensation": { "description": "The worker's monthly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "on_target_commission": { "description": "The worker's on-target commission.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "payment_terms": { "description": "The payment terms for an worker's compensation.", "type": "string" }, "payment_type": { "description": "The payment type for an worker's compensation.", "type": "string" }, "relocation_reimbursement": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "salary_effective_date": { "description": "Salary effective date", "type": "string" }, "signing_bonus": { "description": "The worker's signing bonus.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus": { "description": "The worker's target annual bonus amount.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus_percent": { "anyOf": [ { "description": "The worker's target annual bonus as a percent of annual compensation.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" }, "weekly_compensation": { "description": "The worker's weekly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "worker": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's details.\n\nExpandable field", "type": "object" }, "worker_id": { "description": "The worker's ID.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Compensation", "type": "object" }, "compensation_grade": { "description": "The compensation grade assigned to the worker, if any.", "properties": { "id": { "description": "The compensation grade's unique identifier.", "type": "string" }, "label": { "description": "The compensation grade's label.", "type": "string" } }, "title": "WorkerCompensationGrade", "type": "object" }, "compensation_id": { "description": "The compensation package for the worker.", "type": "string" }, "country": { "description": "The worker's country.", "type": "string" }, "country_fields": { "description": "Country level fields for the worker.", "properties": { "ca": { "description": "Country-wise regional fields for Canada", "properties": { "sin": { "description": "Social Insurance Number (SIN) for Canada employees.", "type": "string" } }, "title": "CanadaFields", "type": "object" }, "nz": { "description": "Country-wise regional fields for New Zealand", "properties": { "ird_number": { "description": "Inland Revenue Department (IRD) number for New Zealand employees.", "type": "string" } }, "title": "NewZealandFields", "type": "object" }, "us": { "description": "Country-wise regional fields for USA", "properties": { "ssn": { "description": "Social Security Number (SSN) for US employees.", "type": "string" } }, "title": "USFields", "type": "object" } }, "title": "CountryFields", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "custom_fields": { "description": "Custom field values defined on the Employee object for this worker\n\nExpandable field", "items": { "additionalProperties": {} }, "type": "array" }, "date_of_birth": { "description": "The worker's date of birth.", "type": "string" }, "department": { "description": "The worker's assigned department.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "department_hierarchy": { "description": "List of departments in the department hierarchy. Refer department_hierarchy_ids for department hierarchy order.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestDepartment" }, "type": "array" }, "department_hierarchy_id": { "description": "The identifier of departments in the department hierarchy ordered from parent department to child department.", "items": { "type": "string" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the department.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestDepartment", "description": "The parent department.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent department.", "type": "string" }, "reference_code": { "description": "Reference code of the department.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Department", "type": "object" }, "department_id": { "description": "The worker's assigned department.", "type": "string" }, "employment_type": { "description": "The worker's employment type.\n\nExpandable field", "properties": { "amount_worked": { "description": "The amount worked for the employment type. * `FULL-TIME`: Full-time is at least 30 hours per week. Full-time workers will typically be eligible for benefits. * `PART-TIME`: Part-time is less than 30 hours per week. These workers may be eligible for benefits, depending on company settings and hours worked. * `TEMPORARY`: These workers are hired on a temporary basis. You can specify how each worker with this employment type will be paid individually.", "type": "string" }, "compensation_time_period": { "description": "The compensation period for the employment type. * `SALARIED`: Employees that are paid a fixed amount per year. * `HOURLY`: Employees that are paid a wage per hour worked.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "label": { "description": "The display label of the employment type.", "type": "string" }, "name": { "description": "The name of the employment type for non-custom employment types.", "type": "string" }, "type": { "description": "The classification of the worker by the company. * `CONTRACTOR`: Contractors are self-employed workers who provide services on a short-term or per-project basis and are not eligible for tax-withholding or benefits. * `EMPLOYEE`: Employees are hired and managed by an employer, work under the employer's direct supervision and control, and are protected by law for wages and employment rights.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "label", "updated_at" ], "title": "CompanyEmploymentType", "type": "object" }, "employment_type_id": { "description": "The worker's employment type.", "type": "string" }, "end_date": { "description": "The end date of the worker.", "type": "string" }, "ethnicity": { "description": "The identified ethnicity of the worker, if specified.", "type": "string" }, "gender": { "description": "The gender of the worker, if specified.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_manager": { "description": "Whether the worker is a manager", "type": "boolean" }, "job_function": { "description": "The worker's job function. When expanded, this field requires `job-functions.read`.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "Displayed name of the job function", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "JobFunction", "type": "object" }, "job_function_id": { "description": "ID of the worker's job function.", "type": "string" }, "legal_entity": { "description": "The worker's associated legal entity.\n\nExpandable field", "properties": { "company": { "description": "The company or organization associated with the legal entity\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "doing_business_as_name": { "description": "The doing business as name for the company.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_entities": { "description": "A list of the company's entities.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestLegalEntity" }, "type": "array" }, "legal_entities_id": { "description": "A list of the company's entities.", "items": { "type": "string" }, "type": "array" }, "legal_name": { "description": "The legal name of the company.", "type": "string" }, "name": { "description": "The name of the company.", "type": "string" }, "parent_legal_entity": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The company's ultimate holding entity.\n\nExpandable field", "type": "object" }, "parent_legal_entity_id": { "description": "The company's ultimate holding entity.", "type": "string" }, "phone": { "description": "The phone number for the company.", "type": "string" }, "physical_address": { "description": "The physical address of the holding entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "primary_email": { "description": "The email address used when registering this company.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "legal_entities", "legal_entities_id", "name", "updated_at" ], "title": "Company", "type": "object" }, "company_id": { "description": "The company or organization associated with the legal entity", "type": "string" }, "country": { "description": "The country the legal entity is based in.", "properties": { "code": { "description": "The code of the country.", "type": "string" } }, "required": [ "code" ], "title": "Country", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "entity_level": { "description": "The legal entity's level in a hierarchy. * `PARENT`: The legal entity is considered the ultimate holding entity. * `SUBSIDIARY`: The legal entity is considered a subsidiary, fully or partially held by another. * `BRANCH`: The legal entity is considered a branch, associated with a parent legal entity.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_name": { "description": "The legal name of the legal entity.", "type": "string" }, "mailing_address": { "description": "The mailing address of the legal entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "management_type": { "description": "The legal entity management type in the case of an employer of record (EOR) or professional employment organization (PEO). * `PEO`: The legal entity is considered a Professional Employment Organization (PEO). * `EOR`: The legal entity is considered an Employer of Record (EOR).", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The parent legal entity.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent legal entity.", "type": "string" }, "physical_address": { "description": "The physical address of the legal entity, if it differs from the mailing address.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "registration_date": { "description": "The registration date of the entity.", "type": "string" }, "tax_identifier": { "description": "The tax identifier for the legal entity.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "LegalEntity", "type": "object" }, "legal_entity_id": { "description": "The worker's associated legal entity.", "type": "string" }, "level": { "description": "The level of the worker.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "description": { "description": "The description of the level.", "type": "string" }, "experience_requirements": { "description": "The experience requirements for the level.", "type": "string" }, "global_level": { "anyOf": [ { "description": "Global level is used to track the seniority of levels. The higher up a level is placed on the page, the more senior and higher-ranked the level. Global level is used in workflows, policies, and reports that use the level attribute (e.g., you can use Level Lookup to set up a workflow that notifies the nearest person in an worker's management chain at or above the specified level).", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the level. Must be unique within the company or organization.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLevel", "description": "The parent level.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent level.", "type": "string" }, "rank": { "anyOf": [ { "description": "The rank of the level within its track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "scope_of_responsibilities": { "description": "The scope of responsibilities for the level.", "type": "string" }, "track": { "description": "The track associated with the level, if it's not a global level.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_default": { "description": "Whether this is the company's default track.", "type": "boolean" }, "name": { "description": "The name of the track. Must be unique within the company or organization.", "type": "string" }, "order": { "anyOf": [ { "description": "The one-based horizontal display order of the track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "start_global_level": { "anyOf": [ { "description": "The highest global level occupied by this track. Empty tracks return null.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Track", "type": "object" }, "track_id": { "description": "The track associated with the level. Required during creation. Include global_level when changing it.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Level", "type": "object" }, "level_id": { "description": "The level of the worker.", "type": "string" }, "location": { "description": "The location that the worker is mapped to for tax purposes. In the case that a worker is remote, the location's type is remote.", "properties": { "type": { "description": "The type of location.", "type": "string" }, "work_location_id": { "description": "The work location, if the worker isn't remote.", "type": "string" } }, "required": [ "type", "work_location_id" ], "title": "WorkerLocation", "type": "object" }, "manager": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's manager.\n\nExpandable field", "type": "object" }, "manager_id": { "description": "The worker's manager.", "type": "string" }, "number": { "anyOf": [ { "description": "The worker's number within the organization.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "original_start_date": { "description": "The worker's earliest start date across their employment history, excluding INIT roles.", "type": "string" }, "overtime_exemption": { "description": "The worker's overtime exemption status.", "type": "string" }, "pay_schedule_id": { "description": "The ID of the pay schedule currently associated with the worker.", "type": "string" }, "personal_email": { "description": "The worker's associated personal email address.", "type": "string" }, "race": { "description": "The identified race of the worker, if specified.", "type": "string" }, "start_date": { "description": "The start date of the worker.", "type": "string" }, "status": { "description": "The worker's status within the organization.", "type": "string" }, "teams": { "description": "The worker's assigned teams.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiTeamcb26bc28f32f" }, "type": "array" }, "teams_id": { "description": "The worker's assigned teams.", "items": { "type": "string" }, "type": "array" }, "termination_details": { "description": "The details of the worker's termination, if applicable.", "properties": { "reason": { "description": "This is a description that will be custom to each Rippling company.", "type": "string" }, "type": { "description": "The termination type indicates whether the termination was voluntary or involuntary.", "type": "string" } }, "title": "TerminationDetails", "type": "object" }, "title": { "description": "The worker's title.", "type": "string" }, "title_effective_date": { "description": "Title effective date", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "user": { "description": "The worker's associated user.\n\nExpandable field", "properties": { "active": { "description": "Whether the user is able to access company resources, typically when they are in actively engaged with the company and not after off-boarding.", "type": "boolean" }, "addresses": { "description": "The user's addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiUserAddressedd59b9ba9a1" }, "type": "array" }, "created_at": { "description": "Record creation date", "type": "string" }, "display_name": { "description": "The display name of the user using either the concatenated preferred given and family name or username depending on availability.", "type": "string" }, "emails": { "description": "The user's email addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiEmail5284c8258dc3" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "locale": { "description": "The User's default location for purposes of localization of currency, date time format, or numerical representations pursuant to RFC5646.", "type": "string" }, "name": { "description": "The user's name.", "properties": { "family_name": { "description": "The legal family name of the user, or last name in most Western languages.", "type": "string" }, "formatted": { "description": "The user's full name.", "type": "string" }, "given_name": { "description": "The given legal name of the user, or first name in most Western languages.", "type": "string" }, "middle_name": { "description": "The middle name(s) of the user.", "type": "string" }, "preferred_family_name": { "description": "The preferred family name, or last name in most Western languages, by the user.", "type": "string" }, "preferred_given_name": { "description": "The preferred given name, or first name in most Western languages, by the user.", "type": "string" } }, "title": "UserName", "type": "object" }, "number": { "description": "The permanent profile number of the user.", "type": "string" }, "phone_numbers": { "description": "The user's phone numbers.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoneNumber12060c61ecf5" }, "type": "array" }, "photos": { "description": "The user's photos.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoto2be7c3ae3f39" }, "type": "array" }, "preferred_language": { "description": "The User's preferred written or spoken language in the same format of the HTTP Accept-Language header, pursuant to Section 5.3.5 of RFC7231.", "type": "string" }, "timezone": { "description": "The User's current time zone in IANA database Olson format", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "username": { "description": "The unique identifier across Rippling used by the User for direct authentication into their associated company. Globally unique.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "User", "type": "object" }, "user_id": { "description": "The worker's associated user.", "type": "string" }, "work_email": { "description": "The worker's associated work email address.", "type": "string" }, "work_schedule": { "additionalProperties": { "$ref": "#/components/schemas/OutputRestApiWorkScheduleDay938f88d94f20" }, "description": "The worker's scheduled working hours for each day of the week.", "type": "object" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Worker", "type": "object" }, "OutputRestApiWorker78c309103fe1": { "description": "", "required": [ "created_at", "id", "updated_at" ], "title": "Worker", "type": "object" }, "OutputRestApiWorkerChange40379b30fd23": { "description": "", "properties": { "applied_on": { "description": "When the change was persisted (approval time for changes that went through an approval workflow). UTC. Monotonically increasing as new commits land; use as the cursor axis for incremental polling.", "type": "string" }, "changed_by": { "description": "The actor as the current Worker DTO. Returned only when expand=changed_by is requested.\n\nExpandable field", "properties": { "business_partners": { "description": "Worker's assigned business partners. This field is only populated when explicitly requested via the expand parameter (e.g., ?expand=business_partners). When expanded, returns an empty list ([]) if the worker has no business partners.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiBusinessPartner77b00a069c32" }, "type": "array" }, "business_partners_id": { "description": "Worker's assigned business partners unique identifiers. Returns an empty list ([]) if the worker has no business partners.", "items": { "type": "string" }, "type": "array" }, "citizenship": { "description": "The countries that the worker has citizenship in.", "type": "string" }, "compensation": { "description": "The compensation package for the worker.\n\nExpandable field", "properties": { "annual_compensation": { "description": "The worker's annual compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "annual_salary_equivalent": { "description": "The worker's annual salary equivalent, for insurance purposes. It will be equal to the worker's annual compensation, except for owners that are receiving no cashcompensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "bonus_schedule": { "description": "The worker's bonus schedule.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "hourly_wage": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "id": { "description": "Identifier field", "type": "string" }, "monthly_compensation": { "description": "The worker's monthly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "on_target_commission": { "description": "The worker's on-target commission.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "payment_terms": { "description": "The payment terms for an worker's compensation.", "type": "string" }, "payment_type": { "description": "The payment type for an worker's compensation.", "type": "string" }, "relocation_reimbursement": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "salary_effective_date": { "description": "Salary effective date", "type": "string" }, "signing_bonus": { "description": "The worker's signing bonus.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus": { "description": "The worker's target annual bonus amount.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus_percent": { "anyOf": [ { "description": "The worker's target annual bonus as a percent of annual compensation.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" }, "weekly_compensation": { "description": "The worker's weekly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "worker": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's details.\n\nExpandable field", "type": "object" }, "worker_id": { "description": "The worker's ID.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Compensation", "type": "object" }, "compensation_grade": { "description": "The compensation grade assigned to the worker, if any.", "properties": { "id": { "description": "The compensation grade's unique identifier.", "type": "string" }, "label": { "description": "The compensation grade's label.", "type": "string" } }, "title": "WorkerCompensationGrade", "type": "object" }, "compensation_id": { "description": "The compensation package for the worker.", "type": "string" }, "country": { "description": "The worker's country.", "type": "string" }, "country_fields": { "description": "Country level fields for the worker.", "properties": { "ca": { "description": "Country-wise regional fields for Canada", "properties": { "sin": { "description": "Social Insurance Number (SIN) for Canada employees.", "type": "string" } }, "title": "CanadaFields", "type": "object" }, "nz": { "description": "Country-wise regional fields for New Zealand", "properties": { "ird_number": { "description": "Inland Revenue Department (IRD) number for New Zealand employees.", "type": "string" } }, "title": "NewZealandFields", "type": "object" }, "us": { "description": "Country-wise regional fields for USA", "properties": { "ssn": { "description": "Social Security Number (SSN) for US employees.", "type": "string" } }, "title": "USFields", "type": "object" } }, "title": "CountryFields", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "custom_fields": { "description": "Custom field values defined on the Employee object for this worker\n\nExpandable field", "items": { "additionalProperties": {} }, "type": "array" }, "date_of_birth": { "description": "The worker's date of birth.", "type": "string" }, "department": { "description": "The worker's assigned department.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "department_hierarchy": { "description": "List of departments in the department hierarchy. Refer department_hierarchy_ids for department hierarchy order.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestDepartment" }, "type": "array" }, "department_hierarchy_id": { "description": "The identifier of departments in the department hierarchy ordered from parent department to child department.", "items": { "type": "string" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the department.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestDepartment", "description": "The parent department.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent department.", "type": "string" }, "reference_code": { "description": "Reference code of the department.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Department", "type": "object" }, "department_id": { "description": "The worker's assigned department.", "type": "string" }, "employment_type": { "description": "The worker's employment type.\n\nExpandable field", "properties": { "amount_worked": { "description": "The amount worked for the employment type. * `FULL-TIME`: Full-time is at least 30 hours per week. Full-time workers will typically be eligible for benefits. * `PART-TIME`: Part-time is less than 30 hours per week. These workers may be eligible for benefits, depending on company settings and hours worked. * `TEMPORARY`: These workers are hired on a temporary basis. You can specify how each worker with this employment type will be paid individually.", "type": "string" }, "compensation_time_period": { "description": "The compensation period for the employment type. * `SALARIED`: Employees that are paid a fixed amount per year. * `HOURLY`: Employees that are paid a wage per hour worked.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "label": { "description": "The display label of the employment type.", "type": "string" }, "name": { "description": "The name of the employment type for non-custom employment types.", "type": "string" }, "type": { "description": "The classification of the worker by the company. * `CONTRACTOR`: Contractors are self-employed workers who provide services on a short-term or per-project basis and are not eligible for tax-withholding or benefits. * `EMPLOYEE`: Employees are hired and managed by an employer, work under the employer's direct supervision and control, and are protected by law for wages and employment rights.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "label", "updated_at" ], "title": "CompanyEmploymentType", "type": "object" }, "employment_type_id": { "description": "The worker's employment type.", "type": "string" }, "end_date": { "description": "The end date of the worker.", "type": "string" }, "ethnicity": { "description": "The identified ethnicity of the worker, if specified.", "type": "string" }, "gender": { "description": "The gender of the worker, if specified.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_manager": { "description": "Whether the worker is a manager", "type": "boolean" }, "job_function": { "description": "The worker's job function. When expanded, this field requires `job-functions.read`.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "Displayed name of the job function", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "JobFunction", "type": "object" }, "job_function_id": { "description": "ID of the worker's job function.", "type": "string" }, "legal_entity": { "description": "The worker's associated legal entity.\n\nExpandable field", "properties": { "company": { "description": "The company or organization associated with the legal entity\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "doing_business_as_name": { "description": "The doing business as name for the company.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_entities": { "description": "A list of the company's entities.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestLegalEntity" }, "type": "array" }, "legal_entities_id": { "description": "A list of the company's entities.", "items": { "type": "string" }, "type": "array" }, "legal_name": { "description": "The legal name of the company.", "type": "string" }, "name": { "description": "The name of the company.", "type": "string" }, "parent_legal_entity": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The company's ultimate holding entity.\n\nExpandable field", "type": "object" }, "parent_legal_entity_id": { "description": "The company's ultimate holding entity.", "type": "string" }, "phone": { "description": "The phone number for the company.", "type": "string" }, "physical_address": { "description": "The physical address of the holding entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "primary_email": { "description": "The email address used when registering this company.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "legal_entities", "legal_entities_id", "name", "updated_at" ], "title": "Company", "type": "object" }, "company_id": { "description": "The company or organization associated with the legal entity", "type": "string" }, "country": { "description": "The country the legal entity is based in.", "properties": { "code": { "description": "The code of the country.", "type": "string" } }, "required": [ "code" ], "title": "Country", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "entity_level": { "description": "The legal entity's level in a hierarchy. * `PARENT`: The legal entity is considered the ultimate holding entity. * `SUBSIDIARY`: The legal entity is considered a subsidiary, fully or partially held by another. * `BRANCH`: The legal entity is considered a branch, associated with a parent legal entity.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_name": { "description": "The legal name of the legal entity.", "type": "string" }, "mailing_address": { "description": "The mailing address of the legal entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "management_type": { "description": "The legal entity management type in the case of an employer of record (EOR) or professional employment organization (PEO). * `PEO`: The legal entity is considered a Professional Employment Organization (PEO). * `EOR`: The legal entity is considered an Employer of Record (EOR).", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The parent legal entity.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent legal entity.", "type": "string" }, "physical_address": { "description": "The physical address of the legal entity, if it differs from the mailing address.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "registration_date": { "description": "The registration date of the entity.", "type": "string" }, "tax_identifier": { "description": "The tax identifier for the legal entity.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "LegalEntity", "type": "object" }, "legal_entity_id": { "description": "The worker's associated legal entity.", "type": "string" }, "level": { "description": "The level of the worker.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "description": { "description": "The description of the level.", "type": "string" }, "experience_requirements": { "description": "The experience requirements for the level.", "type": "string" }, "global_level": { "anyOf": [ { "description": "Global level is used to track the seniority of levels. The higher up a level is placed on the page, the more senior and higher-ranked the level. Global level is used in workflows, policies, and reports that use the level attribute (e.g., you can use Level Lookup to set up a workflow that notifies the nearest person in an worker's management chain at or above the specified level).", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the level. Must be unique within the company or organization.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLevel", "description": "The parent level.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent level.", "type": "string" }, "rank": { "anyOf": [ { "description": "The rank of the level within its track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "scope_of_responsibilities": { "description": "The scope of responsibilities for the level.", "type": "string" }, "track": { "description": "The track associated with the level, if it's not a global level.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_default": { "description": "Whether this is the company's default track.", "type": "boolean" }, "name": { "description": "The name of the track. Must be unique within the company or organization.", "type": "string" }, "order": { "anyOf": [ { "description": "The one-based horizontal display order of the track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "start_global_level": { "anyOf": [ { "description": "The highest global level occupied by this track. Empty tracks return null.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Track", "type": "object" }, "track_id": { "description": "The track associated with the level. Required during creation. Include global_level when changing it.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Level", "type": "object" }, "level_id": { "description": "The level of the worker.", "type": "string" }, "location": { "description": "The location that the worker is mapped to for tax purposes. In the case that a worker is remote, the location's type is remote.", "properties": { "type": { "description": "The type of location.", "type": "string" }, "work_location_id": { "description": "The work location, if the worker isn't remote.", "type": "string" } }, "required": [ "type", "work_location_id" ], "title": "WorkerLocation", "type": "object" }, "manager": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's manager.\n\nExpandable field", "type": "object" }, "manager_id": { "description": "The worker's manager.", "type": "string" }, "number": { "anyOf": [ { "description": "The worker's number within the organization.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "original_start_date": { "description": "The worker's earliest start date across their employment history, excluding INIT roles.", "type": "string" }, "overtime_exemption": { "description": "The worker's overtime exemption status.", "type": "string" }, "pay_schedule_id": { "description": "The ID of the pay schedule currently associated with the worker.", "type": "string" }, "personal_email": { "description": "The worker's associated personal email address.", "type": "string" }, "race": { "description": "The identified race of the worker, if specified.", "type": "string" }, "start_date": { "description": "The start date of the worker.", "type": "string" }, "status": { "description": "The worker's status within the organization.", "type": "string" }, "teams": { "description": "The worker's assigned teams.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiTeamcb26bc28f32f" }, "type": "array" }, "teams_id": { "description": "The worker's assigned teams.", "items": { "type": "string" }, "type": "array" }, "termination_details": { "description": "The details of the worker's termination, if applicable.", "properties": { "reason": { "description": "This is a description that will be custom to each Rippling company.", "type": "string" }, "type": { "description": "The termination type indicates whether the termination was voluntary or involuntary.", "type": "string" } }, "title": "TerminationDetails", "type": "object" }, "title": { "description": "The worker's title.", "type": "string" }, "title_effective_date": { "description": "Title effective date", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "user": { "description": "The worker's associated user.\n\nExpandable field", "properties": { "active": { "description": "Whether the user is able to access company resources, typically when they are in actively engaged with the company and not after off-boarding.", "type": "boolean" }, "addresses": { "description": "The user's addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiUserAddressedd59b9ba9a1" }, "type": "array" }, "created_at": { "description": "Record creation date", "type": "string" }, "display_name": { "description": "The display name of the user using either the concatenated preferred given and family name or username depending on availability.", "type": "string" }, "emails": { "description": "The user's email addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiEmail5284c8258dc3" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "locale": { "description": "The User's default location for purposes of localization of currency, date time format, or numerical representations pursuant to RFC5646.", "type": "string" }, "name": { "description": "The user's name.", "properties": { "family_name": { "description": "The legal family name of the user, or last name in most Western languages.", "type": "string" }, "formatted": { "description": "The user's full name.", "type": "string" }, "given_name": { "description": "The given legal name of the user, or first name in most Western languages.", "type": "string" }, "middle_name": { "description": "The middle name(s) of the user.", "type": "string" }, "preferred_family_name": { "description": "The preferred family name, or last name in most Western languages, by the user.", "type": "string" }, "preferred_given_name": { "description": "The preferred given name, or first name in most Western languages, by the user.", "type": "string" } }, "title": "UserName", "type": "object" }, "number": { "description": "The permanent profile number of the user.", "type": "string" }, "phone_numbers": { "description": "The user's phone numbers.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoneNumber12060c61ecf5" }, "type": "array" }, "photos": { "description": "The user's photos.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoto2be7c3ae3f39" }, "type": "array" }, "preferred_language": { "description": "The User's preferred written or spoken language in the same format of the HTTP Accept-Language header, pursuant to Section 5.3.5 of RFC7231.", "type": "string" }, "timezone": { "description": "The User's current time zone in IANA database Olson format", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "username": { "description": "The unique identifier across Rippling used by the User for direct authentication into their associated company. Globally unique.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "User", "type": "object" }, "user_id": { "description": "The worker's associated user.", "type": "string" }, "work_email": { "description": "The worker's associated work email address.", "type": "string" }, "work_schedule": { "additionalProperties": { "$ref": "#/components/schemas/OutputRestApiWorkScheduleDay938f88d94f20" }, "description": "The worker's scheduled working hours for each day of the week.", "type": "object" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Worker", "type": "object" }, "changed_by_id": { "description": "Actor who made the change. Null for system-initiated events.", "type": "string" }, "changes": { "description": "Field-level changes captured by this event. Per-field REDACTED entries appear for fields the caller cannot read so consumers can detect that a change occurred even when the value is hidden. Events where every changed field is invisible to the caller — either internal fields not exposed via the public Object Graph, or fields the caller's role has zero read permission on — are dropped from the response entirely (they never appear with an all-REDACTED changes array).", "items": { "$ref": "#/components/schemas/OutputRestApiWorkerChangeFieldChangede534fd042b2" }, "type": "array" }, "created_at": { "description": "Record creation date", "type": "string" }, "effective_on": { "description": "When the change is true in the business domain. Can be past, present, or future. Independent of applied_on. UTC.", "type": "string" }, "event_type": { "description": "The lifecycle event type this change represents. CHANGE is the catch-all for non-lifecycle field edits.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "import_type": { "description": "INITIAL (census import at company onboarding) or HISTORICAL (historical data imported later). Set only when event_type is IMPORT.", "type": "string" }, "reason_code": { "description": "Structured transition reason (e.g. 'PROMOTION', 'MARKET_ADJUSTMENT'). Populated only when the company has configured transition reasons and the change went through a role transition with one selected. Null for most companies and events.", "type": "string" }, "referenced_transaction_id": { "description": "For amendments or undos, the id of the worker-change event being modified.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "worker": { "description": "The affected worker as the current Worker DTO. Returned only when expand=worker is requested. Includes terminated employees.\n\nExpandable field", "properties": { "business_partners": { "description": "Worker's assigned business partners. This field is only populated when explicitly requested via the expand parameter (e.g., ?expand=business_partners). When expanded, returns an empty list ([]) if the worker has no business partners.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiBusinessPartner77b00a069c32" }, "type": "array" }, "business_partners_id": { "description": "Worker's assigned business partners unique identifiers. Returns an empty list ([]) if the worker has no business partners.", "items": { "type": "string" }, "type": "array" }, "citizenship": { "description": "The countries that the worker has citizenship in.", "type": "string" }, "compensation": { "description": "The compensation package for the worker.\n\nExpandable field", "properties": { "annual_compensation": { "description": "The worker's annual compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "annual_salary_equivalent": { "description": "The worker's annual salary equivalent, for insurance purposes. It will be equal to the worker's annual compensation, except for owners that are receiving no cashcompensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "bonus_schedule": { "description": "The worker's bonus schedule.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "hourly_wage": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "id": { "description": "Identifier field", "type": "string" }, "monthly_compensation": { "description": "The worker's monthly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "on_target_commission": { "description": "The worker's on-target commission.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "payment_terms": { "description": "The payment terms for an worker's compensation.", "type": "string" }, "payment_type": { "description": "The payment type for an worker's compensation.", "type": "string" }, "relocation_reimbursement": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "salary_effective_date": { "description": "Salary effective date", "type": "string" }, "signing_bonus": { "description": "The worker's signing bonus.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus": { "description": "The worker's target annual bonus amount.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus_percent": { "anyOf": [ { "description": "The worker's target annual bonus as a percent of annual compensation.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" }, "weekly_compensation": { "description": "The worker's weekly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "worker": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's details.\n\nExpandable field", "type": "object" }, "worker_id": { "description": "The worker's ID.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Compensation", "type": "object" }, "compensation_grade": { "description": "The compensation grade assigned to the worker, if any.", "properties": { "id": { "description": "The compensation grade's unique identifier.", "type": "string" }, "label": { "description": "The compensation grade's label.", "type": "string" } }, "title": "WorkerCompensationGrade", "type": "object" }, "compensation_id": { "description": "The compensation package for the worker.", "type": "string" }, "country": { "description": "The worker's country.", "type": "string" }, "country_fields": { "description": "Country level fields for the worker.", "properties": { "ca": { "description": "Country-wise regional fields for Canada", "properties": { "sin": { "description": "Social Insurance Number (SIN) for Canada employees.", "type": "string" } }, "title": "CanadaFields", "type": "object" }, "nz": { "description": "Country-wise regional fields for New Zealand", "properties": { "ird_number": { "description": "Inland Revenue Department (IRD) number for New Zealand employees.", "type": "string" } }, "title": "NewZealandFields", "type": "object" }, "us": { "description": "Country-wise regional fields for USA", "properties": { "ssn": { "description": "Social Security Number (SSN) for US employees.", "type": "string" } }, "title": "USFields", "type": "object" } }, "title": "CountryFields", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "custom_fields": { "description": "Custom field values defined on the Employee object for this worker\n\nExpandable field", "items": { "additionalProperties": {} }, "type": "array" }, "date_of_birth": { "description": "The worker's date of birth.", "type": "string" }, "department": { "description": "The worker's assigned department.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "department_hierarchy": { "description": "List of departments in the department hierarchy. Refer department_hierarchy_ids for department hierarchy order.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestDepartment" }, "type": "array" }, "department_hierarchy_id": { "description": "The identifier of departments in the department hierarchy ordered from parent department to child department.", "items": { "type": "string" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the department.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestDepartment", "description": "The parent department.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent department.", "type": "string" }, "reference_code": { "description": "Reference code of the department.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Department", "type": "object" }, "department_id": { "description": "The worker's assigned department.", "type": "string" }, "employment_type": { "description": "The worker's employment type.\n\nExpandable field", "properties": { "amount_worked": { "description": "The amount worked for the employment type. * `FULL-TIME`: Full-time is at least 30 hours per week. Full-time workers will typically be eligible for benefits. * `PART-TIME`: Part-time is less than 30 hours per week. These workers may be eligible for benefits, depending on company settings and hours worked. * `TEMPORARY`: These workers are hired on a temporary basis. You can specify how each worker with this employment type will be paid individually.", "type": "string" }, "compensation_time_period": { "description": "The compensation period for the employment type. * `SALARIED`: Employees that are paid a fixed amount per year. * `HOURLY`: Employees that are paid a wage per hour worked.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "label": { "description": "The display label of the employment type.", "type": "string" }, "name": { "description": "The name of the employment type for non-custom employment types.", "type": "string" }, "type": { "description": "The classification of the worker by the company. * `CONTRACTOR`: Contractors are self-employed workers who provide services on a short-term or per-project basis and are not eligible for tax-withholding or benefits. * `EMPLOYEE`: Employees are hired and managed by an employer, work under the employer's direct supervision and control, and are protected by law for wages and employment rights.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "label", "updated_at" ], "title": "CompanyEmploymentType", "type": "object" }, "employment_type_id": { "description": "The worker's employment type.", "type": "string" }, "end_date": { "description": "The end date of the worker.", "type": "string" }, "ethnicity": { "description": "The identified ethnicity of the worker, if specified.", "type": "string" }, "gender": { "description": "The gender of the worker, if specified.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_manager": { "description": "Whether the worker is a manager", "type": "boolean" }, "job_function": { "description": "The worker's job function. When expanded, this field requires `job-functions.read`.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "Displayed name of the job function", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "JobFunction", "type": "object" }, "job_function_id": { "description": "ID of the worker's job function.", "type": "string" }, "legal_entity": { "description": "The worker's associated legal entity.\n\nExpandable field", "properties": { "company": { "description": "The company or organization associated with the legal entity\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "doing_business_as_name": { "description": "The doing business as name for the company.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_entities": { "description": "A list of the company's entities.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestLegalEntity" }, "type": "array" }, "legal_entities_id": { "description": "A list of the company's entities.", "items": { "type": "string" }, "type": "array" }, "legal_name": { "description": "The legal name of the company.", "type": "string" }, "name": { "description": "The name of the company.", "type": "string" }, "parent_legal_entity": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The company's ultimate holding entity.\n\nExpandable field", "type": "object" }, "parent_legal_entity_id": { "description": "The company's ultimate holding entity.", "type": "string" }, "phone": { "description": "The phone number for the company.", "type": "string" }, "physical_address": { "description": "The physical address of the holding entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "primary_email": { "description": "The email address used when registering this company.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "legal_entities", "legal_entities_id", "name", "updated_at" ], "title": "Company", "type": "object" }, "company_id": { "description": "The company or organization associated with the legal entity", "type": "string" }, "country": { "description": "The country the legal entity is based in.", "properties": { "code": { "description": "The code of the country.", "type": "string" } }, "required": [ "code" ], "title": "Country", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "entity_level": { "description": "The legal entity's level in a hierarchy. * `PARENT`: The legal entity is considered the ultimate holding entity. * `SUBSIDIARY`: The legal entity is considered a subsidiary, fully or partially held by another. * `BRANCH`: The legal entity is considered a branch, associated with a parent legal entity.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_name": { "description": "The legal name of the legal entity.", "type": "string" }, "mailing_address": { "description": "The mailing address of the legal entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "management_type": { "description": "The legal entity management type in the case of an employer of record (EOR) or professional employment organization (PEO). * `PEO`: The legal entity is considered a Professional Employment Organization (PEO). * `EOR`: The legal entity is considered an Employer of Record (EOR).", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The parent legal entity.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent legal entity.", "type": "string" }, "physical_address": { "description": "The physical address of the legal entity, if it differs from the mailing address.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "registration_date": { "description": "The registration date of the entity.", "type": "string" }, "tax_identifier": { "description": "The tax identifier for the legal entity.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "LegalEntity", "type": "object" }, "legal_entity_id": { "description": "The worker's associated legal entity.", "type": "string" }, "level": { "description": "The level of the worker.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "description": { "description": "The description of the level.", "type": "string" }, "experience_requirements": { "description": "The experience requirements for the level.", "type": "string" }, "global_level": { "anyOf": [ { "description": "Global level is used to track the seniority of levels. The higher up a level is placed on the page, the more senior and higher-ranked the level. Global level is used in workflows, policies, and reports that use the level attribute (e.g., you can use Level Lookup to set up a workflow that notifies the nearest person in an worker's management chain at or above the specified level).", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the level. Must be unique within the company or organization.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLevel", "description": "The parent level.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent level.", "type": "string" }, "rank": { "anyOf": [ { "description": "The rank of the level within its track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "scope_of_responsibilities": { "description": "The scope of responsibilities for the level.", "type": "string" }, "track": { "description": "The track associated with the level, if it's not a global level.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_default": { "description": "Whether this is the company's default track.", "type": "boolean" }, "name": { "description": "The name of the track. Must be unique within the company or organization.", "type": "string" }, "order": { "anyOf": [ { "description": "The one-based horizontal display order of the track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "start_global_level": { "anyOf": [ { "description": "The highest global level occupied by this track. Empty tracks return null.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Track", "type": "object" }, "track_id": { "description": "The track associated with the level. Required during creation. Include global_level when changing it.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Level", "type": "object" }, "level_id": { "description": "The level of the worker.", "type": "string" }, "location": { "description": "The location that the worker is mapped to for tax purposes. In the case that a worker is remote, the location's type is remote.", "properties": { "type": { "description": "The type of location.", "type": "string" }, "work_location_id": { "description": "The work location, if the worker isn't remote.", "type": "string" } }, "required": [ "type", "work_location_id" ], "title": "WorkerLocation", "type": "object" }, "manager": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's manager.\n\nExpandable field", "type": "object" }, "manager_id": { "description": "The worker's manager.", "type": "string" }, "number": { "anyOf": [ { "description": "The worker's number within the organization.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "original_start_date": { "description": "The worker's earliest start date across their employment history, excluding INIT roles.", "type": "string" }, "overtime_exemption": { "description": "The worker's overtime exemption status.", "type": "string" }, "pay_schedule_id": { "description": "The ID of the pay schedule currently associated with the worker.", "type": "string" }, "personal_email": { "description": "The worker's associated personal email address.", "type": "string" }, "race": { "description": "The identified race of the worker, if specified.", "type": "string" }, "start_date": { "description": "The start date of the worker.", "type": "string" }, "status": { "description": "The worker's status within the organization.", "type": "string" }, "teams": { "description": "The worker's assigned teams.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiTeamcb26bc28f32f" }, "type": "array" }, "teams_id": { "description": "The worker's assigned teams.", "items": { "type": "string" }, "type": "array" }, "termination_details": { "description": "The details of the worker's termination, if applicable.", "properties": { "reason": { "description": "This is a description that will be custom to each Rippling company.", "type": "string" }, "type": { "description": "The termination type indicates whether the termination was voluntary or involuntary.", "type": "string" } }, "title": "TerminationDetails", "type": "object" }, "title": { "description": "The worker's title.", "type": "string" }, "title_effective_date": { "description": "Title effective date", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "user": { "description": "The worker's associated user.\n\nExpandable field", "properties": { "active": { "description": "Whether the user is able to access company resources, typically when they are in actively engaged with the company and not after off-boarding.", "type": "boolean" }, "addresses": { "description": "The user's addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiUserAddressedd59b9ba9a1" }, "type": "array" }, "created_at": { "description": "Record creation date", "type": "string" }, "display_name": { "description": "The display name of the user using either the concatenated preferred given and family name or username depending on availability.", "type": "string" }, "emails": { "description": "The user's email addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiEmail5284c8258dc3" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "locale": { "description": "The User's default location for purposes of localization of currency, date time format, or numerical representations pursuant to RFC5646.", "type": "string" }, "name": { "description": "The user's name.", "properties": { "family_name": { "description": "The legal family name of the user, or last name in most Western languages.", "type": "string" }, "formatted": { "description": "The user's full name.", "type": "string" }, "given_name": { "description": "The given legal name of the user, or first name in most Western languages.", "type": "string" }, "middle_name": { "description": "The middle name(s) of the user.", "type": "string" }, "preferred_family_name": { "description": "The preferred family name, or last name in most Western languages, by the user.", "type": "string" }, "preferred_given_name": { "description": "The preferred given name, or first name in most Western languages, by the user.", "type": "string" } }, "title": "UserName", "type": "object" }, "number": { "description": "The permanent profile number of the user.", "type": "string" }, "phone_numbers": { "description": "The user's phone numbers.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoneNumber12060c61ecf5" }, "type": "array" }, "photos": { "description": "The user's photos.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoto2be7c3ae3f39" }, "type": "array" }, "preferred_language": { "description": "The User's preferred written or spoken language in the same format of the HTTP Accept-Language header, pursuant to Section 5.3.5 of RFC7231.", "type": "string" }, "timezone": { "description": "The User's current time zone in IANA database Olson format", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "username": { "description": "The unique identifier across Rippling used by the User for direct authentication into their associated company. Globally unique.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "User", "type": "object" }, "user_id": { "description": "The worker's associated user.", "type": "string" }, "work_email": { "description": "The worker's associated work email address.", "type": "string" }, "work_schedule": { "additionalProperties": { "$ref": "#/components/schemas/OutputRestApiWorkScheduleDay938f88d94f20" }, "description": "The worker's scheduled working hours for each day of the week.", "type": "object" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Worker", "type": "object" }, "worker_id": { "description": "The worker affected by this change.", "type": "string" } }, "required": [ "applied_on", "changes", "created_at", "effective_on", "event_type", "id", "updated_at", "worker_id" ], "title": "WorkerChange", "type": "object" }, "OutputRestApiWorkerChangeField60803486a969": { "description": "", "properties": { "category": { "description": "High-level grouping for the field.", "type": "string" }, "field_display_name": { "description": "UI label for the field (English).", "type": "string" }, "field_key": { "description": "Field key in snake_case. Use directly in ?filter=field_key eq '...' on GET /worker-changes. Naming convention: public DTO fields use the DTO field name verbatim (work_email, title); nested fields use dot notation (compensation.base_salary); custom fields use custom_fields.; country-specific fields use country_fields.. Filter semantics: filtering GET /worker-changes by field_key returns events that contain at least one change to this field, but the changes[] array on those events is NOT pruned — consumers receive the full event payload including changes to other fields.", "type": "string" }, "value_type": { "description": "Value type of the field.", "type": "string" } }, "required": [ "category", "field_display_name", "field_key", "value_type" ], "title": "WorkerChangeField", "type": "object" }, "OutputRestApiWorkerChangeFieldChangede534fd042b2": { "description": "", "properties": { "display_type": { "description": "VISIBLE or REDACTED. REDACTED means the caller's role lacks permission to read this field; from_value/to_value are null but the entry still appears so consumers know a change occurred.", "type": "string" }, "field_display_name": { "description": "UI label for the field (English).", "type": "string" }, "field_key": { "description": "Field key in snake_case.", "type": "string" }, "from_value": { "description": "Value before the change, rendered as a display string (locale- and currency-formatted per the activity-log convention). Null when display_type is REDACTED. Typed JSON values are tracked as a future addition; consult value_type to interpret the rendering.", "type": "string" }, "to_value": { "description": "Value after the change, rendered as a display string. Null when display_type is REDACTED. See from_value for notes on typed-value plans.", "type": "string" }, "value_type": { "description": "The underlying value type of this field. Populated regardless of display_type so consumers can interpret from_value / to_value or anticipate a future typed representation.", "type": "string" } }, "required": [ "display_type", "field_display_name", "field_key", "value_type" ], "title": "WorkerChangeFieldChange", "type": "object" }, "OutputRestApiWorkerPayrollDeductione1f656ef0da0": { "description": "A single deduction line item on a worker's payroll record.", "properties": { "deduction_code": { "description": "Code identifying the deduction type.", "type": "string" }, "display_name": { "description": "Human-readable name of the deduction.", "type": "string" }, "employee_amount": { "description": "Employee contribution amount for the current period.", "type": "string" }, "employer_amount": { "description": "Employer contribution amount for the current period.", "type": "string" } }, "title": "WorkerPayrollDeduction", "type": "object" }, "OutputRestApiWorkerPayrollEarning18b080622862": { "description": "A single earning line item on a worker's payroll record.", "properties": { "amount": { "description": "Earning amount for the current period.", "type": "string" }, "display_name": { "description": "Human-readable name of the earning.", "type": "string" }, "earning_category": { "description": "Category of the earning (e.g. SALARY, HOURLY).", "type": "string" }, "earning_code": { "description": "Code identifying the earning type (e.g. regular_salary).", "type": "string" }, "hours": { "description": "Hours worked for this earning in the current period.", "type": "string" }, "rate": { "description": "Hourly rate applied to this earning.", "type": "string" }, "time_labels": { "description": "Time tracking labels associated with this earning.", "items": { "type": "string" }, "type": "array" } }, "title": "WorkerPayrollEarning", "type": "object" }, "OutputRestApiWorkerPayrollGarnishment258466e7ecb5": { "description": "A single garnishment line item on a worker's payroll record.", "properties": { "amount": { "description": "Garnishment amount for the current period.", "type": "string" }, "garnishment_code": { "description": "Code identifying the garnishment.", "type": "string" } }, "title": "WorkerPayrollGarnishment", "type": "object" }, "OutputRestApiWorkerPayrollRecord108387f3da0a": { "description": "\n V2 DTO representing earnings, deductions, taxes, and garnishments\n for a single worker in a payroll run.\n\n Used by:\n - GET /payroll-runs/{run_id}/worker-payroll-records/ (list)\n - GET /payroll-runs/{run_id}/worker-payroll-records/{id} (retrieve)\n ", "properties": { "country_code": { "description": "ISO country code where this payroll record applies.", "type": "string" }, "currency": { "description": "ISO currency code for monetary amounts in this record.", "type": "string" }, "deductions": { "description": "List of deduction line items.", "items": { "$ref": "#/components/schemas/OutputRestApiWorkerPayrollDeductione1f656ef0da0" }, "type": "array" }, "earnings": { "description": "List of earning line items.", "items": { "$ref": "#/components/schemas/OutputRestApiWorkerPayrollEarning18b080622862" }, "type": "array" }, "garnishments": { "description": "List of garnishment line items.", "items": { "$ref": "#/components/schemas/OutputRestApiWorkerPayrollGarnishment258466e7ecb5" }, "type": "array" }, "gross_pay": { "description": "Gross pay amount for the current period.", "type": "string" }, "id": { "description": "Unique identifier for this payroll record (PRE version ID).", "type": "string" }, "net_pay": { "description": "Net pay amount for the current period.", "type": "string" }, "run_id": { "description": "Identifier of the payroll run this record belongs to.", "type": "string" }, "summary": { "description": "Aggregate totals for taxes, deductions, and garnishments.", "properties": { "employee_deductions": { "description": "Total employee deductions.", "type": "string" }, "employee_taxes": { "description": "Total employee-paid taxes.", "type": "string" }, "employer_contributions": { "description": "Total employer contributions (e.g. retirement matching).", "type": "string" }, "employer_taxes": { "description": "Total employer-paid taxes.", "type": "string" }, "total_garnishments": { "description": "Total garnishments withheld.", "type": "string" } }, "title": "WorkerPayrollRecordSummary", "type": "object" }, "taxes": { "description": "List of tax line items.", "items": { "$ref": "#/components/schemas/OutputRestApiWorkerPayrollTaxbfd25c4fc850" }, "type": "array" }, "worker_id": { "description": "Identifier of the worker (role ID).", "type": "string" } }, "title": "WorkerPayrollRecord", "type": "object" }, "OutputRestApiWorkerPayrollTaxbfd25c4fc850": { "description": "A single tax line item on a worker's payroll record.", "properties": { "amount": { "description": "Tax amount for the current period.", "type": "string" }, "display_name": { "description": "Human-readable name of the tax.", "type": "string" }, "paid_by": { "description": "Who pays this tax: EMPLOYER or EMPLOYEE.", "type": "string" }, "tax_code": { "description": "Unique code identifying the tax.", "type": "string" } }, "title": "WorkerPayrollTax", "type": "object" }, "OutputRestApiWorkerTimeSplit791318857508": { "description": "Worker time split configuration resource.", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_enabled": { "description": "Whether hard-coded time splits are active for this worker.", "type": "boolean" }, "job_codes": { "description": "The job codes referenced in this time split configuration. Use ?expand=job_codes to populate.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiJobCodeeda25ec6c9a8" }, "type": "array" }, "job_codes_id": { "description": "IDs of all unique job codes referenced across all split rows.", "items": { "type": "string" }, "type": "array" }, "splits": { "description": "The split rows defining time allocation percentages across job codes. Empty when is_enabled is false.", "items": { "$ref": "#/components/schemas/OutputRestApiSplit283f489e3a65" }, "type": "array" }, "updated_at": { "description": "Record update date", "type": "string" }, "worker": { "description": "The worker associated with this time split configuration.\n\nExpandable field", "properties": { "business_partners": { "description": "Worker's assigned business partners. This field is only populated when explicitly requested via the expand parameter (e.g., ?expand=business_partners). When expanded, returns an empty list ([]) if the worker has no business partners.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiBusinessPartner77b00a069c32" }, "type": "array" }, "business_partners_id": { "description": "Worker's assigned business partners unique identifiers. Returns an empty list ([]) if the worker has no business partners.", "items": { "type": "string" }, "type": "array" }, "citizenship": { "description": "The countries that the worker has citizenship in.", "type": "string" }, "compensation": { "description": "The compensation package for the worker.\n\nExpandable field", "properties": { "annual_compensation": { "description": "The worker's annual compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "annual_salary_equivalent": { "description": "The worker's annual salary equivalent, for insurance purposes. It will be equal to the worker's annual compensation, except for owners that are receiving no cashcompensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "bonus_schedule": { "description": "The worker's bonus schedule.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "hourly_wage": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "id": { "description": "Identifier field", "type": "string" }, "monthly_compensation": { "description": "The worker's monthly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "on_target_commission": { "description": "The worker's on-target commission.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "payment_terms": { "description": "The payment terms for an worker's compensation.", "type": "string" }, "payment_type": { "description": "The payment type for an worker's compensation.", "type": "string" }, "relocation_reimbursement": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "salary_effective_date": { "description": "Salary effective date", "type": "string" }, "signing_bonus": { "description": "The worker's signing bonus.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus": { "description": "The worker's target annual bonus amount.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus_percent": { "anyOf": [ { "description": "The worker's target annual bonus as a percent of annual compensation.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" }, "weekly_compensation": { "description": "The worker's weekly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "worker": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's details.\n\nExpandable field", "type": "object" }, "worker_id": { "description": "The worker's ID.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Compensation", "type": "object" }, "compensation_grade": { "description": "The compensation grade assigned to the worker, if any.", "properties": { "id": { "description": "The compensation grade's unique identifier.", "type": "string" }, "label": { "description": "The compensation grade's label.", "type": "string" } }, "title": "WorkerCompensationGrade", "type": "object" }, "compensation_id": { "description": "The compensation package for the worker.", "type": "string" }, "country": { "description": "The worker's country.", "type": "string" }, "country_fields": { "description": "Country level fields for the worker.", "properties": { "ca": { "description": "Country-wise regional fields for Canada", "properties": { "sin": { "description": "Social Insurance Number (SIN) for Canada employees.", "type": "string" } }, "title": "CanadaFields", "type": "object" }, "nz": { "description": "Country-wise regional fields for New Zealand", "properties": { "ird_number": { "description": "Inland Revenue Department (IRD) number for New Zealand employees.", "type": "string" } }, "title": "NewZealandFields", "type": "object" }, "us": { "description": "Country-wise regional fields for USA", "properties": { "ssn": { "description": "Social Security Number (SSN) for US employees.", "type": "string" } }, "title": "USFields", "type": "object" } }, "title": "CountryFields", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "custom_fields": { "description": "Custom field values defined on the Employee object for this worker\n\nExpandable field", "items": { "additionalProperties": {} }, "type": "array" }, "date_of_birth": { "description": "The worker's date of birth.", "type": "string" }, "department": { "description": "The worker's assigned department.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "department_hierarchy": { "description": "List of departments in the department hierarchy. Refer department_hierarchy_ids for department hierarchy order.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestDepartment" }, "type": "array" }, "department_hierarchy_id": { "description": "The identifier of departments in the department hierarchy ordered from parent department to child department.", "items": { "type": "string" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the department.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestDepartment", "description": "The parent department.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent department.", "type": "string" }, "reference_code": { "description": "Reference code of the department.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Department", "type": "object" }, "department_id": { "description": "The worker's assigned department.", "type": "string" }, "employment_type": { "description": "The worker's employment type.\n\nExpandable field", "properties": { "amount_worked": { "description": "The amount worked for the employment type. * `FULL-TIME`: Full-time is at least 30 hours per week. Full-time workers will typically be eligible for benefits. * `PART-TIME`: Part-time is less than 30 hours per week. These workers may be eligible for benefits, depending on company settings and hours worked. * `TEMPORARY`: These workers are hired on a temporary basis. You can specify how each worker with this employment type will be paid individually.", "type": "string" }, "compensation_time_period": { "description": "The compensation period for the employment type. * `SALARIED`: Employees that are paid a fixed amount per year. * `HOURLY`: Employees that are paid a wage per hour worked.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "label": { "description": "The display label of the employment type.", "type": "string" }, "name": { "description": "The name of the employment type for non-custom employment types.", "type": "string" }, "type": { "description": "The classification of the worker by the company. * `CONTRACTOR`: Contractors are self-employed workers who provide services on a short-term or per-project basis and are not eligible for tax-withholding or benefits. * `EMPLOYEE`: Employees are hired and managed by an employer, work under the employer's direct supervision and control, and are protected by law for wages and employment rights.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "label", "updated_at" ], "title": "CompanyEmploymentType", "type": "object" }, "employment_type_id": { "description": "The worker's employment type.", "type": "string" }, "end_date": { "description": "The end date of the worker.", "type": "string" }, "ethnicity": { "description": "The identified ethnicity of the worker, if specified.", "type": "string" }, "gender": { "description": "The gender of the worker, if specified.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_manager": { "description": "Whether the worker is a manager", "type": "boolean" }, "job_function": { "description": "The worker's job function. When expanded, this field requires `job-functions.read`.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "Displayed name of the job function", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "JobFunction", "type": "object" }, "job_function_id": { "description": "ID of the worker's job function.", "type": "string" }, "legal_entity": { "description": "The worker's associated legal entity.\n\nExpandable field", "properties": { "company": { "description": "The company or organization associated with the legal entity\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "doing_business_as_name": { "description": "The doing business as name for the company.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_entities": { "description": "A list of the company's entities.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestLegalEntity" }, "type": "array" }, "legal_entities_id": { "description": "A list of the company's entities.", "items": { "type": "string" }, "type": "array" }, "legal_name": { "description": "The legal name of the company.", "type": "string" }, "name": { "description": "The name of the company.", "type": "string" }, "parent_legal_entity": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The company's ultimate holding entity.\n\nExpandable field", "type": "object" }, "parent_legal_entity_id": { "description": "The company's ultimate holding entity.", "type": "string" }, "phone": { "description": "The phone number for the company.", "type": "string" }, "physical_address": { "description": "The physical address of the holding entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "primary_email": { "description": "The email address used when registering this company.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "legal_entities", "legal_entities_id", "name", "updated_at" ], "title": "Company", "type": "object" }, "company_id": { "description": "The company or organization associated with the legal entity", "type": "string" }, "country": { "description": "The country the legal entity is based in.", "properties": { "code": { "description": "The code of the country.", "type": "string" } }, "required": [ "code" ], "title": "Country", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "entity_level": { "description": "The legal entity's level in a hierarchy. * `PARENT`: The legal entity is considered the ultimate holding entity. * `SUBSIDIARY`: The legal entity is considered a subsidiary, fully or partially held by another. * `BRANCH`: The legal entity is considered a branch, associated with a parent legal entity.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_name": { "description": "The legal name of the legal entity.", "type": "string" }, "mailing_address": { "description": "The mailing address of the legal entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "management_type": { "description": "The legal entity management type in the case of an employer of record (EOR) or professional employment organization (PEO). * `PEO`: The legal entity is considered a Professional Employment Organization (PEO). * `EOR`: The legal entity is considered an Employer of Record (EOR).", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The parent legal entity.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent legal entity.", "type": "string" }, "physical_address": { "description": "The physical address of the legal entity, if it differs from the mailing address.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "registration_date": { "description": "The registration date of the entity.", "type": "string" }, "tax_identifier": { "description": "The tax identifier for the legal entity.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "LegalEntity", "type": "object" }, "legal_entity_id": { "description": "The worker's associated legal entity.", "type": "string" }, "level": { "description": "The level of the worker.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "description": { "description": "The description of the level.", "type": "string" }, "experience_requirements": { "description": "The experience requirements for the level.", "type": "string" }, "global_level": { "anyOf": [ { "description": "Global level is used to track the seniority of levels. The higher up a level is placed on the page, the more senior and higher-ranked the level. Global level is used in workflows, policies, and reports that use the level attribute (e.g., you can use Level Lookup to set up a workflow that notifies the nearest person in an worker's management chain at or above the specified level).", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the level. Must be unique within the company or organization.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLevel", "description": "The parent level.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent level.", "type": "string" }, "rank": { "anyOf": [ { "description": "The rank of the level within its track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "scope_of_responsibilities": { "description": "The scope of responsibilities for the level.", "type": "string" }, "track": { "description": "The track associated with the level, if it's not a global level.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_default": { "description": "Whether this is the company's default track.", "type": "boolean" }, "name": { "description": "The name of the track. Must be unique within the company or organization.", "type": "string" }, "order": { "anyOf": [ { "description": "The one-based horizontal display order of the track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "start_global_level": { "anyOf": [ { "description": "The highest global level occupied by this track. Empty tracks return null.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Track", "type": "object" }, "track_id": { "description": "The track associated with the level. Required during creation. Include global_level when changing it.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Level", "type": "object" }, "level_id": { "description": "The level of the worker.", "type": "string" }, "location": { "description": "The location that the worker is mapped to for tax purposes. In the case that a worker is remote, the location's type is remote.", "properties": { "type": { "description": "The type of location.", "type": "string" }, "work_location_id": { "description": "The work location, if the worker isn't remote.", "type": "string" } }, "required": [ "type", "work_location_id" ], "title": "WorkerLocation", "type": "object" }, "manager": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's manager.\n\nExpandable field", "type": "object" }, "manager_id": { "description": "The worker's manager.", "type": "string" }, "number": { "anyOf": [ { "description": "The worker's number within the organization.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "original_start_date": { "description": "The worker's earliest start date across their employment history, excluding INIT roles.", "type": "string" }, "overtime_exemption": { "description": "The worker's overtime exemption status.", "type": "string" }, "pay_schedule_id": { "description": "The ID of the pay schedule currently associated with the worker.", "type": "string" }, "personal_email": { "description": "The worker's associated personal email address.", "type": "string" }, "race": { "description": "The identified race of the worker, if specified.", "type": "string" }, "start_date": { "description": "The start date of the worker.", "type": "string" }, "status": { "description": "The worker's status within the organization.", "type": "string" }, "teams": { "description": "The worker's assigned teams.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiTeamcb26bc28f32f" }, "type": "array" }, "teams_id": { "description": "The worker's assigned teams.", "items": { "type": "string" }, "type": "array" }, "termination_details": { "description": "The details of the worker's termination, if applicable.", "properties": { "reason": { "description": "This is a description that will be custom to each Rippling company.", "type": "string" }, "type": { "description": "The termination type indicates whether the termination was voluntary or involuntary.", "type": "string" } }, "title": "TerminationDetails", "type": "object" }, "title": { "description": "The worker's title.", "type": "string" }, "title_effective_date": { "description": "Title effective date", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "user": { "description": "The worker's associated user.\n\nExpandable field", "properties": { "active": { "description": "Whether the user is able to access company resources, typically when they are in actively engaged with the company and not after off-boarding.", "type": "boolean" }, "addresses": { "description": "The user's addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiUserAddressedd59b9ba9a1" }, "type": "array" }, "created_at": { "description": "Record creation date", "type": "string" }, "display_name": { "description": "The display name of the user using either the concatenated preferred given and family name or username depending on availability.", "type": "string" }, "emails": { "description": "The user's email addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiEmail5284c8258dc3" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "locale": { "description": "The User's default location for purposes of localization of currency, date time format, or numerical representations pursuant to RFC5646.", "type": "string" }, "name": { "description": "The user's name.", "properties": { "family_name": { "description": "The legal family name of the user, or last name in most Western languages.", "type": "string" }, "formatted": { "description": "The user's full name.", "type": "string" }, "given_name": { "description": "The given legal name of the user, or first name in most Western languages.", "type": "string" }, "middle_name": { "description": "The middle name(s) of the user.", "type": "string" }, "preferred_family_name": { "description": "The preferred family name, or last name in most Western languages, by the user.", "type": "string" }, "preferred_given_name": { "description": "The preferred given name, or first name in most Western languages, by the user.", "type": "string" } }, "title": "UserName", "type": "object" }, "number": { "description": "The permanent profile number of the user.", "type": "string" }, "phone_numbers": { "description": "The user's phone numbers.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoneNumber12060c61ecf5" }, "type": "array" }, "photos": { "description": "The user's photos.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoto2be7c3ae3f39" }, "type": "array" }, "preferred_language": { "description": "The User's preferred written or spoken language in the same format of the HTTP Accept-Language header, pursuant to Section 5.3.5 of RFC7231.", "type": "string" }, "timezone": { "description": "The User's current time zone in IANA database Olson format", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "username": { "description": "The unique identifier across Rippling used by the User for direct authentication into their associated company. Globally unique.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "User", "type": "object" }, "user_id": { "description": "The worker's associated user.", "type": "string" }, "work_email": { "description": "The worker's associated work email address.", "type": "string" }, "work_schedule": { "additionalProperties": { "$ref": "#/components/schemas/OutputRestApiWorkScheduleDay938f88d94f20" }, "description": "The worker's scheduled working hours for each day of the week.", "type": "object" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Worker", "type": "object" }, "worker_id": { "description": "Identifier of the worker whose time split configuration this represents.", "type": "string" } }, "required": [ "created_at", "id", "updated_at", "worker_id" ], "title": "WorkerTimeSplit", "type": "object" }, "OutputRestApiWorkflowAuthoringCapabilities1717704c6e71": { "additionalProperties": false, "properties": { "mode": { "type": "string" }, "patchable_fields": { "items": { "type": "string" }, "type": "array" }, "reason_codes": { "items": { "type": "string" }, "type": "array" } }, "required": [ "mode", "patchable_fields", "reason_codes" ], "title": "WorkflowAuthoringCapabilities", "type": "object" }, "OutputRestApiWorkflowExecutionResource5317d9bed647": { "additionalProperties": false, "description": "A single execution of a workflow: one launch of the workflow's current published version, with a status to poll until it reaches a terminal value.", "properties": { "created_at": { "description": "When the workflow was launched, in UTC (ISO 8601).", "format": "date-time", "type": "string" }, "id": { "description": "Unique identifier for this workflow execution. Poll it with GET /workflows/{id}/executions/{execution_id}.", "type": "string" }, "status": { "description": "The execution status. Transitional values are `pending`, `in_progress`, `waiting_for_response`, and `cancellation_pending`; terminal values are `completed`, `failed`, and `cancelled`. Poll until the status reaches a terminal value.\n\n* `pending`: The execution is queued and has not started.\n* `in_progress`: The workflow is executing.\n* `waiting_for_response`: The execution is paused on a human input or approval step.\n* `cancellation_pending`: A cancellation was requested and is being applied.\n* `completed`: Every step finished successfully.\n* `failed`: The execution stopped on an error.\n* `cancelled`: The execution was cancelled before completing.\n* `unknown`: The status could not be mapped. Contact support if this persists.", "type": "string" }, "version_id": { "description": "The workflow version that ran. An execution always runs the workflow's current published version; the current version_id is available from GET /workflows/{id}.", "type": "string" }, "workflow_id": { "description": "The ID of the workflow this execution belongs to. Matches the {id} path parameter.", "type": "string" } }, "required": [ "created_at", "id", "status", "version_id", "workflow_id" ], "title": "WorkflowExecutionResource", "type": "object" }, "OutputRestApiWorkflowListResponse1248d6c05c53": { "additionalProperties": false, "properties": { "next_link": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "results": { "items": { "$ref": "#/components/schemas/OutputRestApiWorkflowSummary937a3bd62e22" }, "type": "array" } }, "required": [ "results" ], "title": "WorkflowListResponse", "type": "object" }, "OutputRestApiWorkflowResourceb390faffbef6": { "additionalProperties": false, "properties": { "authoring": { "$ref": "#/components/schemas/OutputRestApiWorkflowAuthoringCapabilities1717704c6e71" }, "created_at": { "format": "date-time", "type": "string" }, "definition": { "anyOf": [ { "$ref": "#/components/schemas/OutputRestApiEditableWorkflowDefinitiond9f9354f328c" }, { "$ref": "#/components/schemas/OutputRestApiReadOnlyWorkflowDefinitioncae0f7b70990" } ] }, "deletable": { "type": "boolean" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "enabled": { "type": "boolean" }, "has_draft": { "type": "boolean" }, "id": { "type": "string" }, "name": { "type": "string" }, "owner_id": { "type": "string" }, "status": { "type": "string" }, "updated_at": { "format": "date-time", "type": "string" }, "version_id": { "type": "string" } }, "required": [ "authoring", "created_at", "definition", "deletable", "enabled", "has_draft", "id", "name", "owner_id", "status", "updated_at", "version_id" ], "title": "WorkflowResource", "type": "object" }, "OutputRestApiWorkflowSummary937a3bd62e22": { "additionalProperties": false, "properties": { "created_at": { "format": "date-time", "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "enabled": { "type": "boolean" }, "has_draft": { "type": "boolean" }, "id": { "type": "string" }, "name": { "type": "string" }, "owner_id": { "type": "string" }, "status": { "type": "string" }, "updated_at": { "format": "date-time", "type": "string" }, "version_id": { "type": "string" } }, "required": [ "created_at", "description", "enabled", "has_draft", "id", "name", "owner_id", "status", "updated_at", "version_id" ], "title": "WorkflowSummary", "type": "object" }, "OutputRestBusinessPartner": { "description": "", "properties": { "business_partner_group": { "description": "Business partner group the business partner is a part of\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "default_business_partner": { "description": "Optional default business partner worker to whom all employees will be mapped if not explicitly mapped to a business partner in the group.\n\nExpandable field", "properties": { "business_partners": { "description": "Worker's assigned business partners. This field is only populated when explicitly requested via the expand parameter (e.g., ?expand=business_partners). When expanded, returns an empty list ([]) if the worker has no business partners.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestBusinessPartner" }, "type": "array" }, "business_partners_id": { "description": "Worker's assigned business partners unique identifiers. Returns an empty list ([]) if the worker has no business partners.", "items": { "type": "string" }, "type": "array" }, "citizenship": { "description": "The countries that the worker has citizenship in.", "type": "string" }, "compensation": { "description": "The compensation package for the worker.\n\nExpandable field", "properties": { "annual_compensation": { "description": "The worker's annual compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "annual_salary_equivalent": { "description": "The worker's annual salary equivalent, for insurance purposes. It will be equal to the worker's annual compensation, except for owners that are receiving no cashcompensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "bonus_schedule": { "description": "The worker's bonus schedule.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "hourly_wage": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "id": { "description": "Identifier field", "type": "string" }, "monthly_compensation": { "description": "The worker's monthly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "on_target_commission": { "description": "The worker's on-target commission.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "payment_terms": { "description": "The payment terms for an worker's compensation.", "type": "string" }, "payment_type": { "description": "The payment type for an worker's compensation.", "type": "string" }, "relocation_reimbursement": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "salary_effective_date": { "description": "Salary effective date", "type": "string" }, "signing_bonus": { "description": "The worker's signing bonus.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus": { "description": "The worker's target annual bonus amount.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus_percent": { "anyOf": [ { "description": "The worker's target annual bonus as a percent of annual compensation.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" }, "weekly_compensation": { "description": "The worker's weekly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "worker": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's details.\n\nExpandable field", "type": "object" }, "worker_id": { "description": "The worker's ID.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Compensation", "type": "object" }, "compensation_grade": { "description": "The compensation grade assigned to the worker, if any.", "properties": { "id": { "description": "The compensation grade's unique identifier.", "type": "string" }, "label": { "description": "The compensation grade's label.", "type": "string" } }, "title": "WorkerCompensationGrade", "type": "object" }, "compensation_id": { "description": "The compensation package for the worker.", "type": "string" }, "country": { "description": "The worker's country.", "type": "string" }, "country_fields": { "description": "Country level fields for the worker.", "properties": { "ca": { "description": "Country-wise regional fields for Canada", "properties": { "sin": { "description": "Social Insurance Number (SIN) for Canada employees.", "type": "string" } }, "title": "CanadaFields", "type": "object" }, "nz": { "description": "Country-wise regional fields for New Zealand", "properties": { "ird_number": { "description": "Inland Revenue Department (IRD) number for New Zealand employees.", "type": "string" } }, "title": "NewZealandFields", "type": "object" }, "us": { "description": "Country-wise regional fields for USA", "properties": { "ssn": { "description": "Social Security Number (SSN) for US employees.", "type": "string" } }, "title": "USFields", "type": "object" } }, "title": "CountryFields", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "custom_fields": { "description": "Custom field values defined on the Employee object for this worker\n\nExpandable field", "items": { "additionalProperties": {} }, "type": "array" }, "date_of_birth": { "description": "The worker's date of birth.", "type": "string" }, "department": { "description": "The worker's assigned department.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "department_hierarchy": { "description": "List of departments in the department hierarchy. Refer department_hierarchy_ids for department hierarchy order.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestDepartment" }, "type": "array" }, "department_hierarchy_id": { "description": "The identifier of departments in the department hierarchy ordered from parent department to child department.", "items": { "type": "string" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the department.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestDepartment", "description": "The parent department.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent department.", "type": "string" }, "reference_code": { "description": "Reference code of the department.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Department", "type": "object" }, "department_id": { "description": "The worker's assigned department.", "type": "string" }, "employment_type": { "description": "The worker's employment type.\n\nExpandable field", "properties": { "amount_worked": { "description": "The amount worked for the employment type. * `FULL-TIME`: Full-time is at least 30 hours per week. Full-time workers will typically be eligible for benefits. * `PART-TIME`: Part-time is less than 30 hours per week. These workers may be eligible for benefits, depending on company settings and hours worked. * `TEMPORARY`: These workers are hired on a temporary basis. You can specify how each worker with this employment type will be paid individually.", "type": "string" }, "compensation_time_period": { "description": "The compensation period for the employment type. * `SALARIED`: Employees that are paid a fixed amount per year. * `HOURLY`: Employees that are paid a wage per hour worked.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "label": { "description": "The display label of the employment type.", "type": "string" }, "name": { "description": "The name of the employment type for non-custom employment types.", "type": "string" }, "type": { "description": "The classification of the worker by the company. * `CONTRACTOR`: Contractors are self-employed workers who provide services on a short-term or per-project basis and are not eligible for tax-withholding or benefits. * `EMPLOYEE`: Employees are hired and managed by an employer, work under the employer's direct supervision and control, and are protected by law for wages and employment rights.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "label", "updated_at" ], "title": "CompanyEmploymentType", "type": "object" }, "employment_type_id": { "description": "The worker's employment type.", "type": "string" }, "end_date": { "description": "The end date of the worker.", "type": "string" }, "ethnicity": { "description": "The identified ethnicity of the worker, if specified.", "type": "string" }, "gender": { "description": "The gender of the worker, if specified.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_manager": { "description": "Whether the worker is a manager", "type": "boolean" }, "job_function": { "description": "The worker's job function. When expanded, this field requires `job-functions.read`.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "Displayed name of the job function", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "JobFunction", "type": "object" }, "job_function_id": { "description": "ID of the worker's job function.", "type": "string" }, "legal_entity": { "description": "The worker's associated legal entity.\n\nExpandable field", "properties": { "company": { "description": "The company or organization associated with the legal entity\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "doing_business_as_name": { "description": "The doing business as name for the company.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_entities": { "description": "A list of the company's entities.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestLegalEntity" }, "type": "array" }, "legal_entities_id": { "description": "A list of the company's entities.", "items": { "type": "string" }, "type": "array" }, "legal_name": { "description": "The legal name of the company.", "type": "string" }, "name": { "description": "The name of the company.", "type": "string" }, "parent_legal_entity": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The company's ultimate holding entity.\n\nExpandable field", "type": "object" }, "parent_legal_entity_id": { "description": "The company's ultimate holding entity.", "type": "string" }, "phone": { "description": "The phone number for the company.", "type": "string" }, "physical_address": { "description": "The physical address of the holding entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "primary_email": { "description": "The email address used when registering this company.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "legal_entities", "legal_entities_id", "name", "updated_at" ], "title": "Company", "type": "object" }, "company_id": { "description": "The company or organization associated with the legal entity", "type": "string" }, "country": { "description": "The country the legal entity is based in.", "properties": { "code": { "description": "The code of the country.", "type": "string" } }, "required": [ "code" ], "title": "Country", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "entity_level": { "description": "The legal entity's level in a hierarchy. * `PARENT`: The legal entity is considered the ultimate holding entity. * `SUBSIDIARY`: The legal entity is considered a subsidiary, fully or partially held by another. * `BRANCH`: The legal entity is considered a branch, associated with a parent legal entity.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_name": { "description": "The legal name of the legal entity.", "type": "string" }, "mailing_address": { "description": "The mailing address of the legal entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "management_type": { "description": "The legal entity management type in the case of an employer of record (EOR) or professional employment organization (PEO). * `PEO`: The legal entity is considered a Professional Employment Organization (PEO). * `EOR`: The legal entity is considered an Employer of Record (EOR).", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The parent legal entity.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent legal entity.", "type": "string" }, "physical_address": { "description": "The physical address of the legal entity, if it differs from the mailing address.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "registration_date": { "description": "The registration date of the entity.", "type": "string" }, "tax_identifier": { "description": "The tax identifier for the legal entity.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "LegalEntity", "type": "object" }, "legal_entity_id": { "description": "The worker's associated legal entity.", "type": "string" }, "level": { "description": "The level of the worker.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "description": { "description": "The description of the level.", "type": "string" }, "experience_requirements": { "description": "The experience requirements for the level.", "type": "string" }, "global_level": { "anyOf": [ { "description": "Global level is used to track the seniority of levels. The higher up a level is placed on the page, the more senior and higher-ranked the level. Global level is used in workflows, policies, and reports that use the level attribute (e.g., you can use Level Lookup to set up a workflow that notifies the nearest person in an worker's management chain at or above the specified level).", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the level. Must be unique within the company or organization.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLevel", "description": "The parent level.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent level.", "type": "string" }, "rank": { "anyOf": [ { "description": "The rank of the level within its track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "scope_of_responsibilities": { "description": "The scope of responsibilities for the level.", "type": "string" }, "track": { "description": "The track associated with the level, if it's not a global level.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_default": { "description": "Whether this is the company's default track.", "type": "boolean" }, "name": { "description": "The name of the track. Must be unique within the company or organization.", "type": "string" }, "order": { "anyOf": [ { "description": "The one-based horizontal display order of the track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "start_global_level": { "anyOf": [ { "description": "The highest global level occupied by this track. Empty tracks return null.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Track", "type": "object" }, "track_id": { "description": "The track associated with the level. Required during creation. Include global_level when changing it.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Level", "type": "object" }, "level_id": { "description": "The level of the worker.", "type": "string" }, "location": { "description": "The location that the worker is mapped to for tax purposes. In the case that a worker is remote, the location's type is remote.", "properties": { "type": { "description": "The type of location.", "type": "string" }, "work_location_id": { "description": "The work location, if the worker isn't remote.", "type": "string" } }, "required": [ "type", "work_location_id" ], "title": "WorkerLocation", "type": "object" }, "manager": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's manager.\n\nExpandable field", "type": "object" }, "manager_id": { "description": "The worker's manager.", "type": "string" }, "number": { "anyOf": [ { "description": "The worker's number within the organization.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "original_start_date": { "description": "The worker's earliest start date across their employment history, excluding INIT roles.", "type": "string" }, "overtime_exemption": { "description": "The worker's overtime exemption status.", "type": "string" }, "pay_schedule_id": { "description": "The ID of the pay schedule currently associated with the worker.", "type": "string" }, "personal_email": { "description": "The worker's associated personal email address.", "type": "string" }, "race": { "description": "The identified race of the worker, if specified.", "type": "string" }, "start_date": { "description": "The start date of the worker.", "type": "string" }, "status": { "description": "The worker's status within the organization.", "type": "string" }, "teams": { "description": "The worker's assigned teams.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestTeamcb26bc28f32f" }, "type": "array" }, "teams_id": { "description": "The worker's assigned teams.", "items": { "type": "string" }, "type": "array" }, "termination_details": { "description": "The details of the worker's termination, if applicable.", "properties": { "reason": { "description": "This is a description that will be custom to each Rippling company.", "type": "string" }, "type": { "description": "The termination type indicates whether the termination was voluntary or involuntary.", "type": "string" } }, "title": "TerminationDetails", "type": "object" }, "title": { "description": "The worker's title.", "type": "string" }, "title_effective_date": { "description": "Title effective date", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "user": { "description": "The worker's associated user.\n\nExpandable field", "properties": { "active": { "description": "Whether the user is able to access company resources, typically when they are in actively engaged with the company and not after off-boarding.", "type": "boolean" }, "addresses": { "description": "The user's addresses.", "items": { "$ref": "#/components/schemas/OutputRestUserAddressedd59b9ba9a1" }, "type": "array" }, "created_at": { "description": "Record creation date", "type": "string" }, "display_name": { "description": "The display name of the user using either the concatenated preferred given and family name or username depending on availability.", "type": "string" }, "emails": { "description": "The user's email addresses.", "items": { "$ref": "#/components/schemas/OutputRestEmail5284c8258dc3" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "locale": { "description": "The User's default location for purposes of localization of currency, date time format, or numerical representations pursuant to RFC5646.", "type": "string" }, "name": { "description": "The user's name.", "properties": { "family_name": { "description": "The legal family name of the user, or last name in most Western languages.", "type": "string" }, "formatted": { "description": "The user's full name.", "type": "string" }, "given_name": { "description": "The given legal name of the user, or first name in most Western languages.", "type": "string" }, "middle_name": { "description": "The middle name(s) of the user.", "type": "string" }, "preferred_family_name": { "description": "The preferred family name, or last name in most Western languages, by the user.", "type": "string" }, "preferred_given_name": { "description": "The preferred given name, or first name in most Western languages, by the user.", "type": "string" } }, "title": "UserName", "type": "object" }, "number": { "description": "The permanent profile number of the user.", "type": "string" }, "phone_numbers": { "description": "The user's phone numbers.", "items": { "$ref": "#/components/schemas/OutputRestUserPhoneNumber12060c61ecf5" }, "type": "array" }, "photos": { "description": "The user's photos.", "items": { "$ref": "#/components/schemas/OutputRestUserPhoto2be7c3ae3f39" }, "type": "array" }, "preferred_language": { "description": "The User's preferred written or spoken language in the same format of the HTTP Accept-Language header, pursuant to Section 5.3.5 of RFC7231.", "type": "string" }, "timezone": { "description": "The User's current time zone in IANA database Olson format", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "username": { "description": "The unique identifier across Rippling used by the User for direct authentication into their associated company. Globally unique.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "User", "type": "object" }, "user_id": { "description": "The worker's associated user.", "type": "string" }, "work_email": { "description": "The worker's associated work email address.", "type": "string" }, "work_schedule": { "additionalProperties": { "$ref": "#/components/schemas/OutputRestWorkScheduleDay938f88d94f20" }, "description": "The worker's scheduled working hours for each day of the week.", "type": "object" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Worker", "type": "object" }, "default_business_partner_id": { "description": "Id of Optional default business partner worker to whom all employees will be mapped if not explicitly mapped to a business partner in the group.", "type": "string" }, "domain": { "description": "Type of business partner group", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "Name used to identify business partner group", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "BusinessPartnerGroup", "type": "object" }, "business_partner_group_id": { "description": "Identifier of business partner group the business parter is a part of", "type": "string" }, "client_group": { "description": "Group of workers associated with the business partner\n\nExpandable field", "properties": { "allow_non_employees": { "description": "Whether the group allows non employees", "type": "boolean" }, "app_owner_id": { "description": "The id of the group's app owner.", "type": "string" }, "can_override_role_states": { "description": "Whether the group can override role states", "type": "boolean" }, "created_at": { "description": "Record creation date", "type": "string" }, "cumulatively_exhaustive_default": { "description": "Whether the group is the cumulatively exhaustive default", "type": "boolean" }, "description": { "description": "The group's description.", "type": "string" }, "display_name": { "description": "The group's display name.", "type": "string" }, "group_type": { "description": "The group type", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "ignore_prov_group_matching": { "description": "Whether to ignore provisioning group matching when determining group membership", "type": "boolean" }, "include_terminated": { "description": "Whether the group include terminated roles", "type": "boolean" }, "is_invisible": { "description": "Whether the group is invisible", "type": "boolean" }, "mutually_exclusive_key": { "description": "The group's mutually exclusive key", "type": "string" }, "name": { "description": "The group's name.", "type": "string" }, "parent": { "description": "The group's parent.", "type": "string" }, "priority": { "anyOf": [ { "description": "The group's priority when calculating mutual exclusivity", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "read_only": { "description": "Whether the group is read only.", "type": "boolean" }, "sub_group_type": { "description": "The sub group type", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Supergroup", "type": "object" }, "client_group_id": { "description": "Identifier of group of workers associated with the business partner", "type": "string" }, "client_group_member_count": { "anyOf": [ { "description": "Number of workers associated with the business partner", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "worker": { "description": "Worker who is the business partner\n\nExpandable field", "properties": { "business_partners": { "description": "Worker's assigned business partners. This field is only populated when explicitly requested via the expand parameter (e.g., ?expand=business_partners). When expanded, returns an empty list ([]) if the worker has no business partners.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestBusinessPartner" }, "type": "array" }, "business_partners_id": { "description": "Worker's assigned business partners unique identifiers. Returns an empty list ([]) if the worker has no business partners.", "items": { "type": "string" }, "type": "array" }, "citizenship": { "description": "The countries that the worker has citizenship in.", "type": "string" }, "compensation": { "description": "The compensation package for the worker.\n\nExpandable field", "properties": { "annual_compensation": { "description": "The worker's annual compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "annual_salary_equivalent": { "description": "The worker's annual salary equivalent, for insurance purposes. It will be equal to the worker's annual compensation, except for owners that are receiving no cashcompensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "bonus_schedule": { "description": "The worker's bonus schedule.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "hourly_wage": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "id": { "description": "Identifier field", "type": "string" }, "monthly_compensation": { "description": "The worker's monthly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "on_target_commission": { "description": "The worker's on-target commission.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "payment_terms": { "description": "The payment terms for an worker's compensation.", "type": "string" }, "payment_type": { "description": "The payment type for an worker's compensation.", "type": "string" }, "relocation_reimbursement": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "salary_effective_date": { "description": "Salary effective date", "type": "string" }, "signing_bonus": { "description": "The worker's signing bonus.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus": { "description": "The worker's target annual bonus amount.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus_percent": { "anyOf": [ { "description": "The worker's target annual bonus as a percent of annual compensation.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" }, "weekly_compensation": { "description": "The worker's weekly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "worker": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's details.\n\nExpandable field", "type": "object" }, "worker_id": { "description": "The worker's ID.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Compensation", "type": "object" }, "compensation_grade": { "description": "The compensation grade assigned to the worker, if any.", "properties": { "id": { "description": "The compensation grade's unique identifier.", "type": "string" }, "label": { "description": "The compensation grade's label.", "type": "string" } }, "title": "WorkerCompensationGrade", "type": "object" }, "compensation_id": { "description": "The compensation package for the worker.", "type": "string" }, "country": { "description": "The worker's country.", "type": "string" }, "country_fields": { "description": "Country level fields for the worker.", "properties": { "ca": { "description": "Country-wise regional fields for Canada", "properties": { "sin": { "description": "Social Insurance Number (SIN) for Canada employees.", "type": "string" } }, "title": "CanadaFields", "type": "object" }, "nz": { "description": "Country-wise regional fields for New Zealand", "properties": { "ird_number": { "description": "Inland Revenue Department (IRD) number for New Zealand employees.", "type": "string" } }, "title": "NewZealandFields", "type": "object" }, "us": { "description": "Country-wise regional fields for USA", "properties": { "ssn": { "description": "Social Security Number (SSN) for US employees.", "type": "string" } }, "title": "USFields", "type": "object" } }, "title": "CountryFields", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "custom_fields": { "description": "Custom field values defined on the Employee object for this worker\n\nExpandable field", "items": { "additionalProperties": {} }, "type": "array" }, "date_of_birth": { "description": "The worker's date of birth.", "type": "string" }, "department": { "description": "The worker's assigned department.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "department_hierarchy": { "description": "List of departments in the department hierarchy. Refer department_hierarchy_ids for department hierarchy order.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestDepartment" }, "type": "array" }, "department_hierarchy_id": { "description": "The identifier of departments in the department hierarchy ordered from parent department to child department.", "items": { "type": "string" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the department.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestDepartment", "description": "The parent department.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent department.", "type": "string" }, "reference_code": { "description": "Reference code of the department.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Department", "type": "object" }, "department_id": { "description": "The worker's assigned department.", "type": "string" }, "employment_type": { "description": "The worker's employment type.\n\nExpandable field", "properties": { "amount_worked": { "description": "The amount worked for the employment type. * `FULL-TIME`: Full-time is at least 30 hours per week. Full-time workers will typically be eligible for benefits. * `PART-TIME`: Part-time is less than 30 hours per week. These workers may be eligible for benefits, depending on company settings and hours worked. * `TEMPORARY`: These workers are hired on a temporary basis. You can specify how each worker with this employment type will be paid individually.", "type": "string" }, "compensation_time_period": { "description": "The compensation period for the employment type. * `SALARIED`: Employees that are paid a fixed amount per year. * `HOURLY`: Employees that are paid a wage per hour worked.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "label": { "description": "The display label of the employment type.", "type": "string" }, "name": { "description": "The name of the employment type for non-custom employment types.", "type": "string" }, "type": { "description": "The classification of the worker by the company. * `CONTRACTOR`: Contractors are self-employed workers who provide services on a short-term or per-project basis and are not eligible for tax-withholding or benefits. * `EMPLOYEE`: Employees are hired and managed by an employer, work under the employer's direct supervision and control, and are protected by law for wages and employment rights.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "label", "updated_at" ], "title": "CompanyEmploymentType", "type": "object" }, "employment_type_id": { "description": "The worker's employment type.", "type": "string" }, "end_date": { "description": "The end date of the worker.", "type": "string" }, "ethnicity": { "description": "The identified ethnicity of the worker, if specified.", "type": "string" }, "gender": { "description": "The gender of the worker, if specified.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_manager": { "description": "Whether the worker is a manager", "type": "boolean" }, "job_function": { "description": "The worker's job function. When expanded, this field requires `job-functions.read`.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "Displayed name of the job function", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "JobFunction", "type": "object" }, "job_function_id": { "description": "ID of the worker's job function.", "type": "string" }, "legal_entity": { "description": "The worker's associated legal entity.\n\nExpandable field", "properties": { "company": { "description": "The company or organization associated with the legal entity\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "doing_business_as_name": { "description": "The doing business as name for the company.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_entities": { "description": "A list of the company's entities.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestLegalEntity" }, "type": "array" }, "legal_entities_id": { "description": "A list of the company's entities.", "items": { "type": "string" }, "type": "array" }, "legal_name": { "description": "The legal name of the company.", "type": "string" }, "name": { "description": "The name of the company.", "type": "string" }, "parent_legal_entity": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The company's ultimate holding entity.\n\nExpandable field", "type": "object" }, "parent_legal_entity_id": { "description": "The company's ultimate holding entity.", "type": "string" }, "phone": { "description": "The phone number for the company.", "type": "string" }, "physical_address": { "description": "The physical address of the holding entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "primary_email": { "description": "The email address used when registering this company.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "legal_entities", "legal_entities_id", "name", "updated_at" ], "title": "Company", "type": "object" }, "company_id": { "description": "The company or organization associated with the legal entity", "type": "string" }, "country": { "description": "The country the legal entity is based in.", "properties": { "code": { "description": "The code of the country.", "type": "string" } }, "required": [ "code" ], "title": "Country", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "entity_level": { "description": "The legal entity's level in a hierarchy. * `PARENT`: The legal entity is considered the ultimate holding entity. * `SUBSIDIARY`: The legal entity is considered a subsidiary, fully or partially held by another. * `BRANCH`: The legal entity is considered a branch, associated with a parent legal entity.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_name": { "description": "The legal name of the legal entity.", "type": "string" }, "mailing_address": { "description": "The mailing address of the legal entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "management_type": { "description": "The legal entity management type in the case of an employer of record (EOR) or professional employment organization (PEO). * `PEO`: The legal entity is considered a Professional Employment Organization (PEO). * `EOR`: The legal entity is considered an Employer of Record (EOR).", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The parent legal entity.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent legal entity.", "type": "string" }, "physical_address": { "description": "The physical address of the legal entity, if it differs from the mailing address.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "registration_date": { "description": "The registration date of the entity.", "type": "string" }, "tax_identifier": { "description": "The tax identifier for the legal entity.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "LegalEntity", "type": "object" }, "legal_entity_id": { "description": "The worker's associated legal entity.", "type": "string" }, "level": { "description": "The level of the worker.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "description": { "description": "The description of the level.", "type": "string" }, "experience_requirements": { "description": "The experience requirements for the level.", "type": "string" }, "global_level": { "anyOf": [ { "description": "Global level is used to track the seniority of levels. The higher up a level is placed on the page, the more senior and higher-ranked the level. Global level is used in workflows, policies, and reports that use the level attribute (e.g., you can use Level Lookup to set up a workflow that notifies the nearest person in an worker's management chain at or above the specified level).", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the level. Must be unique within the company or organization.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLevel", "description": "The parent level.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent level.", "type": "string" }, "rank": { "anyOf": [ { "description": "The rank of the level within its track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "scope_of_responsibilities": { "description": "The scope of responsibilities for the level.", "type": "string" }, "track": { "description": "The track associated with the level, if it's not a global level.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_default": { "description": "Whether this is the company's default track.", "type": "boolean" }, "name": { "description": "The name of the track. Must be unique within the company or organization.", "type": "string" }, "order": { "anyOf": [ { "description": "The one-based horizontal display order of the track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "start_global_level": { "anyOf": [ { "description": "The highest global level occupied by this track. Empty tracks return null.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Track", "type": "object" }, "track_id": { "description": "The track associated with the level. Required during creation. Include global_level when changing it.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Level", "type": "object" }, "level_id": { "description": "The level of the worker.", "type": "string" }, "location": { "description": "The location that the worker is mapped to for tax purposes. In the case that a worker is remote, the location's type is remote.", "properties": { "type": { "description": "The type of location.", "type": "string" }, "work_location_id": { "description": "The work location, if the worker isn't remote.", "type": "string" } }, "required": [ "type", "work_location_id" ], "title": "WorkerLocation", "type": "object" }, "manager": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's manager.\n\nExpandable field", "type": "object" }, "manager_id": { "description": "The worker's manager.", "type": "string" }, "number": { "anyOf": [ { "description": "The worker's number within the organization.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "original_start_date": { "description": "The worker's earliest start date across their employment history, excluding INIT roles.", "type": "string" }, "overtime_exemption": { "description": "The worker's overtime exemption status.", "type": "string" }, "pay_schedule_id": { "description": "The ID of the pay schedule currently associated with the worker.", "type": "string" }, "personal_email": { "description": "The worker's associated personal email address.", "type": "string" }, "race": { "description": "The identified race of the worker, if specified.", "type": "string" }, "start_date": { "description": "The start date of the worker.", "type": "string" }, "status": { "description": "The worker's status within the organization.", "type": "string" }, "teams": { "description": "The worker's assigned teams.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestTeamcb26bc28f32f" }, "type": "array" }, "teams_id": { "description": "The worker's assigned teams.", "items": { "type": "string" }, "type": "array" }, "termination_details": { "description": "The details of the worker's termination, if applicable.", "properties": { "reason": { "description": "This is a description that will be custom to each Rippling company.", "type": "string" }, "type": { "description": "The termination type indicates whether the termination was voluntary or involuntary.", "type": "string" } }, "title": "TerminationDetails", "type": "object" }, "title": { "description": "The worker's title.", "type": "string" }, "title_effective_date": { "description": "Title effective date", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "user": { "description": "The worker's associated user.\n\nExpandable field", "properties": { "active": { "description": "Whether the user is able to access company resources, typically when they are in actively engaged with the company and not after off-boarding.", "type": "boolean" }, "addresses": { "description": "The user's addresses.", "items": { "$ref": "#/components/schemas/OutputRestUserAddressedd59b9ba9a1" }, "type": "array" }, "created_at": { "description": "Record creation date", "type": "string" }, "display_name": { "description": "The display name of the user using either the concatenated preferred given and family name or username depending on availability.", "type": "string" }, "emails": { "description": "The user's email addresses.", "items": { "$ref": "#/components/schemas/OutputRestEmail5284c8258dc3" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "locale": { "description": "The User's default location for purposes of localization of currency, date time format, or numerical representations pursuant to RFC5646.", "type": "string" }, "name": { "description": "The user's name.", "properties": { "family_name": { "description": "The legal family name of the user, or last name in most Western languages.", "type": "string" }, "formatted": { "description": "The user's full name.", "type": "string" }, "given_name": { "description": "The given legal name of the user, or first name in most Western languages.", "type": "string" }, "middle_name": { "description": "The middle name(s) of the user.", "type": "string" }, "preferred_family_name": { "description": "The preferred family name, or last name in most Western languages, by the user.", "type": "string" }, "preferred_given_name": { "description": "The preferred given name, or first name in most Western languages, by the user.", "type": "string" } }, "title": "UserName", "type": "object" }, "number": { "description": "The permanent profile number of the user.", "type": "string" }, "phone_numbers": { "description": "The user's phone numbers.", "items": { "$ref": "#/components/schemas/OutputRestUserPhoneNumber12060c61ecf5" }, "type": "array" }, "photos": { "description": "The user's photos.", "items": { "$ref": "#/components/schemas/OutputRestUserPhoto2be7c3ae3f39" }, "type": "array" }, "preferred_language": { "description": "The User's preferred written or spoken language in the same format of the HTTP Accept-Language header, pursuant to Section 5.3.5 of RFC7231.", "type": "string" }, "timezone": { "description": "The User's current time zone in IANA database Olson format", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "username": { "description": "The unique identifier across Rippling used by the User for direct authentication into their associated company. Globally unique.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "User", "type": "object" }, "user_id": { "description": "The worker's associated user.", "type": "string" }, "work_email": { "description": "The worker's associated work email address.", "type": "string" }, "work_schedule": { "additionalProperties": { "$ref": "#/components/schemas/OutputRestWorkScheduleDay938f88d94f20" }, "description": "The worker's scheduled working hours for each day of the week.", "type": "object" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Worker", "type": "object" }, "worker_id": { "description": "Identifier of worker who is the business partner", "type": "string" } }, "required": [ "business_partner_group_id", "created_at", "id", "updated_at", "worker_id" ], "title": "BusinessPartner", "type": "object" }, "OutputRestBusinessPartner01691db528c5": { "description": "", "properties": { "business_partner_group": { "$ref": "#/components/schemas/OutputRestBusinessPartnerGroup", "description": "Business partner group the business partner is a part of\n\nExpandable field", "type": "object" }, "business_partner_group_id": { "description": "Identifier of business partner group the business parter is a part of", "type": "string" }, "client_group": { "description": "Group of workers associated with the business partner\n\nExpandable field", "properties": { "allow_non_employees": { "description": "Whether the group allows non employees", "type": "boolean" }, "app_owner_id": { "description": "The id of the group's app owner.", "type": "string" }, "can_override_role_states": { "description": "Whether the group can override role states", "type": "boolean" }, "created_at": { "description": "Record creation date", "type": "string" }, "cumulatively_exhaustive_default": { "description": "Whether the group is the cumulatively exhaustive default", "type": "boolean" }, "description": { "description": "The group's description.", "type": "string" }, "display_name": { "description": "The group's display name.", "type": "string" }, "group_type": { "description": "The group type", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "ignore_prov_group_matching": { "description": "Whether to ignore provisioning group matching when determining group membership", "type": "boolean" }, "include_terminated": { "description": "Whether the group include terminated roles", "type": "boolean" }, "is_invisible": { "description": "Whether the group is invisible", "type": "boolean" }, "mutually_exclusive_key": { "description": "The group's mutually exclusive key", "type": "string" }, "name": { "description": "The group's name.", "type": "string" }, "parent": { "description": "The group's parent.", "type": "string" }, "priority": { "anyOf": [ { "description": "The group's priority when calculating mutual exclusivity", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "read_only": { "description": "Whether the group is read only.", "type": "boolean" }, "sub_group_type": { "description": "The sub group type", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Supergroup", "type": "object" }, "client_group_id": { "description": "Identifier of group of workers associated with the business partner", "type": "string" }, "client_group_member_count": { "anyOf": [ { "description": "Number of workers associated with the business partner", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "worker": { "$ref": "#/components/schemas/OutputRestWorker", "description": "Worker who is the business partner\n\nExpandable field", "type": "object" }, "worker_id": { "description": "Identifier of worker who is the business partner", "type": "string" } }, "required": [ "business_partner_group_id", "created_at", "id", "updated_at", "worker_id" ], "title": "BusinessPartner", "type": "object" }, "OutputRestBusinessPartner77b00a069c32": { "description": "", "properties": { "business_partner_group": { "description": "Business partner group the business partner is a part of\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "default_business_partner": { "$ref": "#/components/schemas/OutputRestWorker", "description": "Optional default business partner worker to whom all employees will be mapped if not explicitly mapped to a business partner in the group.\n\nExpandable field", "type": "object" }, "default_business_partner_id": { "description": "Id of Optional default business partner worker to whom all employees will be mapped if not explicitly mapped to a business partner in the group.", "type": "string" }, "domain": { "description": "Type of business partner group", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "Name used to identify business partner group", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "BusinessPartnerGroup", "type": "object" }, "business_partner_group_id": { "description": "Identifier of business partner group the business parter is a part of", "type": "string" }, "client_group": { "description": "Group of workers associated with the business partner\n\nExpandable field", "properties": { "allow_non_employees": { "description": "Whether the group allows non employees", "type": "boolean" }, "app_owner_id": { "description": "The id of the group's app owner.", "type": "string" }, "can_override_role_states": { "description": "Whether the group can override role states", "type": "boolean" }, "created_at": { "description": "Record creation date", "type": "string" }, "cumulatively_exhaustive_default": { "description": "Whether the group is the cumulatively exhaustive default", "type": "boolean" }, "description": { "description": "The group's description.", "type": "string" }, "display_name": { "description": "The group's display name.", "type": "string" }, "group_type": { "description": "The group type", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "ignore_prov_group_matching": { "description": "Whether to ignore provisioning group matching when determining group membership", "type": "boolean" }, "include_terminated": { "description": "Whether the group include terminated roles", "type": "boolean" }, "is_invisible": { "description": "Whether the group is invisible", "type": "boolean" }, "mutually_exclusive_key": { "description": "The group's mutually exclusive key", "type": "string" }, "name": { "description": "The group's name.", "type": "string" }, "parent": { "description": "The group's parent.", "type": "string" }, "priority": { "anyOf": [ { "description": "The group's priority when calculating mutual exclusivity", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "read_only": { "description": "Whether the group is read only.", "type": "boolean" }, "sub_group_type": { "description": "The sub group type", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Supergroup", "type": "object" }, "client_group_id": { "description": "Identifier of group of workers associated with the business partner", "type": "string" }, "client_group_member_count": { "anyOf": [ { "description": "Number of workers associated with the business partner", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "worker": { "$ref": "#/components/schemas/OutputRestWorker", "description": "Worker who is the business partner\n\nExpandable field", "type": "object" }, "worker_id": { "description": "Identifier of worker who is the business partner", "type": "string" } }, "required": [ "business_partner_group_id", "created_at", "id", "updated_at", "worker_id" ], "title": "BusinessPartner", "type": "object" }, "OutputRestBusinessPartnerGroup": { "description": "", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "default_business_partner": { "description": "Optional default business partner worker to whom all employees will be mapped if not explicitly mapped to a business partner in the group.\n\nExpandable field", "properties": { "business_partners": { "description": "Worker's assigned business partners. This field is only populated when explicitly requested via the expand parameter (e.g., ?expand=business_partners). When expanded, returns an empty list ([]) if the worker has no business partners.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestBusinessPartner01691db528c5" }, "type": "array" }, "business_partners_id": { "description": "Worker's assigned business partners unique identifiers. Returns an empty list ([]) if the worker has no business partners.", "items": { "type": "string" }, "type": "array" }, "citizenship": { "description": "The countries that the worker has citizenship in.", "type": "string" }, "compensation": { "description": "The compensation package for the worker.\n\nExpandable field", "properties": { "annual_compensation": { "description": "The worker's annual compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "annual_salary_equivalent": { "description": "The worker's annual salary equivalent, for insurance purposes. It will be equal to the worker's annual compensation, except for owners that are receiving no cashcompensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "bonus_schedule": { "description": "The worker's bonus schedule.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "hourly_wage": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "id": { "description": "Identifier field", "type": "string" }, "monthly_compensation": { "description": "The worker's monthly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "on_target_commission": { "description": "The worker's on-target commission.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "payment_terms": { "description": "The payment terms for an worker's compensation.", "type": "string" }, "payment_type": { "description": "The payment type for an worker's compensation.", "type": "string" }, "relocation_reimbursement": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "salary_effective_date": { "description": "Salary effective date", "type": "string" }, "signing_bonus": { "description": "The worker's signing bonus.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus": { "description": "The worker's target annual bonus amount.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus_percent": { "anyOf": [ { "description": "The worker's target annual bonus as a percent of annual compensation.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" }, "weekly_compensation": { "description": "The worker's weekly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "worker": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's details.\n\nExpandable field", "type": "object" }, "worker_id": { "description": "The worker's ID.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Compensation", "type": "object" }, "compensation_grade": { "description": "The compensation grade assigned to the worker, if any.", "properties": { "id": { "description": "The compensation grade's unique identifier.", "type": "string" }, "label": { "description": "The compensation grade's label.", "type": "string" } }, "title": "WorkerCompensationGrade", "type": "object" }, "compensation_id": { "description": "The compensation package for the worker.", "type": "string" }, "country": { "description": "The worker's country.", "type": "string" }, "country_fields": { "description": "Country level fields for the worker.", "properties": { "ca": { "description": "Country-wise regional fields for Canada", "properties": { "sin": { "description": "Social Insurance Number (SIN) for Canada employees.", "type": "string" } }, "title": "CanadaFields", "type": "object" }, "nz": { "description": "Country-wise regional fields for New Zealand", "properties": { "ird_number": { "description": "Inland Revenue Department (IRD) number for New Zealand employees.", "type": "string" } }, "title": "NewZealandFields", "type": "object" }, "us": { "description": "Country-wise regional fields for USA", "properties": { "ssn": { "description": "Social Security Number (SSN) for US employees.", "type": "string" } }, "title": "USFields", "type": "object" } }, "title": "CountryFields", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "custom_fields": { "description": "Custom field values defined on the Employee object for this worker\n\nExpandable field", "items": { "additionalProperties": {} }, "type": "array" }, "date_of_birth": { "description": "The worker's date of birth.", "type": "string" }, "department": { "description": "The worker's assigned department.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "department_hierarchy": { "description": "List of departments in the department hierarchy. Refer department_hierarchy_ids for department hierarchy order.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestDepartment" }, "type": "array" }, "department_hierarchy_id": { "description": "The identifier of departments in the department hierarchy ordered from parent department to child department.", "items": { "type": "string" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the department.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestDepartment", "description": "The parent department.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent department.", "type": "string" }, "reference_code": { "description": "Reference code of the department.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Department", "type": "object" }, "department_id": { "description": "The worker's assigned department.", "type": "string" }, "employment_type": { "description": "The worker's employment type.\n\nExpandable field", "properties": { "amount_worked": { "description": "The amount worked for the employment type. * `FULL-TIME`: Full-time is at least 30 hours per week. Full-time workers will typically be eligible for benefits. * `PART-TIME`: Part-time is less than 30 hours per week. These workers may be eligible for benefits, depending on company settings and hours worked. * `TEMPORARY`: These workers are hired on a temporary basis. You can specify how each worker with this employment type will be paid individually.", "type": "string" }, "compensation_time_period": { "description": "The compensation period for the employment type. * `SALARIED`: Employees that are paid a fixed amount per year. * `HOURLY`: Employees that are paid a wage per hour worked.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "label": { "description": "The display label of the employment type.", "type": "string" }, "name": { "description": "The name of the employment type for non-custom employment types.", "type": "string" }, "type": { "description": "The classification of the worker by the company. * `CONTRACTOR`: Contractors are self-employed workers who provide services on a short-term or per-project basis and are not eligible for tax-withholding or benefits. * `EMPLOYEE`: Employees are hired and managed by an employer, work under the employer's direct supervision and control, and are protected by law for wages and employment rights.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "label", "updated_at" ], "title": "CompanyEmploymentType", "type": "object" }, "employment_type_id": { "description": "The worker's employment type.", "type": "string" }, "end_date": { "description": "The end date of the worker.", "type": "string" }, "ethnicity": { "description": "The identified ethnicity of the worker, if specified.", "type": "string" }, "gender": { "description": "The gender of the worker, if specified.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_manager": { "description": "Whether the worker is a manager", "type": "boolean" }, "job_function": { "description": "The worker's job function. When expanded, this field requires `job-functions.read`.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "Displayed name of the job function", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "JobFunction", "type": "object" }, "job_function_id": { "description": "ID of the worker's job function.", "type": "string" }, "legal_entity": { "description": "The worker's associated legal entity.\n\nExpandable field", "properties": { "company": { "description": "The company or organization associated with the legal entity\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "doing_business_as_name": { "description": "The doing business as name for the company.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_entities": { "description": "A list of the company's entities.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestLegalEntity" }, "type": "array" }, "legal_entities_id": { "description": "A list of the company's entities.", "items": { "type": "string" }, "type": "array" }, "legal_name": { "description": "The legal name of the company.", "type": "string" }, "name": { "description": "The name of the company.", "type": "string" }, "parent_legal_entity": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The company's ultimate holding entity.\n\nExpandable field", "type": "object" }, "parent_legal_entity_id": { "description": "The company's ultimate holding entity.", "type": "string" }, "phone": { "description": "The phone number for the company.", "type": "string" }, "physical_address": { "description": "The physical address of the holding entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "primary_email": { "description": "The email address used when registering this company.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "legal_entities", "legal_entities_id", "name", "updated_at" ], "title": "Company", "type": "object" }, "company_id": { "description": "The company or organization associated with the legal entity", "type": "string" }, "country": { "description": "The country the legal entity is based in.", "properties": { "code": { "description": "The code of the country.", "type": "string" } }, "required": [ "code" ], "title": "Country", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "entity_level": { "description": "The legal entity's level in a hierarchy. * `PARENT`: The legal entity is considered the ultimate holding entity. * `SUBSIDIARY`: The legal entity is considered a subsidiary, fully or partially held by another. * `BRANCH`: The legal entity is considered a branch, associated with a parent legal entity.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_name": { "description": "The legal name of the legal entity.", "type": "string" }, "mailing_address": { "description": "The mailing address of the legal entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "management_type": { "description": "The legal entity management type in the case of an employer of record (EOR) or professional employment organization (PEO). * `PEO`: The legal entity is considered a Professional Employment Organization (PEO). * `EOR`: The legal entity is considered an Employer of Record (EOR).", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The parent legal entity.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent legal entity.", "type": "string" }, "physical_address": { "description": "The physical address of the legal entity, if it differs from the mailing address.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "registration_date": { "description": "The registration date of the entity.", "type": "string" }, "tax_identifier": { "description": "The tax identifier for the legal entity.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "LegalEntity", "type": "object" }, "legal_entity_id": { "description": "The worker's associated legal entity.", "type": "string" }, "level": { "description": "The level of the worker.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "description": { "description": "The description of the level.", "type": "string" }, "experience_requirements": { "description": "The experience requirements for the level.", "type": "string" }, "global_level": { "anyOf": [ { "description": "Global level is used to track the seniority of levels. The higher up a level is placed on the page, the more senior and higher-ranked the level. Global level is used in workflows, policies, and reports that use the level attribute (e.g., you can use Level Lookup to set up a workflow that notifies the nearest person in an worker's management chain at or above the specified level).", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the level. Must be unique within the company or organization.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLevel", "description": "The parent level.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent level.", "type": "string" }, "rank": { "anyOf": [ { "description": "The rank of the level within its track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "scope_of_responsibilities": { "description": "The scope of responsibilities for the level.", "type": "string" }, "track": { "description": "The track associated with the level, if it's not a global level.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_default": { "description": "Whether this is the company's default track.", "type": "boolean" }, "name": { "description": "The name of the track. Must be unique within the company or organization.", "type": "string" }, "order": { "anyOf": [ { "description": "The one-based horizontal display order of the track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "start_global_level": { "anyOf": [ { "description": "The highest global level occupied by this track. Empty tracks return null.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Track", "type": "object" }, "track_id": { "description": "The track associated with the level. Required during creation. Include global_level when changing it.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Level", "type": "object" }, "level_id": { "description": "The level of the worker.", "type": "string" }, "location": { "description": "The location that the worker is mapped to for tax purposes. In the case that a worker is remote, the location's type is remote.", "properties": { "type": { "description": "The type of location.", "type": "string" }, "work_location_id": { "description": "The work location, if the worker isn't remote.", "type": "string" } }, "required": [ "type", "work_location_id" ], "title": "WorkerLocation", "type": "object" }, "manager": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's manager.\n\nExpandable field", "type": "object" }, "manager_id": { "description": "The worker's manager.", "type": "string" }, "number": { "anyOf": [ { "description": "The worker's number within the organization.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "original_start_date": { "description": "The worker's earliest start date across their employment history, excluding INIT roles.", "type": "string" }, "overtime_exemption": { "description": "The worker's overtime exemption status.", "type": "string" }, "pay_schedule_id": { "description": "The ID of the pay schedule currently associated with the worker.", "type": "string" }, "personal_email": { "description": "The worker's associated personal email address.", "type": "string" }, "race": { "description": "The identified race of the worker, if specified.", "type": "string" }, "start_date": { "description": "The start date of the worker.", "type": "string" }, "status": { "description": "The worker's status within the organization.", "type": "string" }, "teams": { "description": "The worker's assigned teams.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestTeamcb26bc28f32f" }, "type": "array" }, "teams_id": { "description": "The worker's assigned teams.", "items": { "type": "string" }, "type": "array" }, "termination_details": { "description": "The details of the worker's termination, if applicable.", "properties": { "reason": { "description": "This is a description that will be custom to each Rippling company.", "type": "string" }, "type": { "description": "The termination type indicates whether the termination was voluntary or involuntary.", "type": "string" } }, "title": "TerminationDetails", "type": "object" }, "title": { "description": "The worker's title.", "type": "string" }, "title_effective_date": { "description": "Title effective date", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "user": { "description": "The worker's associated user.\n\nExpandable field", "properties": { "active": { "description": "Whether the user is able to access company resources, typically when they are in actively engaged with the company and not after off-boarding.", "type": "boolean" }, "addresses": { "description": "The user's addresses.", "items": { "$ref": "#/components/schemas/OutputRestUserAddressedd59b9ba9a1" }, "type": "array" }, "created_at": { "description": "Record creation date", "type": "string" }, "display_name": { "description": "The display name of the user using either the concatenated preferred given and family name or username depending on availability.", "type": "string" }, "emails": { "description": "The user's email addresses.", "items": { "$ref": "#/components/schemas/OutputRestEmail5284c8258dc3" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "locale": { "description": "The User's default location for purposes of localization of currency, date time format, or numerical representations pursuant to RFC5646.", "type": "string" }, "name": { "description": "The user's name.", "properties": { "family_name": { "description": "The legal family name of the user, or last name in most Western languages.", "type": "string" }, "formatted": { "description": "The user's full name.", "type": "string" }, "given_name": { "description": "The given legal name of the user, or first name in most Western languages.", "type": "string" }, "middle_name": { "description": "The middle name(s) of the user.", "type": "string" }, "preferred_family_name": { "description": "The preferred family name, or last name in most Western languages, by the user.", "type": "string" }, "preferred_given_name": { "description": "The preferred given name, or first name in most Western languages, by the user.", "type": "string" } }, "title": "UserName", "type": "object" }, "number": { "description": "The permanent profile number of the user.", "type": "string" }, "phone_numbers": { "description": "The user's phone numbers.", "items": { "$ref": "#/components/schemas/OutputRestUserPhoneNumber12060c61ecf5" }, "type": "array" }, "photos": { "description": "The user's photos.", "items": { "$ref": "#/components/schemas/OutputRestUserPhoto2be7c3ae3f39" }, "type": "array" }, "preferred_language": { "description": "The User's preferred written or spoken language in the same format of the HTTP Accept-Language header, pursuant to Section 5.3.5 of RFC7231.", "type": "string" }, "timezone": { "description": "The User's current time zone in IANA database Olson format", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "username": { "description": "The unique identifier across Rippling used by the User for direct authentication into their associated company. Globally unique.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "User", "type": "object" }, "user_id": { "description": "The worker's associated user.", "type": "string" }, "work_email": { "description": "The worker's associated work email address.", "type": "string" }, "work_schedule": { "additionalProperties": { "$ref": "#/components/schemas/OutputRestWorkScheduleDay938f88d94f20" }, "description": "The worker's scheduled working hours for each day of the week.", "type": "object" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Worker", "type": "object" }, "default_business_partner_id": { "description": "Id of Optional default business partner worker to whom all employees will be mapped if not explicitly mapped to a business partner in the group.", "type": "string" }, "domain": { "description": "Type of business partner group", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "Name used to identify business partner group", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "BusinessPartnerGroup", "type": "object" }, "OutputRestBusinessStructurePath": { "description": "", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "job_codes": { "description": "Ordered list of full JobCode objects for each job in the path, top to bottom. Populate via ?expand=job_codes. Requires both business-structure-paths.read and job-codes.read scopes.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestJobCode8e1bf4383ee1" }, "type": "array" }, "job_codes_id": { "description": "Ordered list of Job code IDs from top to bottom.", "items": { "type": "string" }, "type": "array" }, "name": { "description": "Name of the path (e.g. 'SF Office > Coffee > Barista').", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestBusinessStructurePath", "description": "The parent path.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "Id of the parent BusinessStructurePath. None for root path.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "BusinessStructurePath", "type": "object" }, "OutputRestCompany": { "description": "", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "doing_business_as_name": { "description": "The doing business as name for the company.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_entities": { "description": "A list of the company's entities.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestLegalEntity9c4b5c98341c" }, "type": "array" }, "legal_entities_id": { "description": "A list of the company's entities.", "items": { "type": "string" }, "type": "array" }, "legal_name": { "description": "The legal name of the company.", "type": "string" }, "name": { "description": "The name of the company.", "type": "string" }, "parent_legal_entity": { "description": "The company's ultimate holding entity.\n\nExpandable field", "properties": { "company": { "$ref": "#/components/schemas/OutputRestCompany", "description": "The company or organization associated with the legal entity\n\nExpandable field", "type": "object" }, "company_id": { "description": "The company or organization associated with the legal entity", "type": "string" }, "country": { "description": "The country the legal entity is based in.", "properties": { "code": { "description": "The code of the country.", "type": "string" } }, "required": [ "code" ], "title": "Country", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "entity_level": { "description": "The legal entity's level in a hierarchy. * `PARENT`: The legal entity is considered the ultimate holding entity. * `SUBSIDIARY`: The legal entity is considered a subsidiary, fully or partially held by another. * `BRANCH`: The legal entity is considered a branch, associated with a parent legal entity.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_name": { "description": "The legal name of the legal entity.", "type": "string" }, "mailing_address": { "description": "The mailing address of the legal entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "management_type": { "description": "The legal entity management type in the case of an employer of record (EOR) or professional employment organization (PEO). * `PEO`: The legal entity is considered a Professional Employment Organization (PEO). * `EOR`: The legal entity is considered an Employer of Record (EOR).", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The parent legal entity.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent legal entity.", "type": "string" }, "physical_address": { "description": "The physical address of the legal entity, if it differs from the mailing address.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "registration_date": { "description": "The registration date of the entity.", "type": "string" }, "tax_identifier": { "description": "The tax identifier for the legal entity.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "LegalEntity", "type": "object" }, "parent_legal_entity_id": { "description": "The company's ultimate holding entity.", "type": "string" }, "phone": { "description": "The phone number for the company.", "type": "string" }, "physical_address": { "description": "The physical address of the holding entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "primary_email": { "description": "The email address used when registering this company.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "legal_entities", "legal_entities_id", "name", "updated_at" ], "title": "Company", "type": "object" }, "OutputRestCompensation": { "description": "", "properties": { "annual_compensation": { "description": "The worker's annual compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "annual_salary_equivalent": { "description": "The worker's annual salary equivalent, for insurance purposes. It will be equal to the worker's annual compensation, except for owners that are receiving no cashcompensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "bonus_schedule": { "description": "The worker's bonus schedule.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "hourly_wage": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "id": { "description": "Identifier field", "type": "string" }, "monthly_compensation": { "description": "The worker's monthly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "on_target_commission": { "description": "The worker's on-target commission.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "payment_terms": { "description": "The payment terms for an worker's compensation.", "type": "string" }, "payment_type": { "description": "The payment type for an worker's compensation.", "type": "string" }, "relocation_reimbursement": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "salary_effective_date": { "description": "Salary effective date", "type": "string" }, "signing_bonus": { "description": "The worker's signing bonus.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus": { "description": "The worker's target annual bonus amount.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus_percent": { "anyOf": [ { "description": "The worker's target annual bonus as a percent of annual compensation.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" }, "weekly_compensation": { "description": "The worker's weekly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "worker": { "description": "The worker's details.\n\nExpandable field", "properties": { "business_partners": { "description": "Worker's assigned business partners. This field is only populated when explicitly requested via the expand parameter (e.g., ?expand=business_partners). When expanded, returns an empty list ([]) if the worker has no business partners.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestBusinessPartner77b00a069c32" }, "type": "array" }, "business_partners_id": { "description": "Worker's assigned business partners unique identifiers. Returns an empty list ([]) if the worker has no business partners.", "items": { "type": "string" }, "type": "array" }, "citizenship": { "description": "The countries that the worker has citizenship in.", "type": "string" }, "compensation": { "$ref": "#/components/schemas/OutputRestCompensation", "description": "The compensation package for the worker.\n\nExpandable field", "type": "object" }, "compensation_grade": { "description": "The compensation grade assigned to the worker, if any.", "properties": { "id": { "description": "The compensation grade's unique identifier.", "type": "string" }, "label": { "description": "The compensation grade's label.", "type": "string" } }, "title": "WorkerCompensationGrade", "type": "object" }, "compensation_id": { "description": "The compensation package for the worker.", "type": "string" }, "country": { "description": "The worker's country.", "type": "string" }, "country_fields": { "description": "Country level fields for the worker.", "properties": { "ca": { "description": "Country-wise regional fields for Canada", "properties": { "sin": { "description": "Social Insurance Number (SIN) for Canada employees.", "type": "string" } }, "title": "CanadaFields", "type": "object" }, "nz": { "description": "Country-wise regional fields for New Zealand", "properties": { "ird_number": { "description": "Inland Revenue Department (IRD) number for New Zealand employees.", "type": "string" } }, "title": "NewZealandFields", "type": "object" }, "us": { "description": "Country-wise regional fields for USA", "properties": { "ssn": { "description": "Social Security Number (SSN) for US employees.", "type": "string" } }, "title": "USFields", "type": "object" } }, "title": "CountryFields", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "custom_fields": { "description": "Custom field values defined on the Employee object for this worker\n\nExpandable field", "items": { "additionalProperties": {} }, "type": "array" }, "date_of_birth": { "description": "The worker's date of birth.", "type": "string" }, "department": { "description": "The worker's assigned department.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "department_hierarchy": { "description": "List of departments in the department hierarchy. Refer department_hierarchy_ids for department hierarchy order.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestDepartment" }, "type": "array" }, "department_hierarchy_id": { "description": "The identifier of departments in the department hierarchy ordered from parent department to child department.", "items": { "type": "string" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the department.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestDepartment", "description": "The parent department.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent department.", "type": "string" }, "reference_code": { "description": "Reference code of the department.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Department", "type": "object" }, "department_id": { "description": "The worker's assigned department.", "type": "string" }, "employment_type": { "description": "The worker's employment type.\n\nExpandable field", "properties": { "amount_worked": { "description": "The amount worked for the employment type. * `FULL-TIME`: Full-time is at least 30 hours per week. Full-time workers will typically be eligible for benefits. * `PART-TIME`: Part-time is less than 30 hours per week. These workers may be eligible for benefits, depending on company settings and hours worked. * `TEMPORARY`: These workers are hired on a temporary basis. You can specify how each worker with this employment type will be paid individually.", "type": "string" }, "compensation_time_period": { "description": "The compensation period for the employment type. * `SALARIED`: Employees that are paid a fixed amount per year. * `HOURLY`: Employees that are paid a wage per hour worked.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "label": { "description": "The display label of the employment type.", "type": "string" }, "name": { "description": "The name of the employment type for non-custom employment types.", "type": "string" }, "type": { "description": "The classification of the worker by the company. * `CONTRACTOR`: Contractors are self-employed workers who provide services on a short-term or per-project basis and are not eligible for tax-withholding or benefits. * `EMPLOYEE`: Employees are hired and managed by an employer, work under the employer's direct supervision and control, and are protected by law for wages and employment rights.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "label", "updated_at" ], "title": "CompanyEmploymentType", "type": "object" }, "employment_type_id": { "description": "The worker's employment type.", "type": "string" }, "end_date": { "description": "The end date of the worker.", "type": "string" }, "ethnicity": { "description": "The identified ethnicity of the worker, if specified.", "type": "string" }, "gender": { "description": "The gender of the worker, if specified.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_manager": { "description": "Whether the worker is a manager", "type": "boolean" }, "job_function": { "description": "The worker's job function. When expanded, this field requires `job-functions.read`.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "Displayed name of the job function", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "JobFunction", "type": "object" }, "job_function_id": { "description": "ID of the worker's job function.", "type": "string" }, "legal_entity": { "description": "The worker's associated legal entity.\n\nExpandable field", "properties": { "company": { "description": "The company or organization associated with the legal entity\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "doing_business_as_name": { "description": "The doing business as name for the company.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_entities": { "description": "A list of the company's entities.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestLegalEntity" }, "type": "array" }, "legal_entities_id": { "description": "A list of the company's entities.", "items": { "type": "string" }, "type": "array" }, "legal_name": { "description": "The legal name of the company.", "type": "string" }, "name": { "description": "The name of the company.", "type": "string" }, "parent_legal_entity": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The company's ultimate holding entity.\n\nExpandable field", "type": "object" }, "parent_legal_entity_id": { "description": "The company's ultimate holding entity.", "type": "string" }, "phone": { "description": "The phone number for the company.", "type": "string" }, "physical_address": { "description": "The physical address of the holding entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "primary_email": { "description": "The email address used when registering this company.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "legal_entities", "legal_entities_id", "name", "updated_at" ], "title": "Company", "type": "object" }, "company_id": { "description": "The company or organization associated with the legal entity", "type": "string" }, "country": { "description": "The country the legal entity is based in.", "properties": { "code": { "description": "The code of the country.", "type": "string" } }, "required": [ "code" ], "title": "Country", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "entity_level": { "description": "The legal entity's level in a hierarchy. * `PARENT`: The legal entity is considered the ultimate holding entity. * `SUBSIDIARY`: The legal entity is considered a subsidiary, fully or partially held by another. * `BRANCH`: The legal entity is considered a branch, associated with a parent legal entity.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_name": { "description": "The legal name of the legal entity.", "type": "string" }, "mailing_address": { "description": "The mailing address of the legal entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "management_type": { "description": "The legal entity management type in the case of an employer of record (EOR) or professional employment organization (PEO). * `PEO`: The legal entity is considered a Professional Employment Organization (PEO). * `EOR`: The legal entity is considered an Employer of Record (EOR).", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The parent legal entity.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent legal entity.", "type": "string" }, "physical_address": { "description": "The physical address of the legal entity, if it differs from the mailing address.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "registration_date": { "description": "The registration date of the entity.", "type": "string" }, "tax_identifier": { "description": "The tax identifier for the legal entity.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "LegalEntity", "type": "object" }, "legal_entity_id": { "description": "The worker's associated legal entity.", "type": "string" }, "level": { "description": "The level of the worker.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "description": { "description": "The description of the level.", "type": "string" }, "experience_requirements": { "description": "The experience requirements for the level.", "type": "string" }, "global_level": { "anyOf": [ { "description": "Global level is used to track the seniority of levels. The higher up a level is placed on the page, the more senior and higher-ranked the level. Global level is used in workflows, policies, and reports that use the level attribute (e.g., you can use Level Lookup to set up a workflow that notifies the nearest person in an worker's management chain at or above the specified level).", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the level. Must be unique within the company or organization.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLevel", "description": "The parent level.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent level.", "type": "string" }, "rank": { "anyOf": [ { "description": "The rank of the level within its track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "scope_of_responsibilities": { "description": "The scope of responsibilities for the level.", "type": "string" }, "track": { "description": "The track associated with the level, if it's not a global level.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_default": { "description": "Whether this is the company's default track.", "type": "boolean" }, "name": { "description": "The name of the track. Must be unique within the company or organization.", "type": "string" }, "order": { "anyOf": [ { "description": "The one-based horizontal display order of the track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "start_global_level": { "anyOf": [ { "description": "The highest global level occupied by this track. Empty tracks return null.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Track", "type": "object" }, "track_id": { "description": "The track associated with the level. Required during creation. Include global_level when changing it.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Level", "type": "object" }, "level_id": { "description": "The level of the worker.", "type": "string" }, "location": { "description": "The location that the worker is mapped to for tax purposes. In the case that a worker is remote, the location's type is remote.", "properties": { "type": { "description": "The type of location.", "type": "string" }, "work_location_id": { "description": "The work location, if the worker isn't remote.", "type": "string" } }, "required": [ "type", "work_location_id" ], "title": "WorkerLocation", "type": "object" }, "manager": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's manager.\n\nExpandable field", "type": "object" }, "manager_id": { "description": "The worker's manager.", "type": "string" }, "number": { "anyOf": [ { "description": "The worker's number within the organization.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "original_start_date": { "description": "The worker's earliest start date across their employment history, excluding INIT roles.", "type": "string" }, "overtime_exemption": { "description": "The worker's overtime exemption status.", "type": "string" }, "pay_schedule_id": { "description": "The ID of the pay schedule currently associated with the worker.", "type": "string" }, "personal_email": { "description": "The worker's associated personal email address.", "type": "string" }, "race": { "description": "The identified race of the worker, if specified.", "type": "string" }, "start_date": { "description": "The start date of the worker.", "type": "string" }, "status": { "description": "The worker's status within the organization.", "type": "string" }, "teams": { "description": "The worker's assigned teams.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestTeamcb26bc28f32f" }, "type": "array" }, "teams_id": { "description": "The worker's assigned teams.", "items": { "type": "string" }, "type": "array" }, "termination_details": { "description": "The details of the worker's termination, if applicable.", "properties": { "reason": { "description": "This is a description that will be custom to each Rippling company.", "type": "string" }, "type": { "description": "The termination type indicates whether the termination was voluntary or involuntary.", "type": "string" } }, "title": "TerminationDetails", "type": "object" }, "title": { "description": "The worker's title.", "type": "string" }, "title_effective_date": { "description": "Title effective date", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "user": { "description": "The worker's associated user.\n\nExpandable field", "properties": { "active": { "description": "Whether the user is able to access company resources, typically when they are in actively engaged with the company and not after off-boarding.", "type": "boolean" }, "addresses": { "description": "The user's addresses.", "items": { "$ref": "#/components/schemas/OutputRestUserAddressedd59b9ba9a1" }, "type": "array" }, "created_at": { "description": "Record creation date", "type": "string" }, "display_name": { "description": "The display name of the user using either the concatenated preferred given and family name or username depending on availability.", "type": "string" }, "emails": { "description": "The user's email addresses.", "items": { "$ref": "#/components/schemas/OutputRestEmail5284c8258dc3" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "locale": { "description": "The User's default location for purposes of localization of currency, date time format, or numerical representations pursuant to RFC5646.", "type": "string" }, "name": { "description": "The user's name.", "properties": { "family_name": { "description": "The legal family name of the user, or last name in most Western languages.", "type": "string" }, "formatted": { "description": "The user's full name.", "type": "string" }, "given_name": { "description": "The given legal name of the user, or first name in most Western languages.", "type": "string" }, "middle_name": { "description": "The middle name(s) of the user.", "type": "string" }, "preferred_family_name": { "description": "The preferred family name, or last name in most Western languages, by the user.", "type": "string" }, "preferred_given_name": { "description": "The preferred given name, or first name in most Western languages, by the user.", "type": "string" } }, "title": "UserName", "type": "object" }, "number": { "description": "The permanent profile number of the user.", "type": "string" }, "phone_numbers": { "description": "The user's phone numbers.", "items": { "$ref": "#/components/schemas/OutputRestUserPhoneNumber12060c61ecf5" }, "type": "array" }, "photos": { "description": "The user's photos.", "items": { "$ref": "#/components/schemas/OutputRestUserPhoto2be7c3ae3f39" }, "type": "array" }, "preferred_language": { "description": "The User's preferred written or spoken language in the same format of the HTTP Accept-Language header, pursuant to Section 5.3.5 of RFC7231.", "type": "string" }, "timezone": { "description": "The User's current time zone in IANA database Olson format", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "username": { "description": "The unique identifier across Rippling used by the User for direct authentication into their associated company. Globally unique.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "User", "type": "object" }, "user_id": { "description": "The worker's associated user.", "type": "string" }, "work_email": { "description": "The worker's associated work email address.", "type": "string" }, "work_schedule": { "additionalProperties": { "$ref": "#/components/schemas/OutputRestWorkScheduleDay938f88d94f20" }, "description": "The worker's scheduled working hours for each day of the week.", "type": "object" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Worker", "type": "object" }, "worker_id": { "description": "The worker's ID.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Compensation", "type": "object" }, "OutputRestDepartment": { "description": "", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "department_hierarchy": { "description": "List of departments in the department hierarchy. Refer department_hierarchy_ids for department hierarchy order.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestDepartment" }, "type": "array" }, "department_hierarchy_id": { "description": "The identifier of departments in the department hierarchy ordered from parent department to child department.", "items": { "type": "string" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the department.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestDepartment", "description": "The parent department.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent department.", "type": "string" }, "reference_code": { "description": "Reference code of the department.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Department", "type": "object" }, "OutputRestEmail5284c8258dc3": { "description": "", "properties": { "display": { "description": "The display value of the email address.", "type": "string" }, "type": { "description": "The classification of the email.", "type": "string" }, "value": { "description": "A valid email address.", "type": "string" } }, "title": "Email", "type": "object" }, "OutputRestJobCode": { "description": "", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "custom_location": { "description": "The custom location of the job code. This location will be used for tax calculation purposes if using US Payroll when an employee is working at this job code.", "properties": { "address": { "description": "The address of the custom location.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" } }, "required": [ "address" ], "title": "CustomLocation", "type": "object" }, "department": { "description": "The department associated with the job code.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "department_hierarchy": { "description": "List of departments in the department hierarchy. Refer department_hierarchy_ids for department hierarchy order.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestDepartment" }, "type": "array" }, "department_hierarchy_id": { "description": "The identifier of departments in the department hierarchy ordered from parent department to child department.", "items": { "type": "string" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the department.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestDepartment", "description": "The parent department.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent department.", "type": "string" }, "reference_code": { "description": "Reference code of the department.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Department", "type": "object" }, "department_id": { "description": "The department associated with the job code.", "type": "string" }, "external_id": { "description": "The unique identifier of the job code in an outside system.", "type": "string" }, "group_id": { "description": "The ID of the job roster group.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_archived": { "description": "Whether this job code is archived. Set to true via PATCH to archive. Archiving is irreversible via this API.", "type": "boolean" }, "job_dimension": { "description": "The job dimension this job code belongs to.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "external_id": { "description": "The unique identifier of the job dimension in a third party system", "type": "string" }, "group_id": { "description": "The ID of the dimension roster group.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "includes_custom_location": { "description": "Whether the job dimension includes codes related to a custom location. Only one dimension can have this set to true.", "type": "boolean" }, "name": { "description": "The name of the job dimension", "type": "string" }, "org_attribute_associations": { "description": "Organizational attributes associated with the job dimension. Only 'PAY_RATE' can be set or modified using POST or PATCH requests.", "items": {}, "type": "array" }, "roster_type": { "description": "The roster type of the dimension. PER_DIMENSION means that there is a group on the dimension level and employees within that group have access to all job codes in the dimension. PER_JOB_CODE means that each job code has its own group.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "JobDimension", "type": "object" }, "job_dimension_id": { "description": "The ID of the job dimension this job code belongs to.", "type": "string" }, "name": { "description": "The name of the job dimension.", "type": "string" }, "pay_rate": { "anyOf": [ { "description": "The pay rate for this job code. Only applicable if the associated job dimension includes the 'PAY_RATE' organizational attribute.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "pay_rate_exceptions": { "description": "Pay rate overrides for the job based on exception dimension values.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestJobPayRateExceptionaf426aa0ac14" }, "type": "array" }, "pay_rate_exceptions_id": { "description": "Pay rate overrides id for the job based on exception dimension values.", "items": { "type": "string" }, "type": "array" }, "updated_at": { "description": "Record update date", "type": "string" }, "work_location": { "description": "The work location associated with the job code.\n\nExpandable field", "properties": { "address": { "description": "The address for the work location.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the work location.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "address", "created_at", "id", "name", "updated_at" ], "title": "WorkLocation", "type": "object" }, "work_location_id": { "description": "The work location associated with the job code.", "type": "string" } }, "required": [ "created_at", "id", "job_dimension_id", "name", "updated_at" ], "title": "JobCode", "type": "object" }, "OutputRestJobCode8e1bf4383ee1": { "description": "", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "custom_location": { "description": "The custom location of the job code. This location will be used for tax calculation purposes if using US Payroll when an employee is working at this job code.", "properties": { "address": { "description": "The address of the custom location.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" } }, "required": [ "address" ], "title": "CustomLocation", "type": "object" }, "department": { "description": "The department associated with the job code.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "department_hierarchy": { "description": "List of departments in the department hierarchy. Refer department_hierarchy_ids for department hierarchy order.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestDepartment" }, "type": "array" }, "department_hierarchy_id": { "description": "The identifier of departments in the department hierarchy ordered from parent department to child department.", "items": { "type": "string" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the department.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestDepartment", "description": "The parent department.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent department.", "type": "string" }, "reference_code": { "description": "Reference code of the department.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Department", "type": "object" }, "department_id": { "description": "The department associated with the job code.", "type": "string" }, "external_id": { "description": "The unique identifier of the job code in an outside system.", "type": "string" }, "group_id": { "description": "The ID of the job roster group.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_archived": { "description": "Whether this job code is archived. Set to true via PATCH to archive. Archiving is irreversible via this API.", "type": "boolean" }, "job_dimension": { "description": "The job dimension this job code belongs to.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "external_id": { "description": "The unique identifier of the job dimension in a third party system", "type": "string" }, "group_id": { "description": "The ID of the dimension roster group.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "includes_custom_location": { "description": "Whether the job dimension includes codes related to a custom location. Only one dimension can have this set to true.", "type": "boolean" }, "name": { "description": "The name of the job dimension", "type": "string" }, "org_attribute_associations": { "description": "Organizational attributes associated with the job dimension. Only 'PAY_RATE' can be set or modified using POST or PATCH requests.", "items": {}, "type": "array" }, "roster_type": { "description": "The roster type of the dimension. PER_DIMENSION means that there is a group on the dimension level and employees within that group have access to all job codes in the dimension. PER_JOB_CODE means that each job code has its own group.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "JobDimension", "type": "object" }, "job_dimension_id": { "description": "The ID of the job dimension this job code belongs to.", "type": "string" }, "name": { "description": "The name of the job dimension.", "type": "string" }, "pay_rate": { "anyOf": [ { "description": "The pay rate for this job code. Only applicable if the associated job dimension includes the 'PAY_RATE' organizational attribute.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "pay_rate_exceptions": { "description": "Pay rate overrides for the job based on exception dimension values.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestJobPayRateExceptionaf426aa0ac14" }, "type": "array" }, "pay_rate_exceptions_id": { "description": "Pay rate overrides id for the job based on exception dimension values.", "items": { "type": "string" }, "type": "array" }, "updated_at": { "description": "Record update date", "type": "string" }, "work_location": { "description": "The work location associated with the job code.\n\nExpandable field", "properties": { "address": { "description": "The address for the work location.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the work location.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "address", "created_at", "id", "name", "updated_at" ], "title": "WorkLocation", "type": "object" }, "work_location_id": { "description": "The work location associated with the job code.", "type": "string" } }, "required": [ "created_at", "id", "job_dimension_id", "name", "updated_at" ], "title": "JobCode", "type": "object" }, "OutputRestJobPayRateException": { "description": "", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "exception_dimension_id": { "description": "Identifier of dimension object on which exception is configured. This objects details can be queried from exception_dimension_type's resource", "type": "string" }, "exception_dimension_type": { "description": "Type of dimension on which exception is configured", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "job_code": { "description": "Job for which exception is configured.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "custom_location": { "description": "The custom location of the job code. This location will be used for tax calculation purposes if using US Payroll when an employee is working at this job code.", "properties": { "address": { "description": "The address of the custom location.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" } }, "required": [ "address" ], "title": "CustomLocation", "type": "object" }, "department": { "description": "The department associated with the job code.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "department_hierarchy": { "description": "List of departments in the department hierarchy. Refer department_hierarchy_ids for department hierarchy order.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestDepartment" }, "type": "array" }, "department_hierarchy_id": { "description": "The identifier of departments in the department hierarchy ordered from parent department to child department.", "items": { "type": "string" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the department.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestDepartment", "description": "The parent department.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent department.", "type": "string" }, "reference_code": { "description": "Reference code of the department.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Department", "type": "object" }, "department_id": { "description": "The department associated with the job code.", "type": "string" }, "external_id": { "description": "The unique identifier of the job code in an outside system.", "type": "string" }, "group_id": { "description": "The ID of the job roster group.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_archived": { "description": "Whether this job code is archived. Set to true via PATCH to archive. Archiving is irreversible via this API.", "type": "boolean" }, "job_dimension": { "description": "The job dimension this job code belongs to.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "external_id": { "description": "The unique identifier of the job dimension in a third party system", "type": "string" }, "group_id": { "description": "The ID of the dimension roster group.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "includes_custom_location": { "description": "Whether the job dimension includes codes related to a custom location. Only one dimension can have this set to true.", "type": "boolean" }, "name": { "description": "The name of the job dimension", "type": "string" }, "org_attribute_associations": { "description": "Organizational attributes associated with the job dimension. Only 'PAY_RATE' can be set or modified using POST or PATCH requests.", "items": {}, "type": "array" }, "roster_type": { "description": "The roster type of the dimension. PER_DIMENSION means that there is a group on the dimension level and employees within that group have access to all job codes in the dimension. PER_JOB_CODE means that each job code has its own group.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "JobDimension", "type": "object" }, "job_dimension_id": { "description": "The ID of the job dimension this job code belongs to.", "type": "string" }, "name": { "description": "The name of the job dimension.", "type": "string" }, "pay_rate": { "anyOf": [ { "description": "The pay rate for this job code. Only applicable if the associated job dimension includes the 'PAY_RATE' organizational attribute.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "pay_rate_exceptions": { "description": "Pay rate overrides for the job based on exception dimension values.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestJobPayRateException" }, "type": "array" }, "pay_rate_exceptions_id": { "description": "Pay rate overrides id for the job based on exception dimension values.", "items": { "type": "string" }, "type": "array" }, "updated_at": { "description": "Record update date", "type": "string" }, "work_location": { "description": "The work location associated with the job code.\n\nExpandable field", "properties": { "address": { "description": "The address for the work location.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the work location.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "address", "created_at", "id", "name", "updated_at" ], "title": "WorkLocation", "type": "object" }, "work_location_id": { "description": "The work location associated with the job code.", "type": "string" } }, "required": [ "created_at", "id", "job_dimension_id", "name", "updated_at" ], "title": "JobCode", "type": "object" }, "job_code_id": { "description": "Identifier of Job for which exception is configured.", "type": "string" }, "pay_rate": { "anyOf": [ { "description": "The pay rate for exception on job_code_id and exception_dimension_id combination", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "exception_dimension_id", "id", "job_code_id", "pay_rate", "updated_at" ], "title": "JobPayRateException", "type": "object" }, "OutputRestJobPayRateExceptionaf426aa0ac14": { "description": "", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "exception_dimension_id": { "description": "Identifier of dimension object on which exception is configured. This objects details can be queried from exception_dimension_type's resource", "type": "string" }, "exception_dimension_type": { "description": "Type of dimension on which exception is configured", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "job_code": { "$ref": "#/components/schemas/OutputRestJobCode", "description": "Job for which exception is configured.\n\nExpandable field", "type": "object" }, "job_code_id": { "description": "Identifier of Job for which exception is configured.", "type": "string" }, "pay_rate": { "anyOf": [ { "description": "The pay rate for exception on job_code_id and exception_dimension_id combination", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "exception_dimension_id", "id", "job_code_id", "pay_rate", "updated_at" ], "title": "JobPayRateException", "type": "object" }, "OutputRestLegalEntity": { "description": "", "properties": { "company": { "description": "The company or organization associated with the legal entity\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "doing_business_as_name": { "description": "The doing business as name for the company.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_entities": { "description": "A list of the company's entities.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestLegalEntity" }, "type": "array" }, "legal_entities_id": { "description": "A list of the company's entities.", "items": { "type": "string" }, "type": "array" }, "legal_name": { "description": "The legal name of the company.", "type": "string" }, "name": { "description": "The name of the company.", "type": "string" }, "parent_legal_entity": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The company's ultimate holding entity.\n\nExpandable field", "type": "object" }, "parent_legal_entity_id": { "description": "The company's ultimate holding entity.", "type": "string" }, "phone": { "description": "The phone number for the company.", "type": "string" }, "physical_address": { "description": "The physical address of the holding entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "primary_email": { "description": "The email address used when registering this company.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "legal_entities", "legal_entities_id", "name", "updated_at" ], "title": "Company", "type": "object" }, "company_id": { "description": "The company or organization associated with the legal entity", "type": "string" }, "country": { "description": "The country the legal entity is based in.", "properties": { "code": { "description": "The code of the country.", "type": "string" } }, "required": [ "code" ], "title": "Country", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "entity_level": { "description": "The legal entity's level in a hierarchy. * `PARENT`: The legal entity is considered the ultimate holding entity. * `SUBSIDIARY`: The legal entity is considered a subsidiary, fully or partially held by another. * `BRANCH`: The legal entity is considered a branch, associated with a parent legal entity.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_name": { "description": "The legal name of the legal entity.", "type": "string" }, "mailing_address": { "description": "The mailing address of the legal entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "management_type": { "description": "The legal entity management type in the case of an employer of record (EOR) or professional employment organization (PEO). * `PEO`: The legal entity is considered a Professional Employment Organization (PEO). * `EOR`: The legal entity is considered an Employer of Record (EOR).", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The parent legal entity.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent legal entity.", "type": "string" }, "physical_address": { "description": "The physical address of the legal entity, if it differs from the mailing address.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "registration_date": { "description": "The registration date of the entity.", "type": "string" }, "tax_identifier": { "description": "The tax identifier for the legal entity.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "LegalEntity", "type": "object" }, "OutputRestLegalEntity9c4b5c98341c": { "description": "", "properties": { "company": { "$ref": "#/components/schemas/OutputRestCompany", "description": "The company or organization associated with the legal entity\n\nExpandable field", "type": "object" }, "company_id": { "description": "The company or organization associated with the legal entity", "type": "string" }, "country": { "description": "The country the legal entity is based in.", "properties": { "code": { "description": "The code of the country.", "type": "string" } }, "required": [ "code" ], "title": "Country", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "entity_level": { "description": "The legal entity's level in a hierarchy. * `PARENT`: The legal entity is considered the ultimate holding entity. * `SUBSIDIARY`: The legal entity is considered a subsidiary, fully or partially held by another. * `BRANCH`: The legal entity is considered a branch, associated with a parent legal entity.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_name": { "description": "The legal name of the legal entity.", "type": "string" }, "mailing_address": { "description": "The mailing address of the legal entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "management_type": { "description": "The legal entity management type in the case of an employer of record (EOR) or professional employment organization (PEO). * `PEO`: The legal entity is considered a Professional Employment Organization (PEO). * `EOR`: The legal entity is considered an Employer of Record (EOR).", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The parent legal entity.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent legal entity.", "type": "string" }, "physical_address": { "description": "The physical address of the legal entity, if it differs from the mailing address.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "registration_date": { "description": "The registration date of the entity.", "type": "string" }, "tax_identifier": { "description": "The tax identifier for the legal entity.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "LegalEntity", "type": "object" }, "OutputRestLevel": { "description": "", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "description": { "description": "The description of the level.", "type": "string" }, "experience_requirements": { "description": "The experience requirements for the level.", "type": "string" }, "global_level": { "anyOf": [ { "description": "Global level is used to track the seniority of levels. The higher up a level is placed on the page, the more senior and higher-ranked the level. Global level is used in workflows, policies, and reports that use the level attribute (e.g., you can use Level Lookup to set up a workflow that notifies the nearest person in an worker's management chain at or above the specified level).", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the level. Must be unique within the company or organization.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLevel", "description": "The parent level.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent level.", "type": "string" }, "rank": { "anyOf": [ { "description": "The rank of the level within its track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "scope_of_responsibilities": { "description": "The scope of responsibilities for the level.", "type": "string" }, "track": { "description": "The track associated with the level, if it's not a global level.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_default": { "description": "Whether this is the company's default track.", "type": "boolean" }, "name": { "description": "The name of the track. Must be unique within the company or organization.", "type": "string" }, "order": { "anyOf": [ { "description": "The one-based horizontal display order of the track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "start_global_level": { "anyOf": [ { "description": "The highest global level occupied by this track. Empty tracks return null.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Track", "type": "object" }, "track_id": { "description": "The track associated with the level. Required during creation. Include global_level when changing it.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Level", "type": "object" }, "OutputRestTeam": { "description": "", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the team.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestTeam", "description": "The parent team\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent team", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Team", "type": "object" }, "OutputRestTeamcb26bc28f32f": { "description": "", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the team.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestTeam", "description": "The parent team\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent team", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Team", "type": "object" }, "OutputRestUserAddressedd59b9ba9a1": { "description": "", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "UserAddress", "type": "object" }, "OutputRestUserPhoneNumber12060c61ecf5": { "description": "", "properties": { "display": { "description": "The display value of the phone number.", "type": "string" }, "type": { "description": "The classification of the phone number, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "value": { "description": "The canonical global phone number pursuant to RFC3966.", "type": "string" } }, "title": "UserPhoneNumber", "type": "object" }, "OutputRestUserPhoto2be7c3ae3f39": { "description": "", "properties": { "type": { "description": "The classification of the photo.", "type": "string" }, "value": { "description": "The URL of the photo.", "type": "string" } }, "title": "UserPhoto", "type": "object" }, "OutputRestWorkScheduleDay938f88d94f20": { "description": "The scheduled working hours for a day of the week.", "properties": { "hours": { "anyOf": [ { "description": "The number of scheduled working hours for the day.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "WorkScheduleDay", "type": "object" }, "OutputRestWorker": { "description": "", "properties": { "business_partners": { "description": "Worker's assigned business partners. This field is only populated when explicitly requested via the expand parameter (e.g., ?expand=business_partners). When expanded, returns an empty list ([]) if the worker has no business partners.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestBusinessPartner77b00a069c32" }, "type": "array" }, "business_partners_id": { "description": "Worker's assigned business partners unique identifiers. Returns an empty list ([]) if the worker has no business partners.", "items": { "type": "string" }, "type": "array" }, "citizenship": { "description": "The countries that the worker has citizenship in.", "type": "string" }, "compensation": { "description": "The compensation package for the worker.\n\nExpandable field", "properties": { "annual_compensation": { "description": "The worker's annual compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "annual_salary_equivalent": { "description": "The worker's annual salary equivalent, for insurance purposes. It will be equal to the worker's annual compensation, except for owners that are receiving no cashcompensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "bonus_schedule": { "description": "The worker's bonus schedule.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "hourly_wage": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "id": { "description": "Identifier field", "type": "string" }, "monthly_compensation": { "description": "The worker's monthly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "on_target_commission": { "description": "The worker's on-target commission.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "payment_terms": { "description": "The payment terms for an worker's compensation.", "type": "string" }, "payment_type": { "description": "The payment type for an worker's compensation.", "type": "string" }, "relocation_reimbursement": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "salary_effective_date": { "description": "Salary effective date", "type": "string" }, "signing_bonus": { "description": "The worker's signing bonus.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus": { "description": "The worker's target annual bonus amount.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus_percent": { "anyOf": [ { "description": "The worker's target annual bonus as a percent of annual compensation.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" }, "weekly_compensation": { "description": "The worker's weekly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "worker": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's details.\n\nExpandable field", "type": "object" }, "worker_id": { "description": "The worker's ID.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Compensation", "type": "object" }, "compensation_grade": { "description": "The compensation grade assigned to the worker, if any.", "properties": { "id": { "description": "The compensation grade's unique identifier.", "type": "string" }, "label": { "description": "The compensation grade's label.", "type": "string" } }, "title": "WorkerCompensationGrade", "type": "object" }, "compensation_id": { "description": "The compensation package for the worker.", "type": "string" }, "country": { "description": "The worker's country.", "type": "string" }, "country_fields": { "description": "Country level fields for the worker.", "properties": { "ca": { "description": "Country-wise regional fields for Canada", "properties": { "sin": { "description": "Social Insurance Number (SIN) for Canada employees.", "type": "string" } }, "title": "CanadaFields", "type": "object" }, "nz": { "description": "Country-wise regional fields for New Zealand", "properties": { "ird_number": { "description": "Inland Revenue Department (IRD) number for New Zealand employees.", "type": "string" } }, "title": "NewZealandFields", "type": "object" }, "us": { "description": "Country-wise regional fields for USA", "properties": { "ssn": { "description": "Social Security Number (SSN) for US employees.", "type": "string" } }, "title": "USFields", "type": "object" } }, "title": "CountryFields", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "custom_fields": { "description": "Custom field values defined on the Employee object for this worker\n\nExpandable field", "items": { "additionalProperties": {} }, "type": "array" }, "date_of_birth": { "description": "The worker's date of birth.", "type": "string" }, "department": { "description": "The worker's assigned department.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "department_hierarchy": { "description": "List of departments in the department hierarchy. Refer department_hierarchy_ids for department hierarchy order.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestDepartment" }, "type": "array" }, "department_hierarchy_id": { "description": "The identifier of departments in the department hierarchy ordered from parent department to child department.", "items": { "type": "string" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the department.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestDepartment", "description": "The parent department.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent department.", "type": "string" }, "reference_code": { "description": "Reference code of the department.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Department", "type": "object" }, "department_id": { "description": "The worker's assigned department.", "type": "string" }, "employment_type": { "description": "The worker's employment type.\n\nExpandable field", "properties": { "amount_worked": { "description": "The amount worked for the employment type. * `FULL-TIME`: Full-time is at least 30 hours per week. Full-time workers will typically be eligible for benefits. * `PART-TIME`: Part-time is less than 30 hours per week. These workers may be eligible for benefits, depending on company settings and hours worked. * `TEMPORARY`: These workers are hired on a temporary basis. You can specify how each worker with this employment type will be paid individually.", "type": "string" }, "compensation_time_period": { "description": "The compensation period for the employment type. * `SALARIED`: Employees that are paid a fixed amount per year. * `HOURLY`: Employees that are paid a wage per hour worked.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "label": { "description": "The display label of the employment type.", "type": "string" }, "name": { "description": "The name of the employment type for non-custom employment types.", "type": "string" }, "type": { "description": "The classification of the worker by the company. * `CONTRACTOR`: Contractors are self-employed workers who provide services on a short-term or per-project basis and are not eligible for tax-withholding or benefits. * `EMPLOYEE`: Employees are hired and managed by an employer, work under the employer's direct supervision and control, and are protected by law for wages and employment rights.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "label", "updated_at" ], "title": "CompanyEmploymentType", "type": "object" }, "employment_type_id": { "description": "The worker's employment type.", "type": "string" }, "end_date": { "description": "The end date of the worker.", "type": "string" }, "ethnicity": { "description": "The identified ethnicity of the worker, if specified.", "type": "string" }, "gender": { "description": "The gender of the worker, if specified.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_manager": { "description": "Whether the worker is a manager", "type": "boolean" }, "job_function": { "description": "The worker's job function. When expanded, this field requires `job-functions.read`.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "Displayed name of the job function", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "JobFunction", "type": "object" }, "job_function_id": { "description": "ID of the worker's job function.", "type": "string" }, "legal_entity": { "description": "The worker's associated legal entity.\n\nExpandable field", "properties": { "company": { "description": "The company or organization associated with the legal entity\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "doing_business_as_name": { "description": "The doing business as name for the company.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_entities": { "description": "A list of the company's entities.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestLegalEntity" }, "type": "array" }, "legal_entities_id": { "description": "A list of the company's entities.", "items": { "type": "string" }, "type": "array" }, "legal_name": { "description": "The legal name of the company.", "type": "string" }, "name": { "description": "The name of the company.", "type": "string" }, "parent_legal_entity": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The company's ultimate holding entity.\n\nExpandable field", "type": "object" }, "parent_legal_entity_id": { "description": "The company's ultimate holding entity.", "type": "string" }, "phone": { "description": "The phone number for the company.", "type": "string" }, "physical_address": { "description": "The physical address of the holding entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "primary_email": { "description": "The email address used when registering this company.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "legal_entities", "legal_entities_id", "name", "updated_at" ], "title": "Company", "type": "object" }, "company_id": { "description": "The company or organization associated with the legal entity", "type": "string" }, "country": { "description": "The country the legal entity is based in.", "properties": { "code": { "description": "The code of the country.", "type": "string" } }, "required": [ "code" ], "title": "Country", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "entity_level": { "description": "The legal entity's level in a hierarchy. * `PARENT`: The legal entity is considered the ultimate holding entity. * `SUBSIDIARY`: The legal entity is considered a subsidiary, fully or partially held by another. * `BRANCH`: The legal entity is considered a branch, associated with a parent legal entity.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_name": { "description": "The legal name of the legal entity.", "type": "string" }, "mailing_address": { "description": "The mailing address of the legal entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "management_type": { "description": "The legal entity management type in the case of an employer of record (EOR) or professional employment organization (PEO). * `PEO`: The legal entity is considered a Professional Employment Organization (PEO). * `EOR`: The legal entity is considered an Employer of Record (EOR).", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The parent legal entity.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent legal entity.", "type": "string" }, "physical_address": { "description": "The physical address of the legal entity, if it differs from the mailing address.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "registration_date": { "description": "The registration date of the entity.", "type": "string" }, "tax_identifier": { "description": "The tax identifier for the legal entity.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "LegalEntity", "type": "object" }, "legal_entity_id": { "description": "The worker's associated legal entity.", "type": "string" }, "level": { "description": "The level of the worker.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "description": { "description": "The description of the level.", "type": "string" }, "experience_requirements": { "description": "The experience requirements for the level.", "type": "string" }, "global_level": { "anyOf": [ { "description": "Global level is used to track the seniority of levels. The higher up a level is placed on the page, the more senior and higher-ranked the level. Global level is used in workflows, policies, and reports that use the level attribute (e.g., you can use Level Lookup to set up a workflow that notifies the nearest person in an worker's management chain at or above the specified level).", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the level. Must be unique within the company or organization.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLevel", "description": "The parent level.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent level.", "type": "string" }, "rank": { "anyOf": [ { "description": "The rank of the level within its track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "scope_of_responsibilities": { "description": "The scope of responsibilities for the level.", "type": "string" }, "track": { "description": "The track associated with the level, if it's not a global level.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_default": { "description": "Whether this is the company's default track.", "type": "boolean" }, "name": { "description": "The name of the track. Must be unique within the company or organization.", "type": "string" }, "order": { "anyOf": [ { "description": "The one-based horizontal display order of the track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "start_global_level": { "anyOf": [ { "description": "The highest global level occupied by this track. Empty tracks return null.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Track", "type": "object" }, "track_id": { "description": "The track associated with the level. Required during creation. Include global_level when changing it.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Level", "type": "object" }, "level_id": { "description": "The level of the worker.", "type": "string" }, "location": { "description": "The location that the worker is mapped to for tax purposes. In the case that a worker is remote, the location's type is remote.", "properties": { "type": { "description": "The type of location.", "type": "string" }, "work_location_id": { "description": "The work location, if the worker isn't remote.", "type": "string" } }, "required": [ "type", "work_location_id" ], "title": "WorkerLocation", "type": "object" }, "manager": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's manager.\n\nExpandable field", "type": "object" }, "manager_id": { "description": "The worker's manager.", "type": "string" }, "number": { "anyOf": [ { "description": "The worker's number within the organization.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "original_start_date": { "description": "The worker's earliest start date across their employment history, excluding INIT roles.", "type": "string" }, "overtime_exemption": { "description": "The worker's overtime exemption status.", "type": "string" }, "pay_schedule_id": { "description": "The ID of the pay schedule currently associated with the worker.", "type": "string" }, "personal_email": { "description": "The worker's associated personal email address.", "type": "string" }, "race": { "description": "The identified race of the worker, if specified.", "type": "string" }, "start_date": { "description": "The start date of the worker.", "type": "string" }, "status": { "description": "The worker's status within the organization.", "type": "string" }, "teams": { "description": "The worker's assigned teams.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestTeamcb26bc28f32f" }, "type": "array" }, "teams_id": { "description": "The worker's assigned teams.", "items": { "type": "string" }, "type": "array" }, "termination_details": { "description": "The details of the worker's termination, if applicable.", "properties": { "reason": { "description": "This is a description that will be custom to each Rippling company.", "type": "string" }, "type": { "description": "The termination type indicates whether the termination was voluntary or involuntary.", "type": "string" } }, "title": "TerminationDetails", "type": "object" }, "title": { "description": "The worker's title.", "type": "string" }, "title_effective_date": { "description": "Title effective date", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "user": { "description": "The worker's associated user.\n\nExpandable field", "properties": { "active": { "description": "Whether the user is able to access company resources, typically when they are in actively engaged with the company and not after off-boarding.", "type": "boolean" }, "addresses": { "description": "The user's addresses.", "items": { "$ref": "#/components/schemas/OutputRestUserAddressedd59b9ba9a1" }, "type": "array" }, "created_at": { "description": "Record creation date", "type": "string" }, "display_name": { "description": "The display name of the user using either the concatenated preferred given and family name or username depending on availability.", "type": "string" }, "emails": { "description": "The user's email addresses.", "items": { "$ref": "#/components/schemas/OutputRestEmail5284c8258dc3" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "locale": { "description": "The User's default location for purposes of localization of currency, date time format, or numerical representations pursuant to RFC5646.", "type": "string" }, "name": { "description": "The user's name.", "properties": { "family_name": { "description": "The legal family name of the user, or last name in most Western languages.", "type": "string" }, "formatted": { "description": "The user's full name.", "type": "string" }, "given_name": { "description": "The given legal name of the user, or first name in most Western languages.", "type": "string" }, "middle_name": { "description": "The middle name(s) of the user.", "type": "string" }, "preferred_family_name": { "description": "The preferred family name, or last name in most Western languages, by the user.", "type": "string" }, "preferred_given_name": { "description": "The preferred given name, or first name in most Western languages, by the user.", "type": "string" } }, "title": "UserName", "type": "object" }, "number": { "description": "The permanent profile number of the user.", "type": "string" }, "phone_numbers": { "description": "The user's phone numbers.", "items": { "$ref": "#/components/schemas/OutputRestUserPhoneNumber12060c61ecf5" }, "type": "array" }, "photos": { "description": "The user's photos.", "items": { "$ref": "#/components/schemas/OutputRestUserPhoto2be7c3ae3f39" }, "type": "array" }, "preferred_language": { "description": "The User's preferred written or spoken language in the same format of the HTTP Accept-Language header, pursuant to Section 5.3.5 of RFC7231.", "type": "string" }, "timezone": { "description": "The User's current time zone in IANA database Olson format", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "username": { "description": "The unique identifier across Rippling used by the User for direct authentication into their associated company. Globally unique.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "User", "type": "object" }, "user_id": { "description": "The worker's associated user.", "type": "string" }, "work_email": { "description": "The worker's associated work email address.", "type": "string" }, "work_schedule": { "additionalProperties": { "$ref": "#/components/schemas/OutputRestWorkScheduleDay938f88d94f20" }, "description": "The worker's scheduled working hours for each day of the week.", "type": "object" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Worker", "type": "object" }, "RestApiAddressc035996f60ae": { "description": "", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "enum": [ "AF", "AX", "AL", "DZ", "AS", "AD", "AO", "AI", "AQ", "AG", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BY", "BE", "BZ", "BJ", "BM", "BT", "BO", "BQ", "BA", "BW", "BV", "BR", "IO", "BN", "BG", "BF", "BI", "CV", "KH", "CM", "CA", "KY", "CF", "TD", "CL", "CN", "CX", "CC", "CO", "KM", "CG", "CD", "CK", "CR", "CI", "HR", "CW", "CY", "CZ", "DK", "DJ", "DM", "DO", "EC", "EG", "SV", "GQ", "ER", "EE", "SZ", "ET", "FK", "FO", "FJ", "FI", "FR", "GF", "PF", "TF", "GA", "GM", "GE", "DE", "GH", "GI", "GR", "GL", "GD", "GP", "GU", "GT", "GG", "GN", "GW", "GY", "HT", "HM", "VA", "HN", "HK", "HU", "IS", "IN", "ID", "IQ", "IR", "IE", "IM", "IL", "IT", "JM", "JP", "JE", "JO", "KZ", "KE", "KI", "KR", "XK", "KW", "KG", "LA", "LV", "LB", "LS", "LR", "LY", "LI", "LT", "LU", "MO", "MG", "MW", "MY", "MV", "ML", "MT", "MH", "MQ", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MA", "MZ", "MM", "NA", "NR", "NP", "NL", "AN", "NC", "NZ", "NI", "NE", "NG", "NU", "NF", "MK", "MP", "NO", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PH", "PN", "PL", "PT", "PR", "QA", "RO", "RU", "RW", "RE", "BL", "SH", "KN", "LC", "MF", "PM", "VC", "WS", "SM", "ST", "SA", "SN", "RS", "SC", "SL", "SG", "SX", "SY", "SK", "SI", "SB", "SO", "ZA", "GS", "SS", "ES", "LK", "SD", "SR", "SJ", "SE", "CH", "TW", "TJ", "TZ", "TH", "TL", "TG", "TK", "TO", "TT", "TN", "TR", "TM", "TC", "TV", "UG", "UA", "AE", "GB", "US", "UM", "UY", "UZ", "VU", "VE", "VN", "VG", "VI", "WF", "EH", "YE", "ZM", "ZW" ], "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "enum": [ "HOME", "WORK", "OTHER" ], "type": "string" } }, "title": "Address", "type": "object" }, "RestApiAgentDeploymentRequestd90ba5e2ed2c": { "description": "", "properties": { "source_revision_id": { "description": "The ID of the source revision to deploy", "type": "string" } }, "required": [ "source_revision_id" ], "title": "AgentDeploymentRequest", "type": "object" }, "RestApiAgentRequest6608b6e689ad": { "description": "", "properties": { "api_name": { "description": "The API name of the agent", "type": "string" }, "description": { "description": "The description of the agent", "type": "string" }, "is_for_evals": { "description": "Whether the agent is used for evaluations", "type": "boolean" }, "name": { "description": "The display name of the agent", "type": "string" } }, "required": [ "api_name", "name" ], "title": "AgentRequest", "type": "object" }, "RestApiAgentSessionRequestfa0ca0b5fa98": { "description": "", "properties": { "agent_id": { "description": "The ID of the agent to run", "type": "string" }, "prompt": { "description": "The prompt to send to the agent", "type": "string" }, "session_resume_state": { "description": "Optional opaque state used to restore the new session", "properties": { "artifact": { "description": "An opaque base64-encoded agent session resume state", "type": "string" } }, "required": [ "artifact" ], "title": "SessionResumeState", "type": "object" } }, "required": [ "agent_id", "prompt" ], "title": "AgentSessionRequest", "type": "object" }, "RestApiAgentSourceFile075f135fe768": { "description": "", "properties": { "content": { "description": "The contents of the source file", "type": "string" }, "kind": { "description": "The source file language or format", "type": "string" }, "path": { "description": "The path of the source file", "type": "string" } }, "required": [ "content", "kind", "path" ], "title": "AgentSourceFile", "type": "object" }, "RestApiAgentSourceRevisionRequest0fd9fcd9ef18": { "description": "", "properties": { "entrypoint": { "description": "The entrypoint file", "type": "string" }, "files": { "description": "The files in the source revision", "items": { "$ref": "#/components/schemas/RestApiAgentSourceFile075f135fe768" }, "type": "array" } }, "required": [ "entrypoint", "files" ], "title": "AgentSourceRevisionRequest", "type": "object" }, "RestApiAgentUpdateRequeste904d29068e5": { "description": "", "properties": { "description": { "description": "The description of the agent", "type": "string" }, "name": { "description": "The display name of the agent", "type": "string" } }, "title": "AgentUpdateRequest", "type": "object" }, "RestApiAnnualScheduleTrigger9e9c8bf96230": { "additionalProperties": false, "properties": { "day_of_month": { "maximum": 31, "minimum": 1, "type": "integer" }, "hour": { "maximum": 23, "minimum": 0, "type": "integer" }, "kind": { "enum": [ "annual_schedule" ], "type": "string" }, "minute": { "default": 0, "maximum": 59, "minimum": 0, "type": "integer" }, "month_of_year": { "maximum": 12, "minimum": 1, "type": "integer" }, "timezone": { "type": "string" } }, "required": [ "day_of_month", "hour", "kind", "month_of_year", "timezone" ], "title": "AnnualScheduleTrigger", "type": "object" }, "RestApiBackgroundCheckCandidateRequest435d27af6ae6": { "description": "\n Background Check Candidate DTO.\n\n Represents a candidate who has been submitted for background check screening.\n\n Required on Create (but nullable on read for legacy rows):\n - email: Required for new candidates, but may be null on read for legacy rows\n - external_id: Required for new candidates, but may be null on read for legacy rows\n\n Optional Fields:\n - owner_id: May be null if no provider is associated\n - first_name: May be null if name is not available\n - last_name: May be null if name is not available\n - middle_name: May be null if not provided\n\n Sensitive Fields:\n - first_name, last_name, middle_name: Name fields are PII marked as sensitive in the model\n - These do not require separate OAuth scopes beyond the resource-level scopes\n (background-check-candidates.read / .read-write) because they are not updating\n role or worker data, only storing candidate names for background check processing\n\n Note: first_name, last_name, and middle_name are NOT filterable.\n Only external_id, email, created_at, and updated_at support filtering.\n ", "properties": { "email": { "description": "The email address of the candidate. Required on create, but may be null on read for legacy rows.", "type": "string" }, "external_id": { "description": "The provider's unique identifier for the candidate. Required on create, but may be null on read for legacy rows. Can only be set once (during creation or when null). Cannot be changed after being set.", "type": "string" }, "first_name": { "description": "The first name of the candidate.", "type": "string" }, "last_name": { "description": "The last name of the candidate.", "type": "string" }, "middle_name": { "description": "The middle name of the candidate.", "type": "string" } }, "required": [ "email", "external_id" ], "title": "BackgroundCheckCandidateRequest", "type": "object" }, "RestApiBiweeklyScheduleTriggerc261b277efb4": { "additionalProperties": false, "properties": { "days_of_week": { "items": { "type": "integer" }, "type": "array" }, "hour": { "maximum": 23, "minimum": 0, "type": "integer" }, "kind": { "enum": [ "biweekly_schedule" ], "type": "string" }, "minute": { "default": 0, "maximum": 59, "minimum": 0, "type": "integer" }, "timezone": { "type": "string" } }, "required": [ "days_of_week", "hour", "kind", "timezone" ], "title": "BiweeklyScheduleTrigger", "type": "object" }, "RestApiBreakRequestdaec83e5b054": { "description": "", "properties": { "break_type_id": { "description": "The ID of the break type.", "type": "string" }, "end_time": { "description": "The end time of the break.", "type": "string" }, "start_time": { "description": "The start time of the break.", "type": "string" } }, "title": "BreakRequest", "type": "object" }, "RestApiBulkDraftHireRequestb38591d07768": { "description": "", "properties": { "draft_hires": { "description": "List of draft hires", "items": { "$ref": "#/components/schemas/RestApiDraftHire9029618fc884" }, "type": "array" } }, "required": [ "draft_hires" ], "title": "BulkDraftHireRequest", "type": "object" }, "RestApiBulkEmployeeDocumentRequestRequest4e815c3ca0c5": { "description": "Top-level request body for `POST /employee-documents/`.", "properties": { "items": { "description": "List of role/document items to process. No limit on number of items; total documents across all items must not exceed 250.", "items": { "$ref": "#/components/schemas/RestApiEmployeeDocumentItema59fa8768046" }, "type": "array" } }, "required": [ "items" ], "title": "BulkEmployeeDocumentRequestRequest", "type": "object" }, "RestApiBusinessEventTrigger16af6dea9307": { "additionalProperties": false, "properties": { "event_name": { "type": "string" }, "kind": { "enum": [ "business_event" ], "type": "string" } }, "required": [ "event_name", "kind" ], "title": "BusinessEventTrigger", "type": "object" }, "RestApiBusinessPartnerGroupRequest9765bdaa9d1f": { "description": "", "properties": { "default_business_partner_id": { "description": "Id of Optional default business partner worker to whom all employees will be mapped if not explicitly mapped to a business partner in the group.", "type": "string" }, "domain": { "description": "Type of business partner group", "enum": [ "HR", "IT", "FINANCE", "RECRUITING", "OTHER" ], "type": "string" }, "name": { "description": "Name used to identify business partner group", "type": "string" } }, "required": [ "name" ], "title": "BusinessPartnerGroupRequest", "type": "object" }, "RestApiBusinessPartnerRequest7e2756c35994": { "description": "", "properties": { "business_partner_group_id": { "description": "Identifier of business partner group the business parter is a part of", "type": "string" }, "worker_id": { "description": "Identifier of worker who is the business partner", "type": "string" } }, "required": [ "business_partner_group_id", "worker_id" ], "title": "BusinessPartnerRequest", "type": "object" }, "RestApiBusinessStructurePathRequest5cf088885bd3": { "description": "", "properties": { "job_code_id": { "description": "The Job Code to place at this Business Structure path.", "type": "string" }, "parent_id": { "description": "Id of the parent BusinessStructurePath. None for root path.", "type": "string" } }, "required": [ "job_code_id" ], "title": "BusinessStructurePathRequest", "type": "object" }, "RestApiCreateHiresRequestebce6fbc5b1f": { "additionalProperties": false, "description": "", "properties": { "hires": { "description": "One to five hire submissions. Results are returned in the same order.", "items": { "$ref": "#/components/schemas/RestApiHireItemc77a47f89e3d" }, "type": "array" } }, "required": [ "hires" ], "title": "CreateHiresRequest", "type": "object" }, "RestApiCreateWorkflowActionExecutionRequest61e182d33ac7": { "properties": { "action_type": { "enum": [ "run_query" ], "type": "string" }, "payload": { "$ref": "#/components/schemas/RestApiRunQueryPayload0dca2531779e" }, "workflow_definition_id": { "type": "string" } }, "required": [ "action_type", "payload", "workflow_definition_id" ], "title": "CreateWorkflowActionExecutionRequest", "type": "object" }, "RestApiCronScheduleTrigger0679b602052c": { "additionalProperties": false, "properties": { "expression": { "type": "string" }, "kind": { "enum": [ "cron_schedule" ], "type": "string" }, "timezone": { "type": "string" } }, "required": [ "expression", "kind", "timezone" ], "title": "CronScheduleTrigger", "type": "object" }, "RestApiCustomAppRequestd4f45c40993f": { "description": "", "properties": { "api_name": { "description": "The unique api name of the custom app", "type": "string" }, "description": { "description": "The description of the custom app", "type": "string" }, "name": { "description": "The display name of the custom app", "type": "string" } }, "required": [ "api_name", "name" ], "title": "CustomAppRequest", "type": "object" }, "RestApiCustomFieldInfo4d6ce3092a37": { "description": "Custom field information for a draft hire.\n\n Custom fields are associated with RoleWithCompany model.\n ", "properties": { "field_name": { "description": "Name of the custom field", "type": "string" }, "field_value": { "description": "Value of the custom field", "type": "object" } }, "required": [ "field_name", "field_value" ], "title": "CustomFieldInfo", "type": "object" }, "RestApiCustomPageRequest2e7e485fe8d2": { "description": "", "properties": { "function_id": { "description": "The ID of the Rippling Function that renders this page", "type": "string" }, "name": { "description": "The display name of the custom page", "type": "string" } }, "title": "CustomPageRequest", "type": "object" }, "RestApiCustomScheduleTriggerdb31666e4bdd": { "additionalProperties": false, "properties": { "day_of_month": { "anyOf": [ { "maximum": 31, "minimum": 1, "type": "integer" }, { "type": "null" } ] }, "days_of_week": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ] }, "hour": { "default": 0, "maximum": 23, "minimum": 0, "type": "integer" }, "interval": { "minimum": 1, "type": "integer" }, "kind": { "enum": [ "custom_schedule" ], "type": "string" }, "minute": { "default": 0, "maximum": 59, "minimum": 0, "type": "integer" }, "month_of_year": { "anyOf": [ { "maximum": 12, "minimum": 1, "type": "integer" }, { "type": "null" } ] }, "start_month": { "anyOf": [ { "maximum": 12, "minimum": 1, "type": "integer" }, { "type": "null" } ] }, "timezone": { "type": "string" }, "unit": { "enum": [ "minutes", "hours", "days", "weeks", "months", "years" ], "type": "string" } }, "required": [ "interval", "kind", "timezone", "unit" ], "title": "CustomScheduleTrigger", "type": "object" }, "RestApiDailyScheduleTriggerf828f14d1d97": { "additionalProperties": false, "properties": { "hour": { "maximum": 23, "minimum": 0, "type": "integer" }, "kind": { "enum": [ "daily_schedule" ], "type": "string" }, "minute": { "default": 0, "maximum": 59, "minimum": 0, "type": "integer" }, "timezone": { "type": "string" } }, "required": [ "hour", "kind", "timezone" ], "title": "DailyScheduleTrigger", "type": "object" }, "RestApiDepartmentRequest07aab47a5cd2": { "description": "", "properties": { "name": { "description": "The name of the department.", "type": "string" }, "parent_id": { "description": "The parent department.", "type": "string" }, "reference_code": { "description": "Reference code of the department.", "type": "string" } }, "required": [ "name" ], "title": "DepartmentRequest", "type": "object" }, "RestApiDepartmentUpdateRequest100ac2202a91": { "description": "", "properties": { "name": { "description": "The name of the department.", "type": "string" }, "parent_id": { "description": "The parent department.", "type": "string" }, "reference_code": { "description": "Reference code of the department.", "type": "string" } }, "title": "DepartmentUpdateRequest", "type": "object" }, "RestApiDeveloperProgramApplyDTORequest318382c66db1": { "description": "Developer Program application resource for Path B existing-company apply.", "properties": { "build_description": { "description": "What the company plans to build on Rippling", "type": "string" }, "entrypoint": { "description": "Apply entrypoint: llm_cli_apply or web_apply", "enum": [ "llm_cli_apply", "web_apply" ], "type": "string" } }, "title": "DeveloperProgramApplyDTORequest", "type": "object" }, "RestApiDraftHire9029618fc884": { "description": "\n A draft hire represents a candidate who has been offered a position but hasn't started yet.\n\n This class provides Platform API access to draft hire data stored as RoleWithCompany instances\n in a candidate state, allowing external systems to create and manage draft hires.\n ", "properties": { "custom_fields": { "description": "Custom fields for the draft hire", "items": { "$ref": "#/components/schemas/RestApiCustomFieldInfo4d6ce3092a37" }, "type": "array" }, "documents": { "description": "Documents to attach to this draft hire", "items": { "$ref": "#/components/schemas/RestApiDraftHireDocument8f403bf65740" }, "type": "array" }, "employment_info": { "description": "Employment information for the draft hire position", "properties": { "contract_end_date": { "description": "Contract end date", "type": "string" }, "currency": { "description": "Currency", "type": "string" }, "department_id": { "description": "Department ID", "type": "string" }, "duties": { "description": "Duties", "type": "string" }, "eeoc_job_classification": { "description": "EEOC job classification (e.g., EXECUTIVE, MID_LEVEL, PROFESSIONALS, TECHNICIANS, SALES_WORKERS, SUPPORT_WORKERS, CRAFT_WORKERS, OPERATIVES, HELPERS, SERVICE_WORKERS)", "type": "string" }, "employment_type_id": { "description": "Employment type ID", "type": "string" }, "equity_num_shares": { "description": "Equity number of shares", "type": "integer" }, "equity_value": { "description": "Equity value", "type": "number" }, "equity_vesting_schedule": { "$ref": "#/components/schemas/RestApiEquityVestingSchedule8bd01ba05f86" }, "job_family_id": { "description": "Job family ID", "type": "string" }, "job_title": { "description": "Job title", "type": "string" }, "legal_entity_id": { "description": "Legal entity ID", "type": "string" }, "level_id": { "description": "Level ID", "type": "string" }, "manager_id": { "description": "Manager ID", "type": "string" }, "offer_expiration_date": { "description": "Offer expiration date", "type": "string" }, "on_target_commission": { "description": "On target commission", "type": "number" }, "overtime_exemption": { "description": "Overtime exemption", "enum": [ "exempt", "non-exempt" ], "type": "string" }, "probation_end_date": { "description": "Probation end date", "type": "string" }, "relocation_reimbursement": { "description": "Relocation reimbursement", "type": "number" }, "salary_per_unit": { "description": "Salary per unit", "type": "number" }, "salary_unit": { "description": "Salary unit", "type": "string" }, "signing_bonus": { "description": "Signing bonus", "type": "number" }, "start_date": { "description": "Start date", "type": "string" }, "target_annual_bonus": { "description": "Target annual bonus", "type": "number" }, "target_annual_bonus_percent": { "description": "Target annual bonus as a percentage", "type": "number" }, "teams_ids": { "description": "Teams IDs", "items": { "type": "string" }, "type": "array" }, "title": { "description": "Title", "type": "string" }, "weekly_hours": { "description": "Weekly hours", "type": "number" }, "work_email": { "description": "Work email", "type": "string" } }, "required": [ "employment_type_id", "title" ], "title": "EmploymentInfo", "type": "object" }, "headcount_info": { "description": "Headcount planning info for hiring into a position. If provided, the draft hire will be linked to the specified open headcount allocation. Requires headcount planning to be enabled for the company.", "properties": { "position_id": { "description": "The Position ID (PID) of the headcount allocation to fill (e.g., PID100615)", "type": "string" } }, "required": [ "position_id" ], "title": "HeadcountInfo", "type": "object" }, "personal_info": { "description": "Personal information for the draft hire candidate", "properties": { "citizenship": { "description": "Citizenship of the candidate", "type": "string" }, "date_of_birth": { "description": "Date of birth", "type": "string" }, "emergency_contact_name": { "description": "Emergency contact name", "type": "string" }, "emergency_contact_phone": { "$ref": "#/components/schemas/RestApiPhoneNumberab1fa08a2f90" }, "ethnicity": { "description": "Ethnicity of the candidate", "type": "string" }, "gender": { "description": "Gender of the candidate", "type": "string" }, "home_address": { "$ref": "#/components/schemas/RestApiAddressc035996f60ae" }, "invite_email": { "description": "Invite email of the candidate", "type": "string" }, "locale": { "$ref": "#/components/schemas/RestApiLocaleSettings284990cf4952" }, "name": { "$ref": "#/components/schemas/RestApiNameeb1a23b03ab6" }, "personal_phone": { "$ref": "#/components/schemas/RestApiPhoneNumber3992736116a5" }, "race": { "description": "Race of the candidate", "type": "string" }, "ssn": { "description": "Social security number of the candidate", "type": "string" } }, "required": [ "invite_email", "name" ], "title": "PersonalInfo", "type": "object" }, "work_location_info": { "description": "Work location information", "properties": { "country_code": { "description": "Country code of the work location", "type": "string" }, "is_remote": { "description": "Whether the work location is remote", "type": "boolean" }, "location_id": { "description": "Work location ID", "type": "string" }, "state_code": { "description": "State code of the work location", "type": "string" } }, "title": "WorkLocationInfo", "type": "object" } }, "required": [ "employment_info", "personal_info", "work_location_info" ], "title": "DraftHire", "type": "object" }, "RestApiDraftHireDocument8f403bf65740": { "description": "A document to attach to a draft hire, referencing a pre-uploaded file.", "properties": { "file_id": { "description": "Id of a FileUploadTracker in ACTIVE status whose file should become a document on the hire", "type": "string" }, "name": { "description": "Document name. Defaults to the uploaded file name when omitted.", "type": "string" }, "signature_date": { "description": "Signature date in YYYY-MM-DD format.", "type": "string" } }, "required": [ "file_id" ], "title": "DraftHireDocument", "type": "object" }, "RestApiDraftTransitionCreateRequestRequest6cfa872c5e06": { "description": "", "properties": { "effective_at": { "description": "Effective timestamp applied to the entire draft transition request.", "type": "string" }, "items": { "description": "Draft transition items to accept for asynchronous processing.", "items": { "$ref": "#/components/schemas/RestApiDraftTransitionItemRequestcef9f09f47d2" }, "type": "array" }, "timezone": { "description": "IANA timezone used to interpret and display the request's effective timestamp.", "type": "string" } }, "required": [ "effective_at", "items", "timezone" ], "title": "DraftTransitionCreateRequestRequest", "type": "object" }, "RestApiDraftTransitionItemRequestcef9f09f47d2": { "description": "", "properties": { "changes": { "description": "Requested role/profile changes for this item.", "properties": { "country_specific_info": { "description": "Country-specific field changes supported by current draft transition flows.", "type": "object" }, "employment_info": { "description": "Employment information changes for the target role.", "properties": { "annual_salary_equivalent": { "description": "New annual salary equivalent.", "type": "number" }, "currency": { "description": "New compensation currency.", "type": "string" }, "department_id": { "description": "New department identifier for the target role.", "type": "string" }, "employment_type_id": { "description": "New company employment type identifier for the target role.", "type": "string" }, "equity_num_shares": { "description": "New offer letter equity share count.", "type": "integer" }, "equity_value": { "description": "New offer letter equity value.", "type": "number" }, "equity_vesting_package_id": { "description": "New equity vesting package identifier.", "type": "string" }, "job_family_id": { "description": "New job family identifier for the target role.", "type": "string" }, "level_id": { "description": "New level identifier for the target role.", "type": "string" }, "manager_id": { "description": "New manager role identifier for the target role.", "type": "string" }, "on_target_commission": { "description": "New annual on-target commission amount.", "type": "number" }, "relocation_reimbursement": { "description": "New relocation reimbursement amount.", "type": "number" }, "salary_per_unit": { "description": "New compensation amount per salary unit.", "type": "number" }, "salary_unit": { "description": "New salary unit.", "type": "string" }, "start_date": { "description": "New start date for the target role.", "type": "string" }, "target_annual_bonus": { "description": "New target annual bonus amount.", "type": "number" }, "target_annual_bonus_payment_frequency_unit": { "description": "New target annual bonus payment frequency.", "enum": [ "MONTH", "QUARTER", "YEAR", "SEMI_ANNUAL" ], "type": "string" }, "target_annual_bonus_percent": { "description": "New target annual bonus percentage.", "type": "number" }, "teams_ids": { "description": "New team identifiers for the target role.", "items": { "type": "string" }, "type": "array" }, "title": { "description": "New job title for the target role.", "type": "string" } }, "title": "DraftTransitionEmploymentInfoChangesRequest", "type": "object" }, "work_location_info": { "description": "Work location changes for the target role.", "properties": { "country_code": { "description": "New work country code for the target role.", "type": "string" }, "location_id": { "description": "New work location identifier for the target role.", "type": "string" } }, "title": "DraftTransitionWorkLocationInfoChangesRequest", "type": "object" } }, "title": "DraftTransitionChangesRequest", "type": "object" }, "draft_grouping_preference": { "description": "Controls whether this item should append to a compatible existing draft or create a new draft.", "enum": [ "APPEND_TO_MATCHING_DRAFT", "CREATE_NEW_DRAFT" ], "type": "string" }, "role_id": { "description": "Target role identifier for this draft transition item.", "type": "string" } }, "required": [ "changes", "role_id" ], "title": "DraftTransitionItemRequest", "type": "object" }, "RestApiEarningsInputRequest89b4158946d7": { "description": "\n V2 DTO representing an external earnings input record.\n\n Used by:\n - GET /earnings-inputs/ (list)\n ", "properties": { "amount": { "description": "Earning amount as a string-encoded decimal.", "type": "string" }, "assignment_type": { "description": "How the earning is assigned (e.g. BY_PAY_PERIOD).", "type": "string" }, "company_entity_id": { "description": "Identifier for the legal entity (company entity relationship) this earning is associated with. Use this to correlate earnings with a specific legal entity in a multi-entity company.", "type": "string" }, "earning_code": { "description": "Code identifying the earning type (e.g. regular_salary).", "type": "string" }, "earning_end_date": { "description": "End of the period this earning was earned. Used for regular-rate-of-pay (RROP) attribution. Distinct from pay_period_basis_date, which selects the pay run.", "type": "string" }, "earning_start_date": { "description": "Start of the period this earning was earned. Used for regular-rate-of-pay (RROP) attribution. Distinct from pay_period_basis_date, which selects the pay run.", "type": "string" }, "external_id": { "description": "External reference identifier for this earning.", "type": "string" }, "hours": { "description": "Hours associated with this earning as a string-encoded decimal.", "type": "string" }, "is_overridden": { "description": "Whether this earning's amount was manually overridden instead of using the calculated value. Always false for newly created earnings.", "type": "boolean" }, "pay_period_basis_date": { "description": "The pay period basis date for this earning.", "type": "string" }, "run_id": { "description": "Identifier of the payroll run this earning is assigned to, if any.", "type": "string" }, "status": { "description": "Current status of the earnings input (e.g. UNASSIGNED, ASSIGNED).", "type": "string" }, "time_labels": { "description": "Time tracking labels associated with this earning.", "items": { "type": "string" }, "type": "array" }, "worker_id": { "description": "Identifier of the worker (role ID).", "type": "string" } }, "title": "EarningsInputRequest", "type": "object" }, "RestApiEmployeeDocumentItema59fa8768046": { "description": "A single item: attach `documents` to the worker identified by `worker_id`.", "properties": { "documents": { "description": "Documents to attach to the role. At least one required. Each entry references a FileUploadTracker by file_id.", "items": { "$ref": "#/components/schemas/RestApiDraftHireDocument8f403bf65740" }, "type": "array" }, "folder_id": { "description": "Optional destination folder for documents. Accepts either: (1) an ObjectId string for custom folders, or (2) a default folder identifier ('root', 'confidential_documents', 'notices', 'work_authorization'). When omitted, documents land at the root of the worker's profile (current default behavior). When supplied, the folder must exist, be in an active state, be provisioned for the target worker, and the caller must have UPLOAD permission on it — otherwise behavior is governed by `on_invalid_folder`.", "type": "string" }, "on_invalid_folder": { "description": "Fallback behavior when `folder_id` is supplied but inaccessible. 'fail' (default) rejects each affected document with FOLDER_ACCESS_ERROR. 'fallback_to_root' uploads to the worker's root profile instead and attaches a FOLDER_ACCESS_FALLBACK warning to each result. Ignored when `folder_id` is omitted.", "enum": [ "fail", "fallback_to_root" ], "type": "string" }, "worker_id": { "description": "Id of the worker to attach documents to.", "type": "string" } }, "required": [ "documents", "worker_id" ], "title": "EmployeeDocumentItem", "type": "object" }, "RestApiEquityVestingSchedule8bd01ba05f86": { "description": "Equity vesting schedule", "properties": { "_name": { "description": "Name of the vesting schedule", "type": "string" }, "cliffMonths": { "description": "Number of cliff months before vesting begins", "type": "integer" }, "company_id": { "description": "Required company ID for the vesting schedule", "type": "string" }, "continuousVestingMonths": { "description": "Number of continuous vesting months", "type": "integer" }, "percentageInitialVesting": { "description": "Percentage of initial vesting as decimal", "format": "decimal", "type": "number" }, "spokeId": { "description": "Spoke ID for the vesting schedule", "type": "string" }, "totalVestingMonths": { "description": "Total number of vesting months", "type": "integer" }, "totalVestingYears": { "description": "Total number of vesting years", "type": "integer" }, "vestingType": { "description": "Type of vesting schedule", "type": "string" } }, "required": [ "company_id" ], "title": "EquityVestingSchedule", "type": "object" }, "RestApiFileDocumentDTORequest1dc4192aa39c": { "description": "Response DTO for ``POST /files/`` and ``GET /files/{id}``.", "properties": { "content_type": { "description": "MIME type supplied by the client at create time", "type": "string" }, "display_name": { "description": "Human-readable label for the file", "type": "string" }, "status": { "description": "Lifecycle status: awaiting_upload | uploaded | active | infected", "type": "string" }, "upload_fields": { "description": "Required form fields to include in the multipart POST to S3 alongside the file binary", "type": "object" }, "upload_url": { "description": "S3 endpoint URL — POST your multipart form here to upload the file. Present only in the create response.", "type": "string" }, "url_data": { "description": "URLs for accessing the uploaded file after a successful upload", "properties": { "preview_url": { "description": "CDN URL for previewing the uploaded file after upload completes", "type": "string" }, "s3_url": { "description": "S3 URL where the file is accessible after upload", "type": "string" } }, "title": "UrlDataDTO", "type": "object" } }, "required": [ "status" ], "title": "FileDocumentDTORequest", "type": "object" }, "RestApiFunctionDeploymentRequest4d8a4887fc10": { "description": "", "properties": { "allowed_domains": { "description": "Domains that function runs from this deployment are allowed to access", "items": { "type": "string" }, "type": "array" }, "code": { "description": "The code for the deployment", "type": "string" }, "dependencies": { "description": "The dependencies of the deployment", "type": "object" }, "io_contract": { "description": "Input and output JSON Schema contracts for the deployment", "type": "object" }, "options": { "description": "Additional, runtime-specific options for the deployment", "type": "object" }, "runtime": { "description": "The runtime for the deployment", "type": "string" } }, "title": "FunctionDeploymentRequest", "type": "object" }, "RestApiFunctionExecutionRequest802a58bde9f4": { "description": "", "properties": { "inputs": { "description": "The inputs of the execution", "type": "object" } }, "required": [ "inputs" ], "title": "FunctionExecutionRequest", "type": "object" }, "RestApiFunctionRequestf410e35f75b5": { "description": "", "properties": { "api_name": { "description": "The API name of the function", "type": "string" }, "code_draft": { "description": "The current draft of code for the function", "type": "string" }, "dependencies": { "description": "The dependencies of the function", "type": "object" }, "description": { "description": "The function description", "type": "string" }, "is_async": { "description": "Whether this function runs asynchronously", "type": "boolean" }, "name": { "description": "The function name", "type": "string" }, "source_upload": { "description": "Optional source ZIP checksum and size for request functions only. Create or update returns ephemeral source_upload_instructions; this input is not returned.", "properties": { "sha256": { "description": "SHA-256 of the exact ZIP bytes, written as 64 lowercase hexadecimal characters.", "type": "string" }, "size_bytes": { "description": "Exact ZIP size in bytes, from 1 through 67108864 (64 MiB).", "type": "integer" } }, "required": [ "sha256", "size_bytes" ], "title": "FunctionSourceUploadMetadata", "type": "object" }, "type": { "description": "Function type at creation. Defaults to event and cannot be changed afterward.", "enum": [ "event", "request" ], "type": "string" } }, "title": "FunctionRequest", "type": "object" }, "RestApiFunctionUpdateRequestacecc4938a56": { "description": "", "properties": { "code_draft": { "description": "The current draft of code for the function", "type": "string" }, "dependencies": { "description": "The dependencies of the function", "type": "object" }, "description": { "description": "The function description", "type": "string" }, "name": { "description": "The function name", "type": "string" }, "source_upload": { "description": "Optional source ZIP checksum and size for request functions only. Create or update returns ephemeral source_upload_instructions; this input is not returned.", "properties": { "sha256": { "description": "SHA-256 of the exact ZIP bytes, written as 64 lowercase hexadecimal characters.", "type": "string" }, "size_bytes": { "description": "Exact ZIP size in bytes, from 1 through 67108864 (64 MiB).", "type": "integer" } }, "required": [ "sha256", "size_bytes" ], "title": "FunctionSourceUploadMetadata", "type": "object" } }, "title": "FunctionUpdateRequest", "type": "object" }, "RestApiHireCustomField283dc7b70c45": { "additionalProperties": false, "description": "", "properties": { "field_id": { "description": "Identifier of a company-configured custom field collected during hiring. Use a field configured for the hiring company.", "type": "string" }, "value": { "description": "Value for the selected custom field. Its JSON type and allowed options depend on that field's configuration in Rippling.", "type": "object" } }, "required": [ "field_id", "value" ], "title": "HireCustomField", "type": "object" }, "RestApiHireItemc77a47f89e3d": { "additionalProperties": false, "description": "One hire on POST /hires/. Country-specific employment fields come from GET /hire-requirements/.", "properties": { "client_request_id": { "description": "Optional id echoed on that hire's result. Not a hire field.", "type": "string" }, "compensation": { "additionalProperties": false, "description": "Base pay and any additional compensation offered for this job. Monetary values contain an ISO 4217 currency code and decimal amount.", "properties": { "base_pay_amount": { "description": "Gross base-pay rate for one base_pay_period, before bonuses, commission, equity, or allowances. Provide currency_type as a three-letter ISO 4217 code and value as a nonnegative decimal amount. Use zero when the hire has no base pay, including supported zero-pay contractor arrangements.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "description": "The decimal amount for the currency.", "type": "number" } }, "title": "Currency", "type": "object" }, "base_pay_period": { "description": "Unit of time represented by base_pay_amount: YEAR, MONTH, WEEK, DAY, or HOUR. For example, an annual salary uses YEAR and an hourly rate uses HOUR. Starting with API version 2025-08-01, contractor PAY_AS_YOU_GO compensation requires HOUR, MILESTONE requires YEAR, and FIXED accepts any listed unit.", "enum": [ "YEAR", "MONTH", "WEEK", "DAY", "HOUR" ], "type": "string" }, "commission": { "additionalProperties": false, "description": "Variable sales compensation expected when the person meets target. on_target_amount is required; provide payment_frequency where required by GET /hire-requirements/. Starting with API version 2025-08-01, this field does not apply to contractor hires and is reported in ignored_fields.", "properties": { "on_target_amount": { "description": "Expected total commission for a full year when the person meets target, using currency_type as a three-letter ISO 4217 code and value as the decimal amount.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "description": "The decimal amount for the currency.", "type": "number" } }, "title": "Currency", "type": "object" }, "payment_frequency": { "description": "How often commission is paid: MONTH, QUARTER, or YEAR. Required when indicated by GET /hire-requirements/ for the selected country and hire type.", "enum": [ "MONTH", "QUARTER", "YEAR" ], "type": "string" } }, "required": [ "on_target_amount" ], "title": "Commission", "type": "object" }, "equity": { "additionalProperties": false, "description": "Equity grant offered with the job. amount is the grant's monetary value; num_shares and frequency provide additional grant terms when known. Starting with API version 2025-08-01, this field does not apply to contractor hires and is reported in ignored_fields.", "properties": { "amount": { "description": "Monetary value assigned to the equity grant, using currency_type as a three-letter ISO 4217 code and value as the decimal amount.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "description": "The decimal amount for the currency.", "type": "number" } }, "title": "Currency", "type": "object" }, "frequency": { "description": "Grant frequency when applicable: ONE_TIME or ANNUAL.", "enum": [ "ONE_TIME", "ANNUAL" ], "type": "string" }, "num_shares": { "description": "Number of shares or units included in the grant, when the grant is expressed in shares.", "type": "integer" } }, "required": [ "amount" ], "title": "EquityGrant", "type": "object" }, "relocation": { "additionalProperties": false, "description": "One-time relocation reimbursement or benefit offered for this hire. amount is required when the object is provided. Starting with API version 2025-08-01, this field does not apply to contractor hires and is reported in ignored_fields.", "properties": { "amount": { "description": "Total relocation reimbursement or benefit, using currency_type as a three-letter ISO 4217 code and value as the decimal amount.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "description": "The decimal amount for the currency.", "type": "number" } }, "title": "Currency", "type": "object" } }, "required": [ "amount" ], "title": "RelocationBenefit", "type": "object" }, "remote_working_allowance": { "description": "Recurring allowance paid for remote-work expenses. Provide only when listed by GET /hire-requirements/ for the selected country and hire type; use a zero amount when the catalog requires the field but no allowance is offered.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "description": "The decimal amount for the currency.", "type": "number" } }, "title": "Currency", "type": "object" }, "signing_bonus": { "additionalProperties": false, "description": "One-time payment offered for accepting or starting the job. When provided, amount and schedule are required; payment_days is optional. Starting with API version 2025-08-01, this field does not apply to contractor hires and is reported in ignored_fields.", "properties": { "amount": { "description": "Total one-time signing bonus, using currency_type as a three-letter ISO 4217 code and value as the decimal amount.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "description": "The decimal amount for the currency.", "type": "number" } }, "title": "Currency", "type": "object" }, "payment_days": { "description": "Number of days after the applicable start or schedule event when the bonus is paid, if used.", "type": "integer" }, "schedule": { "description": "Payment event or schedule for the signing bonus, for example FIRST_PAYROLL. Use an allowed value returned by GET /hire-requirements/.", "type": "string" } }, "required": [ "amount", "schedule" ], "title": "SigningBonus", "type": "object" }, "target_bonus": { "additionalProperties": false, "description": "Bonus earned for meeting the role's target performance. Express the target as exactly one of a monetary amount or a percentage of base pay; provide payment_frequency where required by GET /hire-requirements/. Starting with API version 2025-08-01, this field does not apply to contractor hires and is reported in ignored_fields.", "properties": { "amount": { "description": "Target bonus amount using currency_type as a three-letter ISO 4217 code and value as the decimal amount. Provide exactly one of amount or percent.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "description": "The decimal amount for the currency.", "type": "number" } }, "title": "Currency", "type": "object" }, "payment_frequency": { "description": "How often the target bonus is paid: MONTH, QUARTER, SEMI_ANNUAL, or YEAR. Required when indicated by GET /hire-requirements/ for the selected country and hire type.", "enum": [ "MONTH", "QUARTER", "SEMI_ANNUAL", "YEAR" ], "type": "string" }, "percent": { "description": "Target bonus as a percentage of base pay, written as a numeric string without the percent sign, for example 15. Provide exactly one of amount or percent.", "type": "string" } }, "title": "TargetBonus", "type": "object" }, "thirteenth_month_bonus": { "description": "Contractually required thirteenth-month salary payment. Provide only when listed by GET /hire-requirements/ for the selected country and hire type.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "description": "The decimal amount for the currency.", "type": "number" } }, "title": "Currency", "type": "object" } }, "title": "HireCompensation", "type": "object" }, "custom_fields": { "description": "Values for company-configured custom fields collected during hiring. Use each field's configured ID and value shape; omit this array when no custom hiring fields are being supplied.", "items": { "$ref": "#/components/schemas/RestApiHireCustomField283dc7b70c45" }, "type": "array" }, "employment": { "additionalProperties": false, "description": "The job: title, hours, and country-specific details.", "properties": { "authorized_to_work": { "description": "Whether the person is legally authorized to work in the work_location country. Provide only when listed by GET /hire-requirements/; true confirms authorization and false may make the hire ineligible.", "type": "boolean" }, "collective_bargaining": { "additionalProperties": false, "description": "Collective-bargaining coverage and the applicable agreement identifiers.", "properties": { "agreement_code": { "description": "Official country-specific identifier of the applicable collective bargaining agreement. This is an external statutory code, not a Rippling resource ID; GET /hire-requirements/ describes its source and format for the selected country.", "type": "string" }, "agreement_name": { "description": "Name of the employer's applicable collective labor or bargaining agreement. Provide it only when a named agreement applies; other union activity does not require a name. Use an allowed value from GET /hire-requirements/.", "type": "string" }, "area": { "description": "Geographic or industry area governed by the agreement.", "type": "string" }, "coverage": { "description": "Whether a collective bargaining agreement covers the worker.", "enum": [ "COVERED", "NOT_COVERED" ], "type": "string" }, "group": { "description": "Worker group or category within the applicable agreement.", "type": "string" }, "has_union_activity": { "description": "Whether the employer has a collective labor agreement, collective bargaining agreement, or other union activity in place. This is an employer-level fact and is distinct from whether an agreement covers this worker.", "type": "boolean" } }, "title": "HireCollectiveBargaining", "type": "object" }, "company_uses_digital_currency": { "description": "Whether the hiring company conducts business involving cryptocurrency or another digital currency. Required for China EOR hires. A true value may make the hire ineligible for the selected EOR service.", "type": "boolean" }, "contract": { "additionalProperties": false, "description": "Employment term: ongoing with no predetermined end or fixed for a defined term.", "properties": { "duration": { "additionalProperties": false, "description": "Exact fixed-term length. Use only with type FIXED; omit for INDEFINITE.", "properties": { "unit": { "description": "Duration unit: DAYS, WEEKS, MONTHS, or YEARS.", "enum": [ "DAYS", "WEEKS", "MONTHS", "YEARS" ], "type": "string" }, "value": { "description": "Positive number of duration units.", "type": "integer" } }, "required": [ "unit", "value" ], "title": "ContractDuration", "type": "object" }, "minimum_guaranteed_duration": { "additionalProperties": false, "description": "Minimum contract length guaranteed to the worker, distinct from the exact total duration.", "properties": { "unit": { "description": "Duration unit: DAYS, WEEKS, MONTHS, or YEARS.", "enum": [ "DAYS", "WEEKS", "MONTHS", "YEARS" ], "type": "string" }, "value": { "description": "Positive number of duration units.", "type": "integer" } }, "required": [ "unit", "value" ], "title": "ContractDuration", "type": "object" }, "mission": { "additionalProperties": false, "description": "Mission-specific contract facts, only when listed by GET /hire-requirements/.", "properties": { "description": { "description": "Description of the mission or project. Required when has_defined_timeline is true; omit when there is no defined mission timeline.", "type": "string" }, "has_defined_timeline": { "description": "Whether the assignment or project has a defined completion timeline.", "type": "boolean" } }, "required": [ "has_defined_timeline" ], "title": "ContractMission", "type": "object" }, "type": { "description": "Whether employment is ongoing or fixed-term. Use INDEFINITE when there is no predetermined end and FIXED when the employment is limited to a defined term.", "enum": [ "FIXED", "INDEFINITE" ], "type": "string" } }, "required": [ "type" ], "title": "EmploymentContract", "type": "object" }, "contractor_paying_entity_type": { "description": "COMPANY_OWN_ENTITY hires the contractor on the company's own legal entity. Send that entity in employment.legal_entity_id. Send this when the company is fully migrated to Global Payroll and the work location is in a Contractor of Record state. Omit for non-contractor hires. When the hiring flow requires it and it is omitted, the hire stays incomplete.", "enum": [ "COMPANY_OWN_ENTITY" ], "type": "string" }, "department_id": { "description": "Department id from GET /departments/.", "type": "string" }, "duties": { "description": "Plain-text summary of the role's primary responsibilities and day-to-day work.", "type": "string" }, "employment_model": { "description": "Employment model for a Germany EOR hire. Use AUG for employee leasing or CONSULTANT for a remote consultant engagement. CONSULTANT is valid only when work_location.is_remote is true.", "enum": [ "AUG", "CONSULTANT" ], "type": "string" }, "employment_type_id": { "description": "Employment type id from GET /employment-types/. Starting with API version 2025-08-01, a contractor employment type changes which fields are required or ignored. Call GET /hire-requirements/ for the applicable rules.", "type": "string" }, "engagement": { "additionalProperties": false, "description": "Professional field and consulting-project details required by the hire context.", "properties": { "consulting_project_description": { "description": "Description of the client project and the work the worker will perform.", "type": "string" }, "field_of_work": { "description": "Professional field in which the worker will perform the engagement.", "type": "string" } }, "required": [ "consulting_project_description", "field_of_work" ], "title": "HireEngagementDetails", "type": "object" }, "eor_costs_acknowledged": { "description": "Confirms that the caller has reviewed and accepts the estimated EOR costs and applicable Rippling EOR terms for this hire. Required for EOR hires and must be true; false means the hire cannot proceed. See https://help.rippling.com/s/article/850659217136 and https://app.rippling.com/legal/eor.", "type": "boolean" }, "eor_eligibility_terms_acknowledged": { "description": "Confirms that the caller has reviewed and accepts Rippling's EOR eligibility conditions for this proposed hire, including the EOR screenout guidance. Required for EOR hires and must be true; false means the hire cannot proceed. See https://help.rippling.com/s/article/757822852718.", "type": "boolean" }, "framework_agreement": { "additionalProperties": false, "description": "Additional German framework-agreement clauses that are not already represented by compensation, hours, or vacation.", "properties": { "additional_benefits": { "description": "Additional benefits stated in the framework agreement.", "type": "string" }, "continued_remuneration_terms": { "description": "Framework-agreement continued-remuneration terms.", "type": "string" }, "other_working_conditions": { "description": "Other essential working conditions in the framework agreement.", "type": "string" }, "overtime_pay_terms": { "description": "Framework-agreement overtime-pay terms.", "type": "string" }, "rest_periods": { "description": "Rest-period terms stated in the framework agreement.", "type": "string" }, "shared_facilities": { "description": "Shared facilities available to the worker.", "type": "string" }, "surcharges": { "description": "Surcharges required by the framework agreement.", "type": "string" }, "variable_compensation_terms": { "description": "Framework-agreement variable-compensation terms.", "type": "string" }, "work_wear": { "description": "Functional workwear supplied for the engagement.", "type": "string" } }, "required": [ "additional_benefits", "continued_remuneration_terms", "other_working_conditions", "overtime_pay_terms", "rest_periods", "shared_facilities", "surcharges", "variable_compensation_terms", "work_wear" ], "title": "HireFrameworkAgreement", "type": "object" }, "french_occupation_classification_code": { "description": "French Professions et Catégories Socioprofessionnelles (PCS) code that classifies the occupation performed by this role, such as 100X. Use a code allowed by GET /hire-requirements/.", "type": "string" }, "hired_due_to_merger": { "description": "Required for GB and IE EOR. True if this hire is from a merger or acquisition.", "type": "boolean" }, "is_eor_transfer": { "description": "Whether the worker's employment is transferring from another employer-of-record provider. Send true for an EOR-to-EOR transfer and false when this is not an EOR transfer. Required for EOR hires outside the United States.", "type": "boolean" }, "is_shift_worker": { "description": "Whether the role is legally or contractually classified as shift work, rather than merely having hours outside a typical workday. Send true when the applicable employment terms designate the worker as a shift worker; send false when they do not. Required only when listed by GET /hire-requirements/.", "type": "boolean" }, "is_technology_focused_role": { "description": "Whether the role's primary work is technology-focused. Required for China EOR hires when social_contribution_city is SHANGHAI or BEIJING; omit it for other cities.", "type": "boolean" }, "job_classification": { "description": "US EEO-1 job category for the role. Use a value returned by GET /hire-requirements/. Omit for contractor hires.", "type": "string" }, "job_function_id": { "description": "Job function that categorizes the type of work performed by this role. Send an id returned by GET /job-functions/.", "type": "string" }, "legal_entity_id": { "description": "Send a candidate entity id from GET /company-legal-entities/. Required for direct_hire; omit for eor. Rippling validates that the selected entity belongs to the company and supports the requested hire.", "type": "string" }, "level_id": { "description": "Job level for the role within the company's job architecture. Send an id returned by GET /levels/.", "type": "string" }, "manager_id": { "description": "Manager worker id from GET /workers/. Omit or null for no manager.", "type": "string" }, "meets_eor_eligibility_criteria": { "description": "Confirms that the proposed hire satisfies Rippling's country-specific EOR eligibility screening criteria. Required for Hong Kong, Switzerland, and New Zealand EOR hires and must be true. Rippling maps this assertion to the applicable country-specific screening response. See https://help.rippling.com/s/article/757822852718.", "type": "boolean" }, "modern_award": { "additionalProperties": false, "description": "Australian modern-award coverage and classification for this job. Required for Australian hires. Send coverage NOT_COVERED when no award applies; otherwise send COVERED with the applicable award and classification identifiers.", "properties": { "award_id": { "description": "Identifier of the Australian modern award governing the job. Required when coverage is COVERED; omit when coverage is NOT_COVERED. Select a currently active identifier from award_id.allowed_values returned by GET /hire-requirements/. This is a catalog identifier, not an expandable Platform API relationship.", "type": "string" }, "classification_id": { "description": "Identifier of the worker's classification within the selected modern award. This classification captures the applicable level or sub-level. Required when coverage is COVERED; omit when coverage is NOT_COVERED. Select an identifier from classification_id.allowed_values returned by GET /hire-requirements/ and use allowed_value_parents to match it to award_id. This is a catalog identifier, not an expandable Platform API relationship.", "type": "string" }, "coverage": { "description": "Whether an Australian modern award covers this job. Use NOT_COVERED when no modern award applies. Use COVERED together with award_id and classification_id when one applies.", "enum": [ "COVERED", "NOT_COVERED" ], "type": "string" } }, "required": [ "coverage" ], "title": "HireModernAward", "type": "object" }, "non_compete": { "description": "Whether the proposed employment terms include a non-compete restriction. Provide only when listed by GET /hire-requirements/.", "type": "boolean" }, "notice": { "additionalProperties": false, "description": "Notice-period arrangement for ending employment: standard or a custom period.", "properties": { "quantity": { "description": "Number of notice-period units. Required for CUSTOM_NOTICE; omit for STANDARD_NOTICE.", "type": "integer" }, "type": { "description": "Notice-period arrangement for ending employment. STANDARD_NOTICE applies the standard period; CUSTOM_NOTICE supplies a specific period.", "enum": [ "STANDARD_NOTICE", "CUSTOM_NOTICE" ], "type": "string" }, "unit": { "description": "Unit for the custom notice period: DAYS, WEEKS, MONTHS, or YEARS. Required for CUSTOM_NOTICE; omit for STANDARD_NOTICE.", "enum": [ "DAYS", "WEEKS", "MONTHS", "YEARS" ], "type": "string" } }, "required": [ "type" ], "title": "HireNotice", "type": "object" }, "overtime_classification": { "description": "The role's overtime classification under applicable employment law. EXEMPT means overtime requirements do not apply; NON_EXEMPT means the worker may be entitled to overtime pay. Omit for contractor hires.", "enum": [ "EXEMPT", "NON_EXEMPT" ], "type": "string" }, "owns_entity_in_country": { "description": "Whether the hiring company owns a legal entity in the worker's country. Required only when listed by GET /hire-requirements/; for Netherlands EOR hires, this answer determines the applicable hiring path.", "type": "boolean" }, "paid_sick_days": { "description": "Annual company-provided paid sick-day allowance, excluding any separate statutory entitlement. Provide only when listed by GET /hire-requirements/.", "type": "integer" }, "probation": { "additionalProperties": false, "description": "Probation arrangement for the employment: standard, a shorter custom period, or none.", "properties": { "quantity": { "description": "Number of probation units. Required for SHORTER_PROBATION; omit otherwise.", "type": "integer" }, "type": { "description": "Probation arrangement for the employment. STANDARD_PROBATION applies the standard period, SHORTER_PROBATION supplies a shorter custom period, and FORGO_PROBATION means no probation.", "enum": [ "STANDARD_PROBATION", "SHORTER_PROBATION", "FORGO_PROBATION" ], "type": "string" }, "unit": { "description": "Unit for the custom probation length: DAYS, WEEKS, MONTHS, or YEARS. Required for SHORTER_PROBATION; omit otherwise.", "enum": [ "DAYS", "WEEKS", "MONTHS", "YEARS" ], "type": "string" } }, "required": [ "type" ], "title": "HireProbation", "type": "object" }, "receives_tips": { "description": "Whether the worker is expected to receive tips as part of this job. Omit for contractor hires.", "type": "boolean" }, "regular_working_hours": { "additionalProperties": false, "description": "The role's usual working days and, where required, its local daily start and end times. This describes the regular work pattern; weekly_hours remains the total expected hours per week.", "properties": { "days": { "description": "Weekdays the worker ordinarily works. Use uppercase values such as MONDAY and FRIDAY.", "items": { "enum": [ "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY" ] }, "type": "array" }, "days_per_week": { "description": "Number of days ordinarily worked per week, such as 5.", "type": "integer" }, "days_per_year": { "description": "Number of days ordinarily worked per year, when the country tracks annual working days.", "type": "integer" }, "end_time": { "description": "Usual local end time on a working day in HH:MM:SS format, such as 17:00:00. This is a wall-clock time in time_zone, not a UTC timestamp.", "type": "string" }, "hours_by_weekday": { "additionalProperties": false, "description": "Expected hours for each weekday. Use null for a day off.", "properties": { "friday": { "description": "Hours worked on Friday; null means the day is off.", "type": "string" }, "monday": { "description": "Hours worked on Monday; null means the day is off.", "type": "string" }, "saturday": { "description": "Hours worked on Saturday; null means the day is off.", "type": "string" }, "sunday": { "description": "Hours worked on Sunday; null means the day is off.", "type": "string" }, "thursday": { "description": "Hours worked on Thursday; null means the day is off.", "type": "string" }, "tuesday": { "description": "Hours worked on Tuesday; null means the day is off.", "type": "string" }, "wednesday": { "description": "Hours worked on Wednesday; null means the day is off.", "type": "string" } }, "title": "HireWeekdayHours", "type": "object" }, "start_time": { "description": "Usual local start time on a working day in HH:MM:SS format, such as 09:00:00. This is a wall-clock time in time_zone, not a UTC timestamp.", "type": "string" }, "time_zone": { "description": "IANA time zone used to interpret start_time and end_time, such as Australia/Sydney or Europe/London.", "type": "string" }, "tracking_unit": { "description": "Unit used to track working time when required by the country: DAYS or HOURS.", "enum": [ "DAYS", "HOURS" ], "type": "string" } }, "required": [ "days" ], "title": "HireRegularWorkingHours", "type": "object" }, "requires_training": { "description": "Whether the employment terms require the worker to complete training for this role. For Spanish direct hires, send true when training is required and false when it is not.", "type": "boolean" }, "schedule_type": { "description": "The role's recurring schedule pattern: FIXED_SCHEDULE for a consistent schedule or ROTATING_SHIFT_SCHEDULE for shifts that rotate. Provide only when listed by GET /hire-requirements/.", "enum": [ "FIXED_SCHEDULE", "ROTATING_SHIFT_SCHEDULE" ], "type": "string" }, "soc_code": { "description": "US Standard Occupational Classification code for the job, such as 15-1252. Omit for contractor hires.", "type": "string" }, "social_contribution_city": { "description": "Chinese city whose local social-insurance and statutory contribution rules apply to the worker, such as SHANGHAI or BEIJING. Required for China EOR hires. Use a value returned by GET /hire-requirements/.", "type": "string" }, "start_date": { "description": "Start date in YYYY-MM-DD format.", "type": "string" }, "statutory_contract_classification": { "description": "Country-specific statutory contract code. For Spain, use an allowed value returned by GET /hire-requirements/ that is compatible with contract.type and employment_type_id.", "type": "string" }, "statutory_job_classification": { "description": "Statutory employment classification for the role. For Germany, choose the applicable value returned by GET /hire-requirements/, such as EMPLOYEE, APPRENTICE, WORKING_STUDENT, INTERN, MARGINALLY_EMPLOYED, SHORT_TERM_WORK, or MANAGING_DIRECTOR. Rippling derives the internal classification workflow from this value.", "type": "string" }, "supporting_documents": { "additionalProperties": false, "description": "Employment documents required to prepare the hire.", "properties": { "resume_file_id": { "description": "Id of the confirmed company-owned PDF or Word resume uploaded through POST /files/.", "type": "string" }, "variable_compensation_plan_file_id": { "description": "Id of the confirmed company-owned PDF or Word variable-compensation plan.", "type": "string" } }, "title": "HireSupportingDocuments", "type": "object" }, "team_ids": { "description": "Teams the worker should belong to. Send team ids returned by GET /teams/. Omit for no team assignments.", "items": { "type": "string" }, "type": "array" }, "title": { "description": "Job title.", "type": "string" }, "use_default_tenure": { "description": "Set to true to start tenure on the start date. False keeps a prior tenure date unset.", "type": "boolean" }, "vacation": { "additionalProperties": false, "description": "How annual paid vacation is determined: statutory entitlement or a custom annual allowance.", "properties": { "days": { "description": "Annual vacation allowance in days. Required for CUSTOM_VACATION; omit for STATUTORY_VACATION.", "type": "integer" }, "type": { "description": "How annual paid vacation is determined. Use STATUTORY_VACATION to apply the statutory entitlement or CUSTOM_VACATION to provide a specific annual allowance in days.", "enum": [ "STATUTORY_VACATION", "CUSTOM_VACATION" ], "type": "string" } }, "required": [ "type" ], "title": "HireVacation", "type": "object" }, "vacation_rollover_days": { "description": "Maximum unused vacation days the worker may carry into the next leave year. Provide only when listed by GET /hire-requirements/.", "type": "integer" }, "weekly_hours": { "description": "Expected working hours per week. Supports whole or fractional hours, such as 40 or 37.5. Rippling derives any internal weekly-hours classification from this value. Omit for contractor hires.", "type": "string" }, "work_email": { "description": "Work email for the hire.", "type": "string" }, "work_email_required": { "description": "Set to false to skip work-email assignment for this hire, including generation by company policy. Do not combine false with a nonempty employment.work_email. Set to true to enable the normal work-email flow. For a newly created hire, true, omission, and null have the same behavior. Omission or null preserves any saved work-email preference. If related_records.existing_role_id identifies a hire that has already moved beyond creation, an explicit true or false can return that hire as incomplete with a validation error.", "type": "boolean" }, "worker_qualification": { "description": "Worker's professional qualification for a Switzerland EOR role, such as Engineer. This is plain text, not a Rippling resource identifier. Provide it only when GET /hire-requirements/ lists worker_qualification for the selected country and hire type.", "type": "string" }, "working_hours_arrangement": { "description": "Working-hours system that legally applies to a China EOR role. Use STANDARD_WORKING_HOURS for a role governed by the standard daily and weekly limits, or FLEXIBLE_WORKING_HOURS when an approved flexible-hours system applies. Required for China EOR hires.", "enum": [ "STANDARD_WORKING_HOURS", "FLEXIBLE_WORKING_HOURS" ], "type": "string" }, "works_in_construction_industry": { "description": "Whether the worker will perform work in Germany's construction industry. Required for Germany EOR hires. Rippling EOR does not currently support these roles, so true makes the hire ineligible.", "type": "boolean" } }, "required": [ "employment_type_id", "title" ], "title": "HireEmployment", "type": "object" }, "hire_type": { "description": "Employment model for this hire: direct_hire employs the person through the company's own legal entity; eor employs the person through Rippling's employer-of-record service. Defaults to direct_hire when omitted.", "type": "string" }, "personal": { "additionalProperties": false, "description": "The person's legal name and the email address or mobile number used to send their invitation.", "properties": { "first_name": { "description": "Person's legal given name as it should appear on employment and payroll records.", "type": "string" }, "invite_email": { "description": "Email address where the person should receive their Rippling invitation. At least one of invite_email or invite_phone is required; both may be provided.", "type": "string" }, "invite_phone": { "description": "Mobile number where the person should receive their Rippling invitation, in international format including the country calling code, for example +14155550123. At least one of invite_email or invite_phone is required; both may be provided.", "type": "string" }, "last_name": { "description": "Person's legal family name as it should appear on employment and payroll records.", "type": "string" }, "nationality_code": { "description": "Person's nationality as an ISO 3166-1 alpha-2 country code, such as FR for French nationality. Provide it only when listed by GET /hire-requirements/. This is not the country where the person works.", "type": "string" } }, "title": "HirePersonal", "type": "object" }, "related_records": { "additionalProperties": false, "description": "References that associate this hire with recruiting, headcount planning, a prior employment record, or an existing Rippling hiring process. These references control hiring behavior; they are not arbitrary metadata. Omit the object when no association applies.", "properties": { "ats_applicant_id": { "description": "Rippling Recruiting applicant/application ID for the ATS application that produced this hire. Obtain it from GET /candidate-applications/. Omit when the hire is not linked to a Rippling ATS application.", "type": "string" }, "existing_role_id": { "description": "Rippling role ID for an in-progress hire to continue instead of starting another hiring process. Use the ID returned by a prior hire result when instructed to continue that hire.", "type": "string" }, "headcount_position_id": { "description": "Rippling headcount-position ID for the approved or open position this person will fill. Obtain it from GET /headcount-positions/.", "type": "string" }, "rehire_choice": { "description": "How to initialize the rehire identified by rehire_role_id. REUSE_WORKER_DETAILS prefills eligible non-compensation details from the prior employment record, while NEW_WORKER_DETAILS starts those hiring questions without that prefill. Both choices rehire the existing person identified by rehire_role_id. The request's required first_name and last_name do not replace that person's identity; invite_email or invite_phone supplies the invitation destination for the new role. Required with rehire_role_id; omit otherwise.", "enum": [ "REUSE_WORKER_DETAILS", "NEW_WORKER_DETAILS" ], "type": "string" }, "rehire_role_id": { "description": "Rippling role ID for this person's prior employment record: the previous role being rehired. When POST /hires/ reports a possible_rehire next action, use its target_id here. Providing this ID starts a rehire and also requires rehire_choice.", "type": "string" } }, "title": "HireContext", "type": "object" }, "work_location": { "additionalProperties": false, "description": "Where the person will work. Provide either a Rippling work-location ID or mark the hire as remote, and always provide the work country.", "properties": { "country_code": { "description": "Two-letter ISO 3166-1 country code for the place where the person performs the work, such as US or CA. Required for both office-based and remote hires and used to determine country-specific hiring requirements.", "type": "string" }, "is_remote": { "description": "Whether the person works remotely rather than from a company work location. When true, omit location_id and provide country_code plus state_code when applicable. Defaults to false.", "type": "boolean" }, "location_id": { "description": "Rippling work-location ID for the office or site where the person will work. Obtain it from GET /work-locations/. Required when is_remote is false; omit when is_remote is true.", "type": "string" }, "state_code": { "description": "State, province, or region code for a remote work location, such as CA for California. Supply it when the selected country requires a regional location; omit it for an office-based hire whose work-location record already identifies the region.", "type": "string" } }, "required": [ "country_code" ], "title": "HireWorkLocation", "type": "object" } }, "required": [ "employment", "work_location" ], "title": "HireItem", "type": "object" }, "RestApiInboundEmailTriggera580510d7eb3": { "additionalProperties": false, "properties": { "body_contains": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_attachment": { "default": false, "type": "boolean" }, "kind": { "enum": [ "inbound_email" ], "type": "string" }, "recipient_email": { "type": "string" }, "subject_contains": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "kind", "recipient_email" ], "title": "InboundEmailTrigger", "type": "object" }, "RestApiJobAssignmentRequest8114b3771e85": { "description": "", "properties": { "change_reason": { "description": "Reason recorded on the change (e.g., the reason for scheduling an unassignment).", "type": "string" }, "effective_from": { "description": "Date and time the change becomes effective (ISO 8601 format, e.g., 2025-11-07T17:00:00.000+00:00); defaults to current time in UTC if not provided. job_pay_rate_effective_from is ignored if this field is provided.", "type": "string" }, "job_code_id": { "description": "Identifier of job that is assigned to worker", "type": "string" }, "job_pay_rate": { "description": "The pay rate for job assigned to worker. This can be different from the job's standard pay rate and can be overriden for a worker.", "type": "number" }, "job_pay_rate_change_reason": { "description": "This field is deprecated and will be removed in a future version, use the new change_reason field instead.", "type": "string" }, "job_pay_rate_effective_from": { "description": "This field is deprecated and will be removed in a future version, use the new effective_from field instead.", "type": "string" }, "worker_id": { "description": "Identifier of worker to whom job is assigned.", "type": "string" } }, "required": [ "job_code_id", "worker_id" ], "title": "JobAssignmentRequest", "type": "object" }, "RestApiJobAssignmentUpdateRequest0239da31ea4b": { "description": "", "properties": { "change_reason": { "description": "Reason recorded on the change (e.g., the reason for scheduling an unassignment).", "type": "string" }, "effective_from": { "description": "Date and time the change becomes effective (ISO 8601 format, e.g., 2025-11-07T17:00:00.000+00:00); defaults to current time in UTC if not provided. job_pay_rate_effective_from is ignored if this field is provided.", "type": "string" }, "job_code_id": { "description": "Identifier of job that is assigned to worker", "type": "string" }, "job_pay_rate": { "description": "The pay rate for job assigned to worker. This can be different from the job's standard pay rate and can be overriden for a worker.", "type": "number" }, "job_pay_rate_change_reason": { "description": "This field is deprecated and will be removed in a future version, use the new change_reason field instead.", "type": "string" }, "job_pay_rate_effective_from": { "description": "This field is deprecated and will be removed in a future version, use the new effective_from field instead.", "type": "string" }, "worker_id": { "description": "Identifier of worker to whom job is assigned.", "type": "string" } }, "title": "JobAssignmentUpdateRequest", "type": "object" }, "RestApiJobCodeRequest773211238d35": { "description": "", "properties": { "custom_location": { "description": "The custom location of the job code. This location will be used for tax calculation purposes if using US Payroll when an employee is working at this job code.", "properties": { "address": { "description": "The address of the custom location.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "enum": [ "AF", "AX", "AL", "DZ", "AS", "AD", "AO", "AI", "AQ", "AG", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BY", "BE", "BZ", "BJ", "BM", "BT", "BO", "BQ", "BA", "BW", "BV", "BR", "IO", "BN", "BG", "BF", "BI", "CV", "KH", "CM", "CA", "KY", "CF", "TD", "CL", "CN", "CX", "CC", "CO", "KM", "CG", "CD", "CK", "CR", "CI", "HR", "CW", "CY", "CZ", "DK", "DJ", "DM", "DO", "EC", "EG", "SV", "GQ", "ER", "EE", "SZ", "ET", "FK", "FO", "FJ", "FI", "FR", "GF", "PF", "TF", "GA", "GM", "GE", "DE", "GH", "GI", "GR", "GL", "GD", "GP", "GU", "GT", "GG", "GN", "GW", "GY", "HT", "HM", "VA", "HN", "HK", "HU", "IS", "IN", "ID", "IQ", "IR", "IE", "IM", "IL", "IT", "JM", "JP", "JE", "JO", "KZ", "KE", "KI", "KR", "XK", "KW", "KG", "LA", "LV", "LB", "LS", "LR", "LY", "LI", "LT", "LU", "MO", "MG", "MW", "MY", "MV", "ML", "MT", "MH", "MQ", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MA", "MZ", "MM", "NA", "NR", "NP", "NL", "AN", "NC", "NZ", "NI", "NE", "NG", "NU", "NF", "MK", "MP", "NO", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PH", "PN", "PL", "PT", "PR", "QA", "RO", "RU", "RW", "RE", "BL", "SH", "KN", "LC", "MF", "PM", "VC", "WS", "SM", "ST", "SA", "SN", "RS", "SC", "SL", "SG", "SX", "SY", "SK", "SI", "SB", "SO", "ZA", "GS", "SS", "ES", "LK", "SD", "SR", "SJ", "SE", "CH", "TW", "TJ", "TZ", "TH", "TL", "TG", "TK", "TO", "TT", "TN", "TR", "TM", "TC", "TV", "UG", "UA", "AE", "GB", "US", "UM", "UY", "UZ", "VU", "VE", "VN", "VG", "VI", "WF", "EH", "YE", "ZM", "ZW" ], "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "enum": [ "HOME", "WORK", "OTHER" ], "type": "string" } }, "title": "AddressRequest", "type": "object" } }, "required": [ "address" ], "title": "CustomLocationRequest", "type": "object" }, "external_id": { "description": "The unique identifier of the job code in an outside system.", "type": "string" }, "is_archived": { "description": "Whether this job code is archived. Set to true via PATCH to archive. Archiving is irreversible via this API.", "type": "boolean" }, "job_dimension_id": { "description": "The ID of the job dimension this job code belongs to.", "type": "string" }, "name": { "description": "The name of the job dimension.", "type": "string" }, "pay_rate": { "description": "The pay rate for this job code. Only applicable if the associated job dimension includes the 'PAY_RATE' organizational attribute.", "type": "number" }, "pay_rate_change_reason": { "description": "Reason for setting, updating, or resetting the pay rate on this job code.", "type": "string" }, "pay_rate_effective_from": { "description": "Date and time the pay rate becomes effective (ISO 8601 format YYYY-MM-DDTHH:mm:ss.sssZ, e.g., 2025-11-07T17:00:00.000+00:00); defaults to current time in UTC if not provided.", "type": "string" } }, "required": [ "job_dimension_id", "name" ], "title": "JobCodeRequest", "type": "object" }, "RestApiJobCodeUpdateRequest71bb1a016083": { "description": "", "properties": { "custom_location": { "description": "The custom location of the job code. This location will be used for tax calculation purposes if using US Payroll when an employee is working at this job code.", "properties": { "address": { "description": "The address of the custom location.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "enum": [ "AF", "AX", "AL", "DZ", "AS", "AD", "AO", "AI", "AQ", "AG", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BY", "BE", "BZ", "BJ", "BM", "BT", "BO", "BQ", "BA", "BW", "BV", "BR", "IO", "BN", "BG", "BF", "BI", "CV", "KH", "CM", "CA", "KY", "CF", "TD", "CL", "CN", "CX", "CC", "CO", "KM", "CG", "CD", "CK", "CR", "CI", "HR", "CW", "CY", "CZ", "DK", "DJ", "DM", "DO", "EC", "EG", "SV", "GQ", "ER", "EE", "SZ", "ET", "FK", "FO", "FJ", "FI", "FR", "GF", "PF", "TF", "GA", "GM", "GE", "DE", "GH", "GI", "GR", "GL", "GD", "GP", "GU", "GT", "GG", "GN", "GW", "GY", "HT", "HM", "VA", "HN", "HK", "HU", "IS", "IN", "ID", "IQ", "IR", "IE", "IM", "IL", "IT", "JM", "JP", "JE", "JO", "KZ", "KE", "KI", "KR", "XK", "KW", "KG", "LA", "LV", "LB", "LS", "LR", "LY", "LI", "LT", "LU", "MO", "MG", "MW", "MY", "MV", "ML", "MT", "MH", "MQ", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MA", "MZ", "MM", "NA", "NR", "NP", "NL", "AN", "NC", "NZ", "NI", "NE", "NG", "NU", "NF", "MK", "MP", "NO", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PH", "PN", "PL", "PT", "PR", "QA", "RO", "RU", "RW", "RE", "BL", "SH", "KN", "LC", "MF", "PM", "VC", "WS", "SM", "ST", "SA", "SN", "RS", "SC", "SL", "SG", "SX", "SY", "SK", "SI", "SB", "SO", "ZA", "GS", "SS", "ES", "LK", "SD", "SR", "SJ", "SE", "CH", "TW", "TJ", "TZ", "TH", "TL", "TG", "TK", "TO", "TT", "TN", "TR", "TM", "TC", "TV", "UG", "UA", "AE", "GB", "US", "UM", "UY", "UZ", "VU", "VE", "VN", "VG", "VI", "WF", "EH", "YE", "ZM", "ZW" ], "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "enum": [ "HOME", "WORK", "OTHER" ], "type": "string" } }, "title": "AddressRequest", "type": "object" } }, "required": [ "address" ], "title": "CustomLocationRequest", "type": "object" }, "external_id": { "description": "The unique identifier of the job code in an outside system.", "type": "string" }, "is_archived": { "description": "Whether this job code is archived. Set to true via PATCH to archive. Archiving is irreversible via this API.", "type": "boolean" }, "job_dimension_id": { "description": "The ID of the job dimension this job code belongs to.", "type": "string" }, "name": { "description": "The name of the job dimension.", "type": "string" }, "pay_rate": { "description": "The pay rate for this job code. Only applicable if the associated job dimension includes the 'PAY_RATE' organizational attribute.", "type": "number" }, "pay_rate_change_reason": { "description": "Reason for setting, updating, or resetting the pay rate on this job code.", "type": "string" }, "pay_rate_effective_from": { "description": "Date and time the pay rate becomes effective (ISO 8601 format YYYY-MM-DDTHH:mm:ss.sssZ, e.g., 2025-11-07T17:00:00.000+00:00); defaults to current time in UTC if not provided.", "type": "string" } }, "title": "JobCodeUpdateRequest", "type": "object" }, "RestApiJobDimensionRequesta969d663d1c6": { "description": "", "properties": { "external_id": { "description": "The unique identifier of the job dimension in a third party system", "type": "string" }, "includes_custom_location": { "description": "Whether the job dimension includes codes related to a custom location. Only one dimension can have this set to true.", "type": "boolean" }, "name": { "description": "The name of the job dimension", "type": "string" }, "org_attribute_associations": { "description": "Organizational attributes associated with the job dimension. Only 'PAY_RATE' can be set or modified using POST or PATCH requests.", "items": { "enum": [ "DEPARTMENT", "WORK_LOCATION", "PAY_RATE", "ENTITY" ] }, "type": "array" }, "roster_type": { "description": "The roster type of the dimension. PER_DIMENSION means that there is a group on the dimension level and employees within that group have access to all job codes in the dimension. PER_JOB_CODE means that each job code has its own group.", "enum": [ "PER_DIMENSION", "PER_JOB_CODE" ], "type": "string" } }, "required": [ "name" ], "title": "JobDimensionRequest", "type": "object" }, "RestApiJobDimensionUpdateRequest86b6773b160a": { "description": "", "properties": { "external_id": { "description": "The unique identifier of the job dimension in a third party system", "type": "string" }, "includes_custom_location": { "description": "Whether the job dimension includes codes related to a custom location. Only one dimension can have this set to true.", "type": "boolean" }, "name": { "description": "The name of the job dimension", "type": "string" }, "org_attribute_associations": { "description": "Organizational attributes associated with the job dimension. Only 'PAY_RATE' can be set or modified using POST or PATCH requests.", "items": { "enum": [ "DEPARTMENT", "WORK_LOCATION", "PAY_RATE", "ENTITY" ] }, "type": "array" }, "roster_type": { "description": "The roster type of the dimension. PER_DIMENSION means that there is a group on the dimension level and employees within that group have access to all job codes in the dimension. PER_JOB_CODE means that each job code has its own group.", "enum": [ "PER_DIMENSION", "PER_JOB_CODE" ], "type": "string" } }, "title": "JobDimensionUpdateRequest", "type": "object" }, "RestApiJobRequisitionBaseResourceDTORequestaf52fba558d9": { "description": "\n DTO for creating JobRequisitions via the Platform API.\n Maps to the existing ATS JobRequisitionDTO for use with create_from_DTO service.\n ", "properties": { "confidential": { "description": "Whether this requisition is confidential", "type": "boolean" }, "confidential_whitelist": { "description": "List of role IDs allowed to view confidential requisition", "items": { "type": "string" }, "type": "array" }, "coordinator_id": { "description": "Coordinator role ID", "type": "string" }, "default_private_invites": { "description": "Whether to default to private invites", "type": "boolean" }, "departments": { "description": "List of department IDs", "items": { "type": "string" }, "type": "array" }, "description": { "description": "Job description", "type": "string" }, "employment_type_id": { "description": "Company employment type ID", "type": "string" }, "hiring_manager_id": { "description": "Hiring manager role ID", "type": "string" }, "is_evergreen": { "description": "Whether this is an evergreen requisition", "type": "boolean" }, "levels": { "description": "List of level IDs", "items": { "type": "string" }, "type": "array" }, "name": { "description": "Title/name of the job requisition", "type": "string" }, "pipeline_plan_id": { "description": "Pipeline plan ID to use for this requisition", "type": "string" }, "recruiter_id": { "description": "Primary recruiter role ID", "type": "string" }, "requisition_id": { "description": "Customer-defined requisition ID. Auto-generated if not provided.", "type": "string" }, "salary_currency": { "description": "Salary currency code", "type": "string" }, "salary_per_unit": { "description": "Salary amount per unit", "type": "number" }, "salary_per_unit_high": { "description": "Salary range upper bound", "type": "number" }, "salary_per_unit_low": { "description": "Salary range lower bound", "type": "number" }, "salary_type": { "description": "Salary type", "type": "string" }, "salary_unit": { "description": "Salary unit (HOUR, DAY, WEEK, MONTH, YEAR, PAY_PERIOD)", "type": "string" }, "secondary_recruiters": { "description": "List of secondary recruiter role IDs", "items": { "type": "string" }, "type": "array" }, "sourcer_id": { "description": "Sourcer role ID", "type": "string" }, "status": { "description": "Job requisition status (e.g., DRAFT, OPEN, CLOSED)", "type": "string" }, "target_close": { "description": "Target close date", "type": "string" }, "target_employee_start_date": { "description": "Target employee start date", "type": "string" }, "teams": { "description": "List of team IDs", "items": { "type": "string" }, "type": "array" }, "title": { "description": "Internal employee title", "type": "string" }, "work_locations": { "description": "List of work location IDs", "items": { "type": "string" }, "type": "array" } }, "required": [ "name" ], "title": "JobRequisitionBaseResourceDTORequest", "type": "object" }, "RestApiJobShiftRequest9ea8c446f52b": { "description": "", "properties": { "duration": { "description": "The duration of the job shift.", "type": "number" }, "end_time": { "description": "The end time of the job shift.", "type": "string" }, "is_hours_only_input": { "description": "Whether the job shift was entered as a duration in hours table", "type": "boolean" }, "job_codes_id": { "description": "The IDs of the job codes associated with the job shift.", "items": { "type": "string" }, "type": "array" }, "original_end_time": { "description": "The original end time of the job shift. If the endTime field has been rounded then this contain the end time before the rounding occured.", "type": "string" }, "original_start_time": { "description": "The original start time of the job shift. If the startTime field has been rounded then this contain the start time before the rounding occured.", "type": "string" }, "start_date": { "description": "The date of the job shift if using duration.", "type": "string" }, "start_time": { "description": "The start time of the job shift.", "type": "string" } }, "title": "JobShiftRequest", "type": "object" }, "RestApiLeaveAccrualRequest9c3376b9cdef": { "description": "\n Leave accrual resource representing time off credits granted to employees.\n\n Leave accruals track the allocation of paid time off (vacation, sick days, etc.)\n to employees based on company policies, manual grants, or other accrual sources.\n ", "properties": { "accrual_date": { "description": "The date when this accrual becomes effective", "type": "string" }, "accrual_type": { "description": "The type of accrual", "enum": [ "AUTO", "CARRYOVER_PENALTY", "RESET_PENALTY", "RESET_NEGATIVE_PENALTY", "BALANCE_PENALTY", "LEAVE_GRANT", "BALANCE_CORRECTION_ADJUSTMENT", "PAID_OUT", "SUB_BALANCE_EXPIRATION", "TANDA_ACCRUAL_BONUS", "TILT_ADJUSTMENT", "WORKFLOW_ACTION", "EXPIRATION_DEDUCTION", "EXPIRATION_PAYOUT", "MANUAL_BALANCE_PAYOUT", "CARRYOVER_PENALTY_PAYOUT", "RESET_PENALTY_PAYOUT", "HOLIDAY_ADJUSTMENT", "HOURS_WORKED_TANDA", "TENURE_MILESTONE", "FR_COP_FRACTIONNEMENT" ], "type": "string" }, "comment": { "description": "The comment for this accrual. This is required if the leave policy requires a comment on accruals.", "type": "string" }, "expiration_date": { "description": "The date when this accrual expires (if applicable)", "type": "string" }, "grantor_id": { "description": "The ID of the worker who granted this accrual. This is typically the Time Off admin.", "type": "string" }, "leave_type_id": { "description": "The company leave type ID associated with this accrual", "type": "string" }, "monetary_amount_accrued": { "description": "The monetary value of this accrual (for policies with monetary tracking)", "type": "number" }, "num_days": { "description": "The number of days accrued. It can be negative for deductions. This is applicable if the policy tracks in days.", "type": "number" }, "num_hours": { "description": "The number of hours accrued. It can be negative for deductions. This is applicable if the policy tracks in hours.", "type": "number" }, "worker_id": { "description": "The ID of the worker for whom the accrual is for", "type": "string" } }, "required": [ "accrual_date", "grantor_id", "leave_type_id", "worker_id" ], "title": "LeaveAccrualRequest", "type": "object" }, "RestApiLeavePlanEvaluationRequested784c02b55a": { "description": "", "properties": { "birth_type": { "description": "Optional delivery type for birthing-parent disability evaluations. Used to estimate postpartum disability windows for programs such as CA-SDI and CA-PDL.", "enum": [ "VAGINAL", "C_SECTION", "UNKNOWN" ], "type": "string" }, "child_entered_family_date": { "description": "Optional date the child entered the family for bonding leave programs.", "type": "string" }, "claim_end_date": { "description": "Optional requested leave end date. When set, leave_plan.pay_periods includes estimated per-paycheck amounts for programs that publish pay rates.", "type": "string" }, "claim_start_date": { "description": "Requested leave start date.", "type": "string" }, "evidence_override": { "description": "Demo/test-company only evidence overrides for exercising eligibility scenarios when the role's real data would not qualify.", "type": "object" }, "leave_reason": { "description": "Normalized leave reason to evaluate against statutory and custom leave programs.", "enum": [ "BONDING", "PREGNANCY_DISABILITY", "PREGNANCY_ACCOMMODATION", "MEDICAL", "VACATION", "OTHER" ], "type": "string" }, "parental_leave_type": { "description": "Optional parental leave relationship type for parental leave programs. Deprecated for most bonding evaluations, but still accepted for backwards compatibility with 2024-08-01 SDK callers.", "enum": [ "birthing_parent", "non_birthing_parent", "adoption_parent", "supporting_person", "foster_parent" ], "type": "string" }, "program_codes": { "description": "Optional leave program codes to evaluate. When omitted, every registered leave program runs in dependency order.", "items": { "type": "string" }, "type": "array" }, "role_id": { "description": "Role ID for the employee whose leave request should be evaluated.", "type": "string" }, "supplemental_evidence": { "description": "Answers for evidence keys returned in missing_evidence. These answers only fill facts that the evaluation reported as missing.", "type": "object" } }, "required": [ "claim_start_date", "leave_reason", "role_id" ], "title": "LeavePlanEvaluationRequest", "type": "object" }, "RestApiLeaveRequestRequest67e95f6f8193": { "description": "", "properties": { "comments": { "description": "The comments associated with the leave request.", "type": "string" }, "end_date": { "description": "The end date of the leave request.", "type": "string" }, "end_date_custom_hours": { "description": "The number of hours to take off on the end date.", "type": "number" }, "end_time": { "description": "The end time of the leave request.", "type": "string" }, "leave_event_id": { "description": "The ID of the leave event associated with the leave request, if any.", "type": "string" }, "leave_policy_id": { "description": "The ID of the leave policy associated with the leave request, either leave_policy_id or leave_type_id must be provided.", "type": "string" }, "leave_type_id": { "description": "The ID of the leave type associated with the leave request, either leave_policy_id or leave_type_id must be provided.", "type": "string" }, "reason_for_leave": { "description": "The reason for the leave request.", "type": "string" }, "requester_id": { "description": "The ID of the worker who requested the leave request.", "type": "string" }, "reviewed_at": { "description": "The timestamp of when the leave request was reviewed.", "type": "string" }, "reviewer_id": { "description": "The ID of the worker who reviewed the leave request.", "type": "string" }, "start_date": { "description": "The start date of the leave request.", "type": "string" }, "start_date_custom_hours": { "description": "The number of hours to take off on the start date.", "type": "number" }, "start_time": { "description": "The start time of the leave request.", "type": "string" }, "status": { "description": "The status of the leave request.", "enum": [ "PENDING", "APPROVED", "REJECTED", "CANCELED" ], "type": "string" }, "worker_id": { "description": "The ID of the worker associated with the leave request.", "type": "string" } }, "required": [ "end_date", "start_date", "status", "worker_id" ], "title": "LeaveRequestRequest", "type": "object" }, "RestApiLeaveRequestUpdateRequestc12d1f2beb2f": { "description": "", "properties": { "comments": { "description": "The comments associated with the leave request.", "type": "string" }, "end_date": { "description": "The end date of the leave request.", "type": "string" }, "end_date_custom_hours": { "description": "The number of hours to take off on the end date.", "type": "number" }, "end_time": { "description": "The end time of the leave request.", "type": "string" }, "leave_event_id": { "description": "The ID of the leave event associated with the leave request, if any.", "type": "string" }, "leave_policy_id": { "description": "The ID of the leave policy associated with the leave request, either leave_policy_id or leave_type_id must be provided.", "type": "string" }, "leave_type_id": { "description": "The ID of the leave type associated with the leave request, either leave_policy_id or leave_type_id must be provided.", "type": "string" }, "reason_for_leave": { "description": "The reason for the leave request.", "type": "string" }, "requester_id": { "description": "The ID of the worker who requested the leave request.", "type": "string" }, "reviewed_at": { "description": "The timestamp of when the leave request was reviewed.", "type": "string" }, "reviewer_id": { "description": "The ID of the worker who reviewed the leave request.", "type": "string" }, "start_date": { "description": "The start date of the leave request.", "type": "string" }, "start_date_custom_hours": { "description": "The number of hours to take off on the start date.", "type": "number" }, "start_time": { "description": "The start time of the leave request.", "type": "string" }, "status": { "description": "The status of the leave request.", "enum": [ "PENDING", "APPROVED", "REJECTED", "CANCELED" ], "type": "string" }, "worker_id": { "description": "The ID of the worker associated with the leave request.", "type": "string" } }, "title": "LeaveRequestUpdateRequest", "type": "object" }, "RestApiLevelRequest3a721d0713b9": { "description": "", "properties": { "description": { "description": "The description of the level.", "type": "string" }, "experience_requirements": { "description": "The experience requirements for the level.", "type": "string" }, "global_level": { "description": "Global level is used to track the seniority of levels. The higher up a level is placed on the page, the more senior and higher-ranked the level. Global level is used in workflows, policies, and reports that use the level attribute (e.g., you can use Level Lookup to set up a workflow that notifies the nearest person in an worker's management chain at or above the specified level).", "type": "integer" }, "name": { "description": "The name of the level. Must be unique within the company or organization.", "type": "string" }, "scope_of_responsibilities": { "description": "The scope of responsibilities for the level.", "type": "string" }, "track_id": { "description": "The track associated with the level. Required during creation. Include global_level when changing it.", "type": "string" } }, "required": [ "name", "track_id" ], "title": "LevelRequest", "type": "object" }, "RestApiLevelUpdateRequest11eded426378": { "description": "", "properties": { "description": { "description": "The description of the level.", "type": "string" }, "experience_requirements": { "description": "The experience requirements for the level.", "type": "string" }, "global_level": { "description": "Global level is used to track the seniority of levels. The higher up a level is placed on the page, the more senior and higher-ranked the level. Global level is used in workflows, policies, and reports that use the level attribute (e.g., you can use Level Lookup to set up a workflow that notifies the nearest person in an worker's management chain at or above the specified level).", "type": "integer" }, "name": { "description": "The name of the level. Must be unique within the company or organization.", "type": "string" }, "scope_of_responsibilities": { "description": "The scope of responsibilities for the level.", "type": "string" }, "track_id": { "description": "The track associated with the level. Required during creation. Include global_level when changing it.", "type": "string" } }, "title": "LevelUpdateRequest", "type": "object" }, "RestApiListingDTORequest8ebbbb3d769f": { "description": "", "properties": { "draft_status": { "description": "The current draft-cycle slot status.", "type": "string" }, "draft_version": { "description": "The current editable or review listing version.", "properties": { "catalog_binding_id": { "description": "The package ID tied to this listing.", "type": "string" }, "catalog_binding_version_id": { "description": "The package version ID selected by this listing version.", "type": "string" }, "created_at": { "description": "Creation timestamp.", "type": "string" }, "display_name": { "description": "The display name for this version.", "type": "string" }, "id": { "description": "The listing version ID.", "type": "string" }, "latest_submission_notes": { "description": "The latest notes submitted for review.", "type": "string" }, "metadata": { "description": "Listing metadata for this version.", "type": "object" }, "published_at": { "description": "Publish timestamp.", "type": "string" }, "status": { "description": "The lifecycle status for this version.", "type": "string" }, "updated_at": { "description": "Last update timestamp.", "type": "string" }, "version_name": { "description": "The publisher-visible version label.", "type": "string" } }, "title": "ListingVersionDTO", "type": "object" }, "draft_version_id": { "description": "The current draft-cycle version ID.", "type": "string" }, "icon": { "description": "The listing icon URL.", "type": "string" }, "listing_id": { "description": "The listing ID.", "type": "string" }, "name": { "description": "The listing name or display name.", "type": "string" }, "owner_company_id": { "description": "The publisher company ID that owns this listing.", "type": "string" }, "published_or_delisted_version": { "description": "The current published or delisted listing version.", "properties": { "catalog_binding_id": { "description": "The package ID tied to this listing.", "type": "string" }, "catalog_binding_version_id": { "description": "The package version ID selected by this listing version.", "type": "string" }, "created_at": { "description": "Creation timestamp.", "type": "string" }, "display_name": { "description": "The display name for this version.", "type": "string" }, "id": { "description": "The listing version ID.", "type": "string" }, "latest_submission_notes": { "description": "The latest notes submitted for review.", "type": "string" }, "metadata": { "description": "Listing metadata for this version.", "type": "object" }, "published_at": { "description": "Publish timestamp.", "type": "string" }, "status": { "description": "The lifecycle status for this version.", "type": "string" }, "updated_at": { "description": "Last update timestamp.", "type": "string" }, "version_name": { "description": "The publisher-visible version label.", "type": "string" } }, "title": "ListingVersionDTO", "type": "object" }, "published_status": { "description": "The current published slot status.", "type": "string" }, "published_version_id": { "description": "The current published or delisted version ID.", "type": "string" }, "status": { "description": "The listing lifecycle status.", "type": "string" }, "type": { "description": "The listing app type.", "type": "string" } }, "title": "ListingDTORequest", "type": "object" }, "RestApiLocaleSettings284990cf4952": { "description": "Locale of the candidate", "properties": { "language_code": { "description": "The primary language code", "type": "string" }, "language_inspection": { "description": "Additional language inspection data", "items": { "type": "string" }, "type": "array" }, "locale_code": { "description": "The locale code for formatting", "type": "string" }, "region_code": { "description": "The region code", "type": "string" }, "timezone": { "description": "The user's timezone", "type": "string" } }, "title": "LocaleSettings", "type": "object" }, "RestApiManualTrigger01b0ac4a464d": { "additionalProperties": false, "properties": { "kind": { "enum": [ "manual" ], "type": "string" } }, "required": [ "kind" ], "title": "ManualTrigger", "type": "object" }, "RestApiMetadataComponentsRequestab024a9897a3": { "properties": { "components": { "description": "Complete package of metadata components, including dependencies.", "items": { "$ref": "#/components/schemas/RestApiMetadataComposerComponent8c0980db1208" }, "minItems": 1, "type": "array" } }, "required": [ "components" ], "title": "MetadataComponentsRequest", "type": "object" }, "RestApiMetadataComposerComponent8c0980db1208": { "additionalProperties": true, "description": "A metadata component config. The `type` field selects the concrete component schema. Fetch type-specific fields from GET /metadata/schema/?type=.", "properties": { "type": { "description": "Metadata component type, such as CUSTOM_OBJECT or CUSTOM_OBJECT_FIELD.", "type": "string" } }, "required": [ "type" ], "title": "MetadataComposerComponent", "type": "object" }, "RestApiMetadataExtractByIdentifiersRequest4075425d83d1": { "additionalProperties": false, "properties": { "identifiers": { "items": { "additionalProperties": true, "description": "Exact metadata component identifier, including its type.", "type": "object" }, "minItems": 1, "type": "array" } }, "required": [ "identifiers" ], "title": "MetadataExtractByIdentifiersRequest", "type": "object" }, "RestApiMonthlyOnDayOfWeekScheduleTrigger53d4b16bf970": { "additionalProperties": false, "properties": { "day_of_week": { "maximum": 6, "minimum": 0, "type": "integer" }, "hour": { "maximum": 23, "minimum": 0, "type": "integer" }, "kind": { "enum": [ "monthly_on_day_of_week_schedule" ], "type": "string" }, "minute": { "default": 0, "maximum": 59, "minimum": 0, "type": "integer" }, "timezone": { "type": "string" }, "week_of_month": { "maximum": 4, "minimum": 1, "type": "integer" } }, "required": [ "day_of_week", "hour", "kind", "timezone", "week_of_month" ], "title": "MonthlyOnDayOfWeekScheduleTrigger", "type": "object" }, "RestApiMonthlyScheduleTrigger105d31bb71a4": { "additionalProperties": false, "properties": { "day_of_month": { "maximum": 31, "minimum": 1, "type": "integer" }, "hour": { "maximum": 23, "minimum": 0, "type": "integer" }, "kind": { "enum": [ "monthly_schedule" ], "type": "string" }, "minute": { "default": 0, "maximum": 59, "minimum": 0, "type": "integer" }, "timezone": { "type": "string" } }, "required": [ "day_of_month", "hour", "kind", "timezone" ], "title": "MonthlyScheduleTrigger", "type": "object" }, "RestApiNameeb1a23b03ab6": { "description": "Name of the candidate", "properties": { "first": { "description": "First name or given name", "type": "string" }, "last": { "description": "Last name or family name", "type": "string" }, "middle": { "description": "Middle name(s)", "type": "string" }, "nickname": { "description": "Preferred nickname or informal name", "type": "string" }, "suffix": { "description": "Name suffix (e.g., Jr., Sr., III)", "type": "string" }, "title": { "description": "Title or honorific (e.g., Mr., Ms., Dr.)", "type": "string" } }, "title": "Name", "type": "object" }, "RestApiObligationLedgerPayoutRequest49ac5316604e": { "description": "", "properties": { "amount_base": { "description": "Payout amount in the worker's base currency.", "properties": { "currency_type": { "description": "Three-letter currency code.", "type": "string" }, "value": { "description": "Decimal amount encoded as a string.", "type": "string" } }, "required": [ "currency_type", "value" ], "title": "ObligationLedgerPayoutCurrency", "type": "object" }, "amount_usd": { "description": "Payout amount converted to USD.", "properties": { "currency_type": { "description": "Three-letter currency code.", "type": "string" }, "value": { "description": "Decimal amount encoded as a string.", "type": "string" } }, "required": [ "currency_type", "value" ], "title": "ObligationLedgerPayoutCurrency", "type": "object" }, "client": { "description": "Client system that created the payout.", "enum": [ "VC_PLAN_CYCLE", "VC_EVENT_DRIVEN_PLAN", "CUSTOM", "MANUAL_PAYOUT", "HRIS_SIGN_ON", "OFFLINE_RECOMMENDATION" ], "type": "string" }, "description": { "description": "Optional payout description.", "type": "string" }, "effective_end_date": { "description": "End date of the covered pay period.", "type": "string" }, "effective_start_date": { "description": "Start date of the covered pay period.", "type": "string" }, "external_id": { "description": "External identifier unique per company and client.", "type": "string" }, "group_label_id": { "description": "Group label identifier attached to the payout. Expand is deferred from v1; use GET /variable-compensation-payout-labels/{id}/ when needed.", "type": "string" }, "name": { "description": "Optional payout name.", "type": "string" }, "payee_id": { "description": "ID of the worker who receives this payout. Expandable payee (Worker DTO + workers.read) is deferred from v1; use GET /workers/{id}/ when needed.", "type": "string" }, "payout_type": { "description": "Key of the company payout type used for this payout. Expand is deferred from v1; enumerate valid keys via GET /variable-compensation-payout-types/.", "type": "string" }, "scheduled_date": { "description": "Date on which the payout is scheduled.", "type": "string" }, "source_label_id": { "description": "Source label identifier attached to the payout. Expand is deferred from v1; use GET /variable-compensation-payout-labels/{id}/ when needed.", "type": "string" } }, "required": [ "amount_base", "amount_usd", "client", "effective_end_date", "effective_start_date", "external_id", "payee_id", "payout_type", "scheduled_date" ], "title": "ObligationLedgerPayoutRequest", "type": "object" }, "RestApiOneTimeScheduleTrigger7f8bd364e99f": { "additionalProperties": false, "properties": { "day_of_month": { "maximum": 31, "minimum": 1, "type": "integer" }, "hour": { "maximum": 23, "minimum": 0, "type": "integer" }, "kind": { "enum": [ "one_time_schedule" ], "type": "string" }, "minute": { "default": 0, "maximum": 59, "minimum": 0, "type": "integer" }, "month_of_year": { "maximum": 12, "minimum": 1, "type": "integer" }, "timezone": { "type": "string" }, "year": { "maximum": 9999, "minimum": 1, "type": "integer" } }, "required": [ "day_of_month", "hour", "kind", "month_of_year", "timezone", "year" ], "title": "OneTimeScheduleTrigger", "type": "object" }, "RestApiPackageRequest131ebb92b650": { "description": "", "properties": { "description": { "description": "The description of the package", "type": "string" }, "package_display_name": { "description": "The display name of the package", "type": "string" }, "package_key": { "description": "The unique package key within the publisher company", "type": "string" }, "package_type": { "description": "The package type", "enum": [ "MANAGED", "UNMANAGED" ], "type": "string" } }, "required": [ "package_display_name", "package_key", "package_type" ], "title": "PackageRequest", "type": "object" }, "RestApiPackageSandboxLinkRequeste6847f01192a": { "description": "Request to link a package to a sandbox, or poll an EDIT-mode installation tracker.", "properties": { "mode": { "description": "How the sandbox is linked to the package (INSTALL or EDIT)", "type": "string" }, "package_key": { "description": "The package key to link into the sandbox", "type": "string" }, "sandbox_company_id": { "description": "The company receiving the sandbox package installation", "type": "string" } }, "required": [ "mode", "package_key", "sandbox_company_id" ], "title": "PackageSandboxLinkRequest", "type": "object" }, "RestApiPackageVersionRequest4d6cb484e0e4": { "description": "", "properties": { "description": { "description": "The description of the package version", "type": "string" }, "version_number": { "description": "The semantic version number for this package version", "type": "string" } }, "required": [ "version_number" ], "title": "PackageVersionRequest", "type": "object" }, "RestApiPaymentModeChangeItemd65fe0a387e8": { "description": "", "properties": { "payment_mode": { "description": "Canonical Global Payroll payment mode code to apply to the worker in the run. Known labels are DEFAULT (Default), BANK_FILE (Bank file), MANUAL (Manual), SAME_DAY_ACH (Same-day ACH), CHECK_PRINTING (Check printing), and CHECK_MAILING (Check mailing).", "enum": [ "DEFAULT", "BANK_FILE", "MANUAL", "SAME_DAY_ACH", "CHECK_PRINTING", "CHECK_MAILING" ], "type": "string" }, "run_id": { "description": "ID of the draft Global Payroll run to update.", "type": "string" }, "worker_id": { "description": "ID of the worker whose payment mode will be updated.", "type": "string" } }, "required": [ "payment_mode", "run_id", "worker_id" ], "title": "PaymentModeChangeItem", "type": "object" }, "RestApiPaymentModeChangeRequest0db884401aa6": { "description": "", "properties": { "changes": { "description": "Payment mode changes to process. The maximum batch size is 100.", "items": { "$ref": "#/components/schemas/RestApiPaymentModeChangeItemd65fe0a387e8" }, "type": "array" } }, "required": [ "changes" ], "title": "PaymentModeChangeRequest", "type": "object" }, "RestApiPhoneNumber3992736116a5": { "description": "Personal phone number", "properties": { "country_code": { "description": "Country code for the phone number", "type": "string" }, "extension": { "description": "Phone number extension", "type": "string" }, "national_number": { "description": "National phone number without country code", "type": "string" } }, "title": "PhoneNumber", "type": "object" }, "RestApiPhoneNumberab1fa08a2f90": { "description": "Emergency contact phone", "properties": { "country_code": { "description": "Country code for the phone number", "type": "string" }, "extension": { "description": "Phone number extension", "type": "string" }, "national_number": { "description": "National phone number without country code", "type": "string" } }, "title": "PhoneNumber", "type": "object" }, "RestApiQuarterlyScheduleTriggerbeb283499463": { "additionalProperties": false, "properties": { "day_of_month": { "maximum": 31, "minimum": 1, "type": "integer" }, "hour": { "maximum": 23, "minimum": 0, "type": "integer" }, "kind": { "enum": [ "quarterly_schedule" ], "type": "string" }, "minute": { "default": 0, "maximum": 59, "minimum": 0, "type": "integer" }, "month_of_year": { "maximum": 12, "minimum": 1, "type": "integer" }, "timezone": { "type": "string" } }, "required": [ "day_of_month", "hour", "kind", "month_of_year", "timezone" ], "title": "QuarterlyScheduleTrigger", "type": "object" }, "RestApiRangeValue2761fa5b9a1c": { "description": "Range bounds for 'between' and 'not_between' operators", "required": [ "from", "to" ], "title": "RangeValue", "type": "object" }, "RestApiRegisteredCallbackActionf36112ca9efd": { "additionalProperties": false, "properties": { "id": { "minLength": 1, "type": "string" }, "implementation_config": { "minLength": 1, "type": "string" }, "kind": { "enum": [ "registered_callback" ], "type": "string" }, "owner_id": { "minLength": 1, "type": "string" }, "owner_type": { "minLength": 1, "type": "string" } }, "required": [ "id", "implementation_config", "kind", "owner_id", "owner_type" ], "title": "RegisteredCallbackAction", "type": "object" }, "RestApiReportFilter991a66c22c03": { "description": "A single filter to apply when running a report. The expected shape of 'value' depends on the operator — see the FilterOperator description for details.", "properties": { "field_id": { "description": "The ID of the report field to filter on", "type": "string" }, "operator": { "description": "Comparison operator for the filter. Single-value operators (EQ, NE, GT, GTE, LT, LTE, STARTS_WITH, ENDS_WITH, CONTAINS, NOT_CONTAINS, BEFORE, AFTER) require a scalar value. List operators (IN, NOT_IN) require a non-empty array. Range operators (BETWEEN, NOT_BETWEEN) require an object with 'from' and 'to' keys. No-value operators (IS_EMPTY, IS_NOT_EMPTY) do not require a value. Rolling-date operators (LAST_N, NEXT_N) require an object with 'unit' (DAY, WEEK, MONTH, YEAR) and 'n' (integer). Calendar-date operators (CURRENT_CALENDAR, PREVIOUS_CALENDAR) require a unit string (DAY, WEEK, MONTH, QUARTER, YEAR).", "enum": [ "EQ", "NE", "IN", "NOT_IN", "STARTS_WITH", "ENDS_WITH", "CONTAINS", "NOT_CONTAINS", "GT", "GTE", "LT", "LTE", "BETWEEN", "NOT_BETWEEN", "IS_EMPTY", "IS_NOT_EMPTY", "BEFORE", "AFTER", "LAST_N", "NEXT_N", "CURRENT_CALENDAR", "PREVIOUS_CALENDAR" ], "title": "FilterOperator", "type": "string" }, "value": { "anyOf": [ { "description": "The filter value. Shape depends on the operator: scalar for single-value operators; array for list operators; RangeValue object ({from, to}) for range operators; RollingDateValue object ({unit, n}) for rolling-date operators; unit string for calendar-date operators; omitted or null for IS_EMPTY/IS_NOT_EMPTY.", "oneOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "array" }, { "$ref": "#/components/schemas/RestApiRangeValue2761fa5b9a1c" }, { "$ref": "#/components/schemas/RestApiRollingDateValue3eec6ccc6843" } ] }, { "type": "null" } ] } }, "required": [ "field_id", "operator" ], "title": "ReportFilter", "type": "object" }, "RestApiReportRunPostRequest8e2cda9e195a": { "properties": { "filters": { "anyOf": [ { "default": null, "description": "Optional list of filters to apply when running the report", "items": { "$ref": "#/components/schemas/RestApiReportFilter991a66c22c03" }, "type": "array" }, { "type": "null" } ] }, "format_currency_fields": { "anyOf": [ { "anyOf": [ { "properties": { "columns": { "description": "Currency column format for currency fields", "enum": [ "TYPE_AND_AMOUNT", "VALUE_ONLY" ], "title": "CurrencyColumn", "type": "string" }, "currency_type": { "anyOf": [ { "description": "Currency type (e.g., 'USD')", "type": "string" }, { "type": "null" } ] } }, "required": [ "columns" ], "title": "CurrencyFieldFormatting", "type": "object" }, { "type": "null" } ], "default": null, "description": "Formatting options for currency fields" }, { "type": "null" } ] }, "format_date_fields": { "anyOf": [ { "anyOf": [ { "properties": { "date_format": { "description": "Date format for date fields in the report output", "enum": [ "ISO_8601", "APPLY_VISUALIZATION_SETTINGS" ], "title": "DateFormat", "type": "string" }, "datetime_timezone": { "anyOf": [ { "description": "Timezone for datetime fields (e.g., 'America/Los_Angeles')", "type": "string" }, { "type": "null" } ] } }, "required": [ "date_format" ], "title": "DateFieldFormatting", "type": "object" }, { "type": "null" } ], "default": null, "description": "Formatting options for date fields" }, { "type": "null" } ] }, "include_object_ids": { "default": false, "description": "Whether to include object IDs in the report output", "type": "boolean" }, "include_total_rows": { "default": false, "description": "Whether to include total row count in the report output", "type": "boolean" }, "output_type": { "default": "JSON", "description": "Output format for the report data", "enum": [ "JSON", "CSV" ], "title": "ReportOutputType", "type": "string" }, "report_id": { "description": "The ID of the report to run", "type": "string" }, "view_as": { "default": "VIEWER", "description": "Controls whose permissions are used when running the report. VIEWER (default) uses the API token owner's own permissions. OWNER uses the report owner's permissions (requires owner-level access to the report).", "enum": [ "VIEWER", "OWNER" ], "title": "ViewAs", "type": "string" } }, "required": [ "report_id" ], "title": "ReportRunPostRequest", "type": "object" }, "RestApiRollingDateValue3eec6ccc6843": { "description": "Rolling date window for 'last_n' and 'next_n' operators", "required": [ "n", "unit" ], "title": "RollingDateValue", "type": "object" }, "RestApiRunQueryPayload0dca2531779e": { "properties": { "product_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "query": { "type": "string" } }, "required": [ "query" ], "title": "RunQueryPayload", "type": "object" }, "RestApiSandboxRequestce3f5dcd4394": { "description": "", "properties": { "config_override": { "description": "Type-specific sandbox configuration. Optional for developer sandboxes.", "properties": { "custom_objects": { "description": "Custom objects copied into the sandbox.", "properties": { "co_api_names": { "description": "Custom object API names copied into the sandbox.", "items": { "type": "string" }, "type": "array" } }, "title": "CustomObjectsConfig", "type": "object" }, "developer": { "description": "Required for developer sandboxes and omitted for full-data sandboxes.", "properties": { "company_size": { "description": "Seed company size for the developer sandbox. MEDIUM is the supported value for new sandboxes. SMALL is retained for existing sandboxes only and is not supported on create.", "enum": [ "SMALL", "MEDIUM" ], "type": "string" } }, "required": [ "company_size" ], "title": "DeveloperConfig", "type": "object" }, "general_notifications": { "description": "General outbound notification controls.", "properties": { "email": { "description": "Email notification configuration.", "properties": { "allowed_users": { "description": "Users allowed to receive outbound messages.", "items": { "type": "string" }, "type": "array" }, "outbound_behavior": { "description": "Whether outbound messages are allowed or suppressed.", "enum": [ "SUPPRESS", "ALLOW" ], "type": "string" } }, "required": [ "outbound_behavior" ], "title": "ChannelConfig", "type": "object" }, "push_notifications": { "description": "Push notification configuration.", "properties": { "allowed_users": { "description": "Users allowed to receive outbound messages.", "items": { "type": "string" }, "type": "array" }, "outbound_behavior": { "description": "Whether outbound messages are allowed or suppressed.", "enum": [ "SUPPRESS", "ALLOW" ], "type": "string" } }, "required": [ "outbound_behavior" ], "title": "ChannelConfig", "type": "object" }, "slack": { "description": "Slack notification configuration.", "properties": { "allowed_public_channels": { "description": "Public channels allowed to receive outbound messages.", "items": { "type": "string" }, "type": "array" }, "allowed_users": { "description": "Users allowed to receive outbound messages.", "items": { "type": "string" }, "type": "array" }, "outbound_behavior": { "description": "Whether outbound messages are allowed or suppressed.", "enum": [ "SUPPRESS", "ALLOW" ], "type": "string" } }, "required": [ "outbound_behavior" ], "title": "PublicChannelConfig", "type": "object" }, "sms": { "description": "SMS notification configuration.", "properties": { "allowed_users": { "description": "Users allowed to receive outbound messages.", "items": { "type": "string" }, "type": "array" }, "outbound_behavior": { "description": "Whether outbound messages are allowed or suppressed.", "enum": [ "SUPPRESS", "ALLOW" ], "type": "string" } }, "required": [ "outbound_behavior" ], "title": "ChannelConfig", "type": "object" }, "teams": { "description": "Microsoft Teams notification configuration.", "properties": { "allowed_public_channels": { "description": "Public channels allowed to receive outbound messages.", "items": { "type": "string" }, "type": "array" }, "allowed_users": { "description": "Users allowed to receive outbound messages.", "items": { "type": "string" }, "type": "array" }, "outbound_behavior": { "description": "Whether outbound messages are allowed or suppressed.", "enum": [ "SUPPRESS", "ALLOW" ], "type": "string" } }, "required": [ "outbound_behavior" ], "title": "PublicChannelConfig", "type": "object" } }, "required": [ "email", "push_notifications", "sms" ], "title": "GeneralNotificationsConfig", "type": "object" }, "integrations": { "description": "Required for connected full-data sandboxes.", "properties": { "is_risk_acknowledged": { "description": "Confirms acceptance of the risks of connected third-party integrations.", "type": "boolean" } }, "required": [ "is_risk_acknowledged" ], "title": "IntegrationsConfig", "type": "object" }, "sandbox_mode": { "description": "Required for full-data sandboxes. Developer sandboxes default to CONNECTED.", "enum": [ "CONNECTED", "ISOLATED" ], "type": "string" }, "workflow_webhooks": { "description": "Workflow webhook controls.", "properties": { "allowed_ips": { "description": "IP addresses allowed to receive workflow webhooks.", "items": { "type": "string" }, "type": "array" }, "allowlisted_webhook_urls": { "description": "Webhook URLs allowed in the sandbox.", "items": { "type": "string" }, "type": "array" }, "outbound_behavior": { "description": "Whether workflow webhook traffic is allowed or suppressed.", "enum": [ "SUPPRESS", "ALLOW" ], "type": "string" } }, "title": "WorkflowWebhookConfig", "type": "object" } }, "title": "SandboxConfig", "type": "object" }, "description": { "description": "Optional sandbox description.", "type": "string" }, "name": { "description": "Display name of the sandbox.", "type": "string" }, "type": { "description": "Sandbox type: developer or full data.", "type": "string" } }, "required": [ "name", "type" ], "title": "SandboxRequest", "type": "object" }, "RestApiScheduleRequestae792d0b2001": { "description": "", "properties": { "managers_id": { "description": "The IDs of the managers of the schedule.", "items": { "type": "string" }, "type": "array" }, "members_id": { "description": "The IDs of the members of the schedule.", "items": { "type": "string" }, "type": "array" }, "name": { "description": "The name of the schedule.", "type": "string" }, "observers_id": { "description": "The IDs of the observers of the schedule.", "items": { "type": "string" }, "type": "array" }, "settings": { "description": "The settings of the schedule.", "properties": { "timezone": { "description": "The IANA timezone identifier for the schedule (e.g., 'America/New_York'). Accepted values are defined by the tz database, listed here: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones", "type": "string" } }, "title": "ScheduleSettingsRequest", "type": "object" } }, "title": "ScheduleRequest", "type": "object" }, "RestApiScheduleUpdateRequest93873d368ab1": { "description": "", "properties": { "managers_id": { "description": "The IDs of the managers of the schedule.", "items": { "type": "string" }, "type": "array" }, "members_id": { "description": "The IDs of the members of the schedule.", "items": { "type": "string" }, "type": "array" }, "name": { "description": "The name of the schedule.", "type": "string" }, "observers_id": { "description": "The IDs of the observers of the schedule.", "items": { "type": "string" }, "type": "array" }, "settings": { "description": "The settings of the schedule.", "properties": { "timezone": { "description": "The IANA timezone identifier for the schedule (e.g., 'America/New_York'). Accepted values are defined by the tz database, listed here: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones", "type": "string" } }, "title": "ScheduleSettingsRequest", "type": "object" } }, "title": "ScheduleUpdateRequest", "type": "object" }, "RestApiSettingRequest17d90ee259ac": { "description": "", "properties": { "api_name": { "description": "The unique api name of the setting", "type": "string" }, "boolean_value": { "description": "Boolean value of the setting, if it has boolean data type", "type": "boolean" }, "data_type": { "description": "Data type of the setting", "type": "string" }, "display_name": { "description": "The display name of setting", "type": "string" }, "number_value": { "description": "Number value of the setting, if it has number data type", "type": "number" }, "secret_value": { "description": "Secret value of the setting, if it has secret data type", "type": "string" }, "string_value": { "description": "String value of the setting, if it has string data type", "type": "string" }, "value": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] } }, "title": "SettingRequest", "type": "object" }, "RestApiShiftAssignmentRequestb8d06a3a8c35": { "description": "", "properties": { "is_published": { "description": "Whether the shift assignment is published. If true, the published_version will be the same as the shift_data", "type": "boolean" }, "schedule_id": { "description": "The ID of the schedule", "type": "string" }, "shift_data": { "description": "The data of the shift", "properties": { "end_time": { "description": "The end time of the shift", "type": "string" }, "notes": { "description": "Notes for the shift, max length 256 characters", "maxLength": 256, "type": "string" }, "shift_breaks": { "description": "The breaks of the shift", "items": { "$ref": "#/components/schemas/RestApiShiftBreakRequestb7a5fdb2be33" }, "type": "array" }, "shift_segments": { "description": "The segments of the shift", "items": { "$ref": "#/components/schemas/RestApiShiftSegmentRequest6dd481e255cb" }, "type": "array" }, "start_time": { "description": "The start time of the shift", "type": "string" } }, "required": [ "end_time", "start_time" ], "title": "ShiftDataRequest", "type": "object" }, "worker_id": { "description": "The ID of the worker. Empty string '' to unassign if shift is from an open/empty shift.", "type": "string" } }, "required": [ "is_published", "schedule_id", "shift_data", "worker_id" ], "title": "ShiftAssignmentRequest", "type": "object" }, "RestApiShiftAssignmentUpdateRequest99692ad4196e": { "description": "", "properties": { "is_published": { "description": "Whether the shift assignment is published. If true, the published_version will be the same as the shift_data", "type": "boolean" }, "shift_data": { "description": "The data of the shift", "properties": { "end_time": { "description": "The end time of the shift", "type": "string" }, "notes": { "description": "Notes for the shift, max length 256 characters", "maxLength": 256, "type": "string" }, "shift_breaks": { "description": "The breaks of the shift", "items": { "$ref": "#/components/schemas/RestApiShiftBreakRequestb7a5fdb2be33" }, "type": "array" }, "shift_segments": { "description": "The segments of the shift", "items": { "$ref": "#/components/schemas/RestApiShiftSegmentRequest6dd481e255cb" }, "type": "array" }, "start_time": { "description": "The start time of the shift", "type": "string" } }, "required": [ "end_time", "start_time" ], "title": "ShiftDataRequest", "type": "object" }, "worker_id": { "description": "The ID of the worker. Empty string '' to unassign if shift is from an open/empty shift.", "type": "string" } }, "required": [ "is_published", "shift_data", "worker_id" ], "title": "ShiftAssignmentUpdateRequest", "type": "object" }, "RestApiShiftBreakRequestb7a5fdb2be33": { "description": "", "properties": { "duration_minutes": { "description": "The duration of the shift break in minutes (input only for creation)", "type": "integer" }, "start_time": { "description": "The start time of the shift break", "type": "string" }, "type": { "description": "The type of the shift break", "enum": [ "MEAL", "REST" ], "type": "string" } }, "required": [ "duration_minutes", "start_time", "type" ], "title": "ShiftBreakRequest", "type": "object" }, "RestApiShiftInputRequest5a68b9e7a5a3": { "description": "", "properties": { "country_code": { "description": "Two letter string designating country code which the shift input is associated.", "type": "string" }, "creator_id": { "description": "The creator id associated with the shift input.", "type": "string" }, "name": { "description": "Name of the shift unit.", "type": "string" }, "prompt": { "description": "Prompt for the shift unit.", "type": "string" }, "type": { "description": "Type of shift unit.", "type": "string" } }, "required": [ "country_code", "name", "prompt", "type" ], "title": "ShiftInputRequest", "type": "object" }, "RestApiShiftInputUpdateRequestb4370b191230": { "description": "", "properties": { "country_code": { "description": "Two letter string designating country code which the shift input is associated.", "type": "string" }, "creator_id": { "description": "The creator id associated with the shift input.", "type": "string" }, "name": { "description": "Name of the shift unit.", "type": "string" }, "prompt": { "description": "Prompt for the shift unit.", "type": "string" }, "type": { "description": "Type of shift unit.", "type": "string" } }, "title": "ShiftInputUpdateRequest", "type": "object" }, "RestApiShiftInputValueRequest0e36b54ffa29": { "description": "", "properties": { "author_id": { "description": "The id of the role that last added/updated this input.", "type": "string" }, "shift_input_id": { "description": "The id of the relevant shift input", "type": "string" }, "value": { "description": "The value of the shift input.", "type": "object" } }, "required": [ "shift_input_id", "value" ], "title": "ShiftInputValueRequest", "type": "object" }, "RestApiShiftSegmentRequest6dd481e255cb": { "description": "", "properties": { "duration_minutes": { "description": "The duration of the shift segment in minutes (input only for creation)", "type": "integer" }, "job_codes_id": { "description": "The IDs of the job codes associated with the shift segment", "items": { "type": "string" }, "type": "array" }, "start_time": { "description": "The start time of the shift segment", "type": "string" } }, "required": [ "duration_minutes", "start_time" ], "title": "ShiftSegmentRequest", "type": "object" }, "RestApiSiteFileOperationa72a65032229": { "description": "", "properties": { "file_id": { "description": "Staged upload id from POST /sites/upload-batches/presign/ after uploading bytes to S3. Required for put operations on files. The id can be reused for 1 hour from presign, each attach copies the bytes into that site's bundle, a repeat attach before expiry creates another bundle, and the staged object is removed after expiry.", "type": "string" }, "from_path": { "description": "Source path for rename and move operations.", "type": "string" }, "kind": { "description": "Target kind. Supported values are file and directory.", "type": "string" }, "op": { "description": "Operation type. Supported values are put, rename, move, and delete. move is valid for files only; directories support put, rename, and delete.", "type": "string" }, "path": { "description": "Target path for put and delete operations.", "type": "string" }, "recursive": { "description": "When true, delete directory removes nested files. Used by delete directory operations.", "type": "boolean" }, "to_path": { "description": "Destination path for rename and move operations.", "type": "string" } }, "required": [ "kind", "op" ], "title": "SiteFileOperation", "type": "object" }, "RestApiSiteFileOperationsRequest07e1ffd39219": { "description": "", "properties": { "base_bundle_id": { "description": "Must match the site's current active bundle. Returns 409 when stale.", "type": "string" }, "entry_path": { "description": "Optional bundle entry path. When omitted, the current entry path is kept.", "type": "string" }, "operations": { "description": "Non-empty array of file or directory operations.", "items": { "$ref": "#/components/schemas/RestApiSiteFileOperationa72a65032229" }, "type": "array" } }, "required": [ "base_bundle_id", "operations" ], "title": "SiteFileOperationsRequest", "type": "object" }, "RestApiSitePresignUploadBatchRequest569906f97a77": { "description": "", "properties": { "file_intents": { "description": "Non-empty array of file upload intents to stage with presigned S3 upload URLs.", "items": { "$ref": "#/components/schemas/RestApiSitePresignUploadFileRequesta0258fb036e8" }, "type": "array" } }, "required": [ "file_intents" ], "title": "SitePresignUploadBatchRequest", "type": "object" }, "RestApiSitePresignUploadFileRequesta0258fb036e8": { "description": "", "properties": { "client_ref": { "description": "Any unique client-chosen id echoed with the staged file_id for correlation. Not used server-side beyond the response.", "type": "string" }, "file_name": { "description": "File name with extension (e.g. site.zip). Used to derive Content-Type and create/PATCH asset type.", "type": "string" } }, "required": [ "client_ref", "file_name" ], "title": "SitePresignUploadFileRequest", "type": "object" }, "RestApiSiteWriteRequest62ccf03a4f5e": { "description": "Request body for create/PATCH using a staged upload file_id.", "properties": { "api_name": { "description": "The unique api name of the custom site", "type": "string" }, "description": { "description": "The optional description of the custom site", "type": "string" }, "entry_path": { "description": "Entry path inside the uploaded asset (for example index.html). Required with file_id when the zip has no index.html.", "type": "string" }, "file_id": { "description": "Staged upload id from POST /sites/upload-batches/presign/ after uploading bytes to S3. Required to create a site or replace the bundle. The id can be reused for 1 hour from presign, each attach copies the bytes into that site's bundle, a repeat attach before expiry creates another bundle, and the staged object is removed after expiry.", "type": "string" }, "logo": { "description": "A Rippling-owned logo URL for the custom site", "type": "string" }, "name": { "description": "The display name of the custom site", "type": "string" } }, "title": "SiteWriteRequest", "type": "object" }, "RestApiSlackTriggerf09888f51404": { "additionalProperties": false, "properties": { "allowed_sender_group_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "channel_ids": { "items": { "type": "string" }, "minItems": 1, "type": "array" }, "event_type": { "enum": [ "message_posted", "reaction_added" ], "type": "string" }, "include_thread_replies": { "default": false, "type": "boolean" }, "kind": { "enum": [ "slack" ], "type": "string" }, "message_text_regex": { "anyOf": [ { "maxLength": 512, "type": "string" }, { "type": "null" } ] }, "reaction_names": { "items": { "type": "string" }, "type": "array" } }, "required": [ "channel_ids", "event_type", "kind" ], "title": "SlackTrigger", "type": "object" }, "RestApiSoftwareDeploymentRequest8e07af01b521": { "description": "", "properties": { "active_group_type": { "description": "Type of group targeting: 'Role' or 'Device'.", "enum": [ "Role", "Device" ], "type": "string" }, "group_id": { "description": "Group ID for role-based targeting. Required if active_group_type is 'Role'. Must be null if 'Device'.", "type": "string" }, "ma_device_group_id": { "description": "Device group ID for device-based targeting. Required if active_group_type is 'Device'. Must be null if 'Role'.", "type": "string" }, "software_id": { "description": "The ID of the software to deploy.", "type": "string" } }, "required": [ "software_id" ], "title": "SoftwareDeploymentRequest", "type": "object" }, "RestApiSoftwareDeploymentUpdateRequest5daff46e1b2c": { "description": "", "properties": { "active_group_type": { "description": "Type of group targeting: 'Role' or 'Device'.", "enum": [ "Role", "Device" ], "type": "string" }, "group_id": { "description": "Group ID for role-based targeting. Required if active_group_type is 'Role'. Must be null if 'Device'.", "type": "string" }, "ma_device_group_id": { "description": "Device group ID for device-based targeting. Required if active_group_type is 'Device'. Must be null if 'Role'.", "type": "string" }, "software_id": { "description": "The ID of the software to deploy.", "type": "string" } }, "title": "SoftwareDeploymentUpdateRequest", "type": "object" }, "RestApiSplit283f489e3a65": { "description": "A single split row representing a percentage allocation across one or more job codes.", "properties": { "job_code_ids": { "description": "IDs of canonical /job-codes/ resources in this split row.", "items": { "type": "string" }, "type": "array" }, "split_percentage": { "description": "Percentage allocated to this split row. Decimal string with precision 2; must be greater than zero per row. All rows must sum to 100.00 when is_enabled is true.", "type": "string" } }, "title": "Split", "type": "object" }, "RestApiTeamRequest30691743f0d2": { "description": "", "properties": { "name": { "description": "The name of the team.", "type": "string" }, "parent_id": { "description": "The parent team", "type": "string" } }, "required": [ "name" ], "title": "TeamRequest", "type": "object" }, "RestApiTeamUpdateRequest853d6d6a14ca": { "description": "", "properties": { "name": { "description": "The name of the team.", "type": "string" }, "parent_id": { "description": "The parent team", "type": "string" } }, "title": "TeamUpdateRequest", "type": "object" }, "RestApiTimeEntryCommentRequest046bac2302bb": { "description": "", "properties": { "text": { "description": "The text of the comment.", "type": "string" } }, "title": "TimeEntryCommentRequest", "type": "object" }, "RestApiTimeEntryRequeste575cc21e300": { "description": "", "properties": { "breaks": { "description": "The breaks taken during the time entry.", "items": { "$ref": "#/components/schemas/RestApiBreakRequestdaec83e5b054" }, "type": "array" }, "comments": { "description": "The comments associated with the time entry.", "items": { "$ref": "#/components/schemas/RestApiTimeEntryCommentRequest046bac2302bb" }, "type": "array" }, "create_extra_hours_run": { "description": "Whether the time entry should create an extra hours run.", "type": "boolean" }, "duration": { "description": "The duration of the time entry.", "type": "number" }, "idempotency_key": { "description": "The unique key of the time entry in an outside system. If set, no other time entry with the same key can be created.", "type": "string" }, "job_shifts": { "description": "The job shifts worked during the time entry.", "items": { "$ref": "#/components/schemas/RestApiJobShiftRequest9ea8c446f52b" }, "type": "array" }, "pay_period": { "description": "The pay period associated with the time card.", "properties": { "end_date": { "description": "The end date of the pay period.", "type": "string" }, "pay_schedule_id": { "description": "The ID of the pay schedule associated with the pay period.", "type": "string" }, "start_date": { "description": "The start date of the pay period.", "type": "string" } }, "title": "PayPeriodRequest", "type": "object" }, "shift_input_values": { "description": "Arbitrary shift inputs collected on the time entry", "items": { "$ref": "#/components/schemas/RestApiShiftInputValueRequest0e36b54ffa29" }, "type": "array" }, "start_date": { "description": "The date of the time entry if using duration.", "type": "string" }, "status": { "description": "The status of the time entry.", "enum": [ "DRAFT", "APPROVED", "PAID", "FINALIZED" ], "type": "string" }, "tags": { "description": "The tags associated with the time entry.", "items": { "type": "string" }, "type": "array" }, "worker_id": { "description": "The ID of the worker associated with the time entry.", "type": "string" } }, "required": [ "worker_id" ], "title": "TimeEntryRequest", "type": "object" }, "RestApiTimeKioskBadgeRequest3f416489de5e": { "description": "", "properties": { "badge_id": { "description": "The ID associated with the badge. Not to be confused with the record's ID.", "type": "string" }, "is_enabled": { "description": "Whether this badge can be used with the Kiosk app.", "type": "boolean" }, "worker_id": { "description": "The ID of the worker associated with the badge.", "type": "string" }, "worker_number": { "description": "The employee number of the worker associated with the badge.", "type": "integer" } }, "required": [ "badge_id" ], "title": "TimeKioskBadgeRequest", "type": "object" }, "RestApiTimeKioskBadgeUpdateRequest0d5d854b7006": { "description": "", "properties": { "badge_id": { "description": "The ID associated with the badge. Not to be confused with the record's ID.", "type": "string" }, "is_enabled": { "description": "Whether this badge can be used with the Kiosk app.", "type": "boolean" }, "worker_id": { "description": "The ID of the worker associated with the badge.", "type": "string" }, "worker_number": { "description": "The employee number of the worker associated with the badge.", "type": "integer" } }, "title": "TimeKioskBadgeUpdateRequest", "type": "object" }, "RestApiTitleRequest91f324257cba": { "description": "", "properties": { "name": { "description": "The name of the title.", "type": "string" } }, "required": [ "name" ], "title": "TitleRequest", "type": "object" }, "RestApiTrackRequest27dec0cf6b01": { "description": "", "properties": { "name": { "description": "The name of the track. Must be unique within the company or organization.", "type": "string" }, "order": { "description": "The one-based horizontal display order of the track.", "type": "integer" } }, "required": [ "name" ], "title": "TrackRequest", "type": "object" }, "RestApiTrackUpdateRequesta319ed221f17": { "description": "", "properties": { "name": { "description": "The name of the track. Must be unique within the company or organization.", "type": "string" }, "order": { "description": "The one-based horizontal display order of the track.", "type": "integer" } }, "title": "TrackUpdateRequest", "type": "object" }, "RestApiUnassignedShiftRequest78ce5687262e": { "description": "", "properties": { "is_published": { "description": "Whether the shift is published", "type": "boolean" }, "open_shift_config": { "description": "Configuration for an open shift. If present, this is an open shift (workers can sign up). If absent/None, this is an empty shift (placeholder).", "properties": {}, "title": "OpenShiftConfigRequest", "type": "object" }, "schedule_id": { "description": "The ID of the schedule", "type": "string" }, "shift_data": { "description": "The data of the shift", "properties": { "end_time": { "description": "The end time of the shift", "type": "string" }, "notes": { "description": "Notes for the shift, max length 256 characters", "maxLength": 256, "type": "string" }, "shift_breaks": { "description": "The breaks of the shift", "items": { "$ref": "#/components/schemas/RestApiShiftBreakRequestb7a5fdb2be33" }, "type": "array" }, "shift_segments": { "description": "The segments of the shift", "items": { "$ref": "#/components/schemas/RestApiShiftSegmentRequest6dd481e255cb" }, "type": "array" }, "start_time": { "description": "The start time of the shift", "type": "string" } }, "required": [ "end_time", "start_time" ], "title": "ShiftDataRequest", "type": "object" }, "target_count": { "description": "The target count of the shift", "type": "integer" } }, "required": [ "is_published", "schedule_id", "shift_data", "target_count" ], "title": "UnassignedShiftRequest", "type": "object" }, "RestApiUnassignedShiftUpdateRequesteed03fbd95e9": { "description": "", "properties": { "is_published": { "description": "Whether the shift is published", "type": "boolean" }, "open_shift_config": { "description": "Configuration for an open shift. If present, this is an open shift (workers can sign up). If absent/None, this is an empty shift (placeholder).", "properties": {}, "title": "OpenShiftConfigRequest", "type": "object" }, "shift_data": { "description": "The data of the shift", "properties": { "end_time": { "description": "The end time of the shift", "type": "string" }, "notes": { "description": "Notes for the shift, max length 256 characters", "maxLength": 256, "type": "string" }, "shift_breaks": { "description": "The breaks of the shift", "items": { "$ref": "#/components/schemas/RestApiShiftBreakRequestb7a5fdb2be33" }, "type": "array" }, "shift_segments": { "description": "The segments of the shift", "items": { "$ref": "#/components/schemas/RestApiShiftSegmentRequest6dd481e255cb" }, "type": "array" }, "start_time": { "description": "The start time of the shift", "type": "string" } }, "required": [ "end_time", "start_time" ], "title": "ShiftDataRequest", "type": "object" }, "target_count": { "description": "The target count of the shift", "type": "integer" } }, "required": [ "is_published", "shift_data", "target_count" ], "title": "UnassignedShiftUpdateRequest", "type": "object" }, "RestApiVariableCompensationPayoutLabelRequest60f3ef2b1788": { "description": "", "properties": { "client": { "description": "Client system that created the label.", "type": "string" }, "external_id": { "description": "External identifier unique per company and client.", "type": "string" }, "name": { "description": "Display name of the label.", "type": "string" } }, "required": [ "client", "external_id", "name" ], "title": "VariableCompensationPayoutLabelRequest", "type": "object" }, "RestApiVariableCompensationPayoutTypeMapping70ecab311989": { "description": "", "properties": { "earning_code": { "description": "Mapped earning code for the payroll entity.", "type": "string" }, "earning_display_name": { "description": "Display name of the mapped earning code at response time. Convenience snapshot for the mapping matrix; authoritative earning metadata lives in payroll, not this field.", "type": "string" }, "entity_id": { "description": "ID of the payroll entity this mapping applies to.", "type": "string" }, "entity_name": { "description": "Display name of the payroll entity at response time. Convenience snapshot for the mapping matrix; authoritative entity data lives on payroll entities, not this field.", "type": "string" }, "health": { "description": "Mapping health status.", "type": "string" } }, "required": [ "entity_id", "health" ], "title": "VariableCompensationPayoutTypeMapping", "type": "object" }, "RestApiVariableCompensationPayoutTypeRequest4e2e227a6620": { "description": "", "properties": { "display_name": { "description": "Display name of the payout type.", "type": "string" }, "mappings": { "description": "Per-entity earning code mappings.", "items": { "$ref": "#/components/schemas/RestApiVariableCompensationPayoutTypeMapping70ecab311989" }, "type": "array" } }, "required": [ "display_name" ], "title": "VariableCompensationPayoutTypeRequest", "type": "object" }, "RestApiVariableCompensationPayoutWriteRequest5967d891135e": { "description": "", "properties": { "ai_conditions_summary": { "description": "Optional markdown summary of the eligibility conditions.", "type": "string" }, "amount_base": { "description": "Payout amount.", "properties": { "currency_type": { "description": "Three-letter currency code.", "type": "string" }, "value": { "description": "Decimal payout amount encoded as a string.", "type": "string" } }, "required": [ "currency_type", "value" ], "title": "PayoutCurrency", "type": "object" }, "eligibility_sql": { "description": "SQL eligibility expression. Omit to use the active-role default.", "type": "string" }, "group_name": { "description": "Optional payout group label.", "type": "string" }, "payee_id": { "description": "ID of the worker who receives this payout.", "type": "string" }, "payment_type": { "description": "Key of the company payment type used for this payout.", "type": "string" }, "scheduled_date": { "description": "Date on which the payout is scheduled.", "type": "string" } }, "required": [ "amount_base", "payee_id", "payment_type", "scheduled_date" ], "title": "VariableCompensationPayoutWriteRequest", "type": "object" }, "RestApiWeekdayScheduleTriggera236cc90a54c": { "additionalProperties": false, "properties": { "hour": { "maximum": 23, "minimum": 0, "type": "integer" }, "kind": { "enum": [ "weekday_schedule" ], "type": "string" }, "minute": { "default": 0, "maximum": 59, "minimum": 0, "type": "integer" }, "timezone": { "type": "string" } }, "required": [ "hour", "kind", "timezone" ], "title": "WeekdayScheduleTrigger", "type": "object" }, "RestApiWeeklyScheduleTrigger9d2e794637bc": { "additionalProperties": false, "properties": { "days_of_week": { "items": { "type": "integer" }, "type": "array" }, "hour": { "maximum": 23, "minimum": 0, "type": "integer" }, "kind": { "enum": [ "weekly_schedule" ], "type": "string" }, "minute": { "default": 0, "maximum": 59, "minimum": 0, "type": "integer" }, "timezone": { "type": "string" } }, "required": [ "days_of_week", "hour", "kind", "timezone" ], "title": "WeeklyScheduleTrigger", "type": "object" }, "RestApiWorkLocationRequest56fb7cd83268": { "description": "", "properties": { "address": { "description": "The address for the work location.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "enum": [ "AF", "AX", "AL", "DZ", "AS", "AD", "AO", "AI", "AQ", "AG", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BY", "BE", "BZ", "BJ", "BM", "BT", "BO", "BQ", "BA", "BW", "BV", "BR", "IO", "BN", "BG", "BF", "BI", "CV", "KH", "CM", "CA", "KY", "CF", "TD", "CL", "CN", "CX", "CC", "CO", "KM", "CG", "CD", "CK", "CR", "CI", "HR", "CW", "CY", "CZ", "DK", "DJ", "DM", "DO", "EC", "EG", "SV", "GQ", "ER", "EE", "SZ", "ET", "FK", "FO", "FJ", "FI", "FR", "GF", "PF", "TF", "GA", "GM", "GE", "DE", "GH", "GI", "GR", "GL", "GD", "GP", "GU", "GT", "GG", "GN", "GW", "GY", "HT", "HM", "VA", "HN", "HK", "HU", "IS", "IN", "ID", "IQ", "IR", "IE", "IM", "IL", "IT", "JM", "JP", "JE", "JO", "KZ", "KE", "KI", "KR", "XK", "KW", "KG", "LA", "LV", "LB", "LS", "LR", "LY", "LI", "LT", "LU", "MO", "MG", "MW", "MY", "MV", "ML", "MT", "MH", "MQ", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MA", "MZ", "MM", "NA", "NR", "NP", "NL", "AN", "NC", "NZ", "NI", "NE", "NG", "NU", "NF", "MK", "MP", "NO", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PH", "PN", "PL", "PT", "PR", "QA", "RO", "RU", "RW", "RE", "BL", "SH", "KN", "LC", "MF", "PM", "VC", "WS", "SM", "ST", "SA", "SN", "RS", "SC", "SL", "SG", "SX", "SY", "SK", "SI", "SB", "SO", "ZA", "GS", "SS", "ES", "LK", "SD", "SR", "SJ", "SE", "CH", "TW", "TJ", "TZ", "TH", "TL", "TG", "TK", "TO", "TT", "TN", "TR", "TM", "TC", "TV", "UG", "UA", "AE", "GB", "US", "UM", "UY", "UZ", "VU", "VE", "VN", "VG", "VI", "WF", "EH", "YE", "ZM", "ZW" ], "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "enum": [ "HOME", "WORK", "OTHER" ], "type": "string" } }, "title": "AddressRequest", "type": "object" }, "name": { "description": "The name of the work location.", "type": "string" } }, "required": [ "address", "name" ], "title": "WorkLocationRequest", "type": "object" }, "RestApiWorkLocationUpdateRequestc0188076a6d1": { "description": "", "properties": { "address": { "description": "The address for the work location.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "enum": [ "AF", "AX", "AL", "DZ", "AS", "AD", "AO", "AI", "AQ", "AG", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BY", "BE", "BZ", "BJ", "BM", "BT", "BO", "BQ", "BA", "BW", "BV", "BR", "IO", "BN", "BG", "BF", "BI", "CV", "KH", "CM", "CA", "KY", "CF", "TD", "CL", "CN", "CX", "CC", "CO", "KM", "CG", "CD", "CK", "CR", "CI", "HR", "CW", "CY", "CZ", "DK", "DJ", "DM", "DO", "EC", "EG", "SV", "GQ", "ER", "EE", "SZ", "ET", "FK", "FO", "FJ", "FI", "FR", "GF", "PF", "TF", "GA", "GM", "GE", "DE", "GH", "GI", "GR", "GL", "GD", "GP", "GU", "GT", "GG", "GN", "GW", "GY", "HT", "HM", "VA", "HN", "HK", "HU", "IS", "IN", "ID", "IQ", "IR", "IE", "IM", "IL", "IT", "JM", "JP", "JE", "JO", "KZ", "KE", "KI", "KR", "XK", "KW", "KG", "LA", "LV", "LB", "LS", "LR", "LY", "LI", "LT", "LU", "MO", "MG", "MW", "MY", "MV", "ML", "MT", "MH", "MQ", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MA", "MZ", "MM", "NA", "NR", "NP", "NL", "AN", "NC", "NZ", "NI", "NE", "NG", "NU", "NF", "MK", "MP", "NO", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PH", "PN", "PL", "PT", "PR", "QA", "RO", "RU", "RW", "RE", "BL", "SH", "KN", "LC", "MF", "PM", "VC", "WS", "SM", "ST", "SA", "SN", "RS", "SC", "SL", "SG", "SX", "SY", "SK", "SI", "SB", "SO", "ZA", "GS", "SS", "ES", "LK", "SD", "SR", "SJ", "SE", "CH", "TW", "TJ", "TZ", "TH", "TL", "TG", "TK", "TO", "TT", "TN", "TR", "TM", "TC", "TV", "UG", "UA", "AE", "GB", "US", "UM", "UY", "UZ", "VU", "VE", "VN", "VG", "VI", "WF", "EH", "YE", "ZM", "ZW" ], "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "enum": [ "HOME", "WORK", "OTHER" ], "type": "string" } }, "title": "AddressRequest", "type": "object" }, "name": { "description": "The name of the work location.", "type": "string" } }, "title": "WorkLocationUpdateRequest", "type": "object" }, "RestApiWorkerTimeSplitRequest9e21ee5b724e": { "description": "Worker time split configuration resource.", "properties": { "is_enabled": { "description": "Whether hard-coded time splits are active for this worker.", "type": "boolean" }, "splits": { "description": "The split rows defining time allocation percentages across job codes. Empty when is_enabled is false.", "items": { "$ref": "#/components/schemas/RestApiSplit283f489e3a65" }, "type": "array" }, "worker_id": { "description": "Identifier of the worker whose time split configuration this represents.", "type": "string" } }, "required": [ "worker_id" ], "title": "WorkerTimeSplitRequest", "type": "object" }, "RestApiWorkflowCreateInput6426e7b47896": { "additionalProperties": false, "properties": { "actions": { "items": { "oneOf": [ { "$ref": "#/components/schemas/RestApiRegisteredCallbackActionf36112ca9efd" } ] }, "maxItems": 160, "minItems": 1, "type": "array" }, "description": { "anyOf": [ { "maxLength": 3000, "type": "string" }, { "type": "null" } ] }, "enabled": { "default": false, "type": "boolean" }, "name": { "maxLength": 150, "minLength": 1, "type": "string" }, "status": { "default": "draft", "enum": [ "draft", "published" ], "type": "string" }, "trigger": { "oneOf": [ { "$ref": "#/components/schemas/RestApiAnnualScheduleTrigger9e9c8bf96230" }, { "$ref": "#/components/schemas/RestApiBiweeklyScheduleTriggerc261b277efb4" }, { "$ref": "#/components/schemas/RestApiBusinessEventTrigger16af6dea9307" }, { "$ref": "#/components/schemas/RestApiCronScheduleTrigger0679b602052c" }, { "$ref": "#/components/schemas/RestApiCustomScheduleTriggerdb31666e4bdd" }, { "$ref": "#/components/schemas/RestApiDailyScheduleTriggerf828f14d1d97" }, { "$ref": "#/components/schemas/RestApiInboundEmailTriggera580510d7eb3" }, { "$ref": "#/components/schemas/RestApiManualTrigger01b0ac4a464d" }, { "$ref": "#/components/schemas/RestApiMonthlyOnDayOfWeekScheduleTrigger53d4b16bf970" }, { "$ref": "#/components/schemas/RestApiMonthlyScheduleTrigger105d31bb71a4" }, { "$ref": "#/components/schemas/RestApiOneTimeScheduleTrigger7f8bd364e99f" }, { "$ref": "#/components/schemas/RestApiQuarterlyScheduleTriggerbeb283499463" }, { "$ref": "#/components/schemas/RestApiSlackTriggerf09888f51404" }, { "$ref": "#/components/schemas/RestApiWeekdayScheduleTriggera236cc90a54c" }, { "$ref": "#/components/schemas/RestApiWeeklyScheduleTrigger9d2e794637bc" } ] } }, "required": [ "actions", "name", "trigger" ], "title": "WorkflowCreateInput", "type": "object" }, "RestApiWorkflowPatchInputebb57b89de10": { "additionalProperties": false, "minProperties": 2, "properties": { "actions": { "items": { "oneOf": [ { "$ref": "#/components/schemas/RestApiRegisteredCallbackActionf36112ca9efd" } ] }, "maxItems": 160, "minItems": 1, "type": "array" }, "description": { "anyOf": [ { "maxLength": 3000, "type": "string" }, { "type": "null" } ] }, "enabled": { "type": "boolean" }, "name": { "maxLength": 150, "minLength": 1, "type": "string" }, "status": { "enum": [ "draft", "published" ], "type": "string" }, "trigger": { "oneOf": [ { "$ref": "#/components/schemas/RestApiAnnualScheduleTrigger9e9c8bf96230" }, { "$ref": "#/components/schemas/RestApiBiweeklyScheduleTriggerc261b277efb4" }, { "$ref": "#/components/schemas/RestApiBusinessEventTrigger16af6dea9307" }, { "$ref": "#/components/schemas/RestApiCronScheduleTrigger0679b602052c" }, { "$ref": "#/components/schemas/RestApiCustomScheduleTriggerdb31666e4bdd" }, { "$ref": "#/components/schemas/RestApiDailyScheduleTriggerf828f14d1d97" }, { "$ref": "#/components/schemas/RestApiInboundEmailTriggera580510d7eb3" }, { "$ref": "#/components/schemas/RestApiManualTrigger01b0ac4a464d" }, { "$ref": "#/components/schemas/RestApiMonthlyOnDayOfWeekScheduleTrigger53d4b16bf970" }, { "$ref": "#/components/schemas/RestApiMonthlyScheduleTrigger105d31bb71a4" }, { "$ref": "#/components/schemas/RestApiOneTimeScheduleTrigger7f8bd364e99f" }, { "$ref": "#/components/schemas/RestApiQuarterlyScheduleTriggerbeb283499463" }, { "$ref": "#/components/schemas/RestApiSlackTriggerf09888f51404" }, { "$ref": "#/components/schemas/RestApiWeekdayScheduleTriggera236cc90a54c" }, { "$ref": "#/components/schemas/RestApiWeeklyScheduleTrigger9d2e794637bc" } ] }, "version_id": { "minLength": 1, "type": "string" } }, "required": [ "version_id" ], "title": "WorkflowPatchInput", "type": "object" } } }, "info": { "title": "Rippling rest-api", "version": "2026-10-28" }, "openapi": "3.1.0", "paths": { "/activity-log/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/list-activity-log" }, "operationId": "rippling.rest_api.list_activity_log", "parameters": [ { "in": "query", "name": "filter", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "expand", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 100, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "__meta": { "$ref": "#/components/schemas/OutputRestApiRedactedFields9f7657dc2a2f" }, "next_link": { "description": "A link to the next page of responses.", "format": "uri", "type": "string" }, "results": { "items": { "$ref": "#/components/schemas/OutputRestApiActivityLogEvent62bcfbdf6086" }, "type": "array" } }, "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "List visible activity log events retained from the last 90 days", "x-rippling-entitlements": [ "Activity_Log_Platform_API" ], "x-rippling-required-scopes": [ "activity-log.read" ] } }, "/activity-log/{id}/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/get-activity-log" }, "operationId": "rippling.rest_api.get_activity_log", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "id", "type": "string" } }, { "in": "query", "name": "expand", "required": false, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "__meta": { "properties": { "redacted_fields": { "items": { "$ref": "#/components/schemas/OutputRestApiRedactedField21788a25ef22" }, "type": "array" } }, "type": "object" }, "actor_type": { "description": "The kind of actor that initiated the event. WORKER is a Rippling worker; INTERNAL_BY_WORKER is an internal API request triggered by a worker; SYSTEM is an automated Rippling system process; EXTERNAL is an external system or integration; RIPPLING_MDM is Rippling MDM; PARTNER is a Rippling partner, but the partner identity is not returned; and PROXY is Rippling staff or support acting through proxy. Null when no actor type was recorded.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "event_type": { "description": "The open UPPER_SNAKE_CASE Activity Log code, such as USER_LOGIN_SUCCESS. New codes can appear over time.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "occurred_at": { "description": "The activity occurrence time as an ISO 8601 UTC timestamp. Unlike created_at, which records when the Activity Log record was persisted, occurred_at records when the underlying activity happened.", "type": "string" }, "reason": { "description": "Why the activity occurred. Null when no reason was recorded.", "properties": { "code": { "description": "The machine-readable reason code recorded for the event. Null when no reason was recorded.", "type": "string" }, "message": { "description": "The human-readable meaning of the reason code. Null when no reason was recorded.", "type": "string" } }, "title": "ActivityLogReason", "type": "object" }, "request_context": { "description": "Request and approximate location details captured for the activity. Null for non-request events.", "properties": { "accuracy_radius": { "anyOf": [ { "description": "The accuracy radius of the IP-derived location in kilometers. Null without the activity-log.sensitive-data.read scope or when geolocation is unresolved.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "browser": { "description": "The browser family parsed from the request user agent. Returned with the activity-log.read scope. Null when unavailable.", "type": "string" }, "city": { "description": "The city resolved from the request IP address. Null without the activity-log.sensitive-data.read scope or when geolocation is unresolved.", "type": "string" }, "country": { "description": "The country resolved from the request IP address. Null without the activity-log.sensitive-data.read scope or when geolocation is unresolved.", "type": "string" }, "device": { "description": "The device family parsed from the request user agent. Returned with the activity-log.read scope. Null when unavailable.", "type": "string" }, "ip_address": { "description": "The IPv4 or IPv6 address associated with the request. Null without the activity-log.sensitive-data.read scope.", "type": "string" }, "latitude": { "anyOf": [ { "description": "The approximate latitude in decimal degrees resolved from the request IP address. Null without the activity-log.sensitive-data.read scope or when geolocation is unresolved.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "longitude": { "anyOf": [ { "description": "The approximate longitude in decimal degrees resolved from the request IP address. Null without the activity-log.sensitive-data.read scope or when geolocation is unresolved.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "operating_system": { "description": "The operating system parsed from the request user agent. Returned with the activity-log.read scope. Null when unavailable.", "type": "string" }, "state": { "description": "The state or region resolved from the request IP address. Null without the activity-log.sensitive-data.read scope or when geolocation is unresolved.", "type": "string" } }, "title": "ActivityLogRequestContext", "type": "object" }, "source_app_handle": { "description": "The public app handle used by GET /app-users/ for the Rippling app associated with the activity. Null when the activity is not app-specific.", "type": "string" }, "status": { "description": "The outcome of the activity. SUCCESS means the activity completed successfully; FAILURE means the activity failed. Null when no outcome was recorded.", "type": "string" }, "targets": { "description": "The resources affected by the activity. Empty when no targets were recorded.", "items": { "$ref": "#/components/schemas/OutputRestApiActivityLogTargetd0dee037923e" }, "type": "array" }, "updated_at": { "description": "Record update date", "type": "string" }, "worker": { "description": "The worker who initiated the activity. Request with expand=worker and the workers.read OAuth scope to return the Worker resource.\n\nExpandable field", "properties": { "business_partners": { "description": "Worker's assigned business partners. This field is only populated when explicitly requested via the expand parameter (e.g., ?expand=business_partners). When expanded, returns an empty list ([]) if the worker has no business partners.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiBusinessPartner77b00a069c32" }, "type": "array" }, "business_partners_id": { "description": "Worker's assigned business partners unique identifiers. Returns an empty list ([]) if the worker has no business partners.", "items": { "type": "string" }, "type": "array" }, "citizenship": { "description": "The countries that the worker has citizenship in.", "type": "string" }, "compensation": { "description": "The compensation package for the worker.\n\nExpandable field", "properties": { "annual_compensation": { "description": "The worker's annual compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "annual_salary_equivalent": { "description": "The worker's annual salary equivalent, for insurance purposes. It will be equal to the worker's annual compensation, except for owners that are receiving no cashcompensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "bonus_schedule": { "description": "The worker's bonus schedule.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "hourly_wage": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "id": { "description": "Identifier field", "type": "string" }, "monthly_compensation": { "description": "The worker's monthly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "on_target_commission": { "description": "The worker's on-target commission.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "payment_terms": { "description": "The payment terms for an worker's compensation.", "type": "string" }, "payment_type": { "description": "The payment type for an worker's compensation.", "type": "string" }, "relocation_reimbursement": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "salary_effective_date": { "description": "Salary effective date", "type": "string" }, "signing_bonus": { "description": "The worker's signing bonus.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus": { "description": "The worker's target annual bonus amount.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus_percent": { "anyOf": [ { "description": "The worker's target annual bonus as a percent of annual compensation.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" }, "weekly_compensation": { "description": "The worker's weekly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "worker": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's details.\n\nExpandable field", "type": "object" }, "worker_id": { "description": "The worker's ID.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Compensation", "type": "object" }, "compensation_grade": { "description": "The compensation grade assigned to the worker, if any.", "properties": { "id": { "description": "The compensation grade's unique identifier.", "type": "string" }, "label": { "description": "The compensation grade's label.", "type": "string" } }, "title": "WorkerCompensationGrade", "type": "object" }, "compensation_id": { "description": "The compensation package for the worker.", "type": "string" }, "country": { "description": "The worker's country.", "type": "string" }, "country_fields": { "description": "Country level fields for the worker.", "properties": { "ca": { "description": "Country-wise regional fields for Canada", "properties": { "sin": { "description": "Social Insurance Number (SIN) for Canada employees.", "type": "string" } }, "title": "CanadaFields", "type": "object" }, "nz": { "description": "Country-wise regional fields for New Zealand", "properties": { "ird_number": { "description": "Inland Revenue Department (IRD) number for New Zealand employees.", "type": "string" } }, "title": "NewZealandFields", "type": "object" }, "us": { "description": "Country-wise regional fields for USA", "properties": { "ssn": { "description": "Social Security Number (SSN) for US employees.", "type": "string" } }, "title": "USFields", "type": "object" } }, "title": "CountryFields", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "custom_fields": { "description": "Custom field values defined on the Employee object for this worker\n\nExpandable field", "items": { "additionalProperties": {} }, "type": "array" }, "date_of_birth": { "description": "The worker's date of birth.", "type": "string" }, "department": { "description": "The worker's assigned department.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "department_hierarchy": { "description": "List of departments in the department hierarchy. Refer department_hierarchy_ids for department hierarchy order.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestDepartment" }, "type": "array" }, "department_hierarchy_id": { "description": "The identifier of departments in the department hierarchy ordered from parent department to child department.", "items": { "type": "string" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the department.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestDepartment", "description": "The parent department.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent department.", "type": "string" }, "reference_code": { "description": "Reference code of the department.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Department", "type": "object" }, "department_id": { "description": "The worker's assigned department.", "type": "string" }, "employment_type": { "description": "The worker's employment type.\n\nExpandable field", "properties": { "amount_worked": { "description": "The amount worked for the employment type. * `FULL-TIME`: Full-time is at least 30 hours per week. Full-time workers will typically be eligible for benefits. * `PART-TIME`: Part-time is less than 30 hours per week. These workers may be eligible for benefits, depending on company settings and hours worked. * `TEMPORARY`: These workers are hired on a temporary basis. You can specify how each worker with this employment type will be paid individually.", "type": "string" }, "compensation_time_period": { "description": "The compensation period for the employment type. * `SALARIED`: Employees that are paid a fixed amount per year. * `HOURLY`: Employees that are paid a wage per hour worked.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "label": { "description": "The display label of the employment type.", "type": "string" }, "name": { "description": "The name of the employment type for non-custom employment types.", "type": "string" }, "type": { "description": "The classification of the worker by the company. * `CONTRACTOR`: Contractors are self-employed workers who provide services on a short-term or per-project basis and are not eligible for tax-withholding or benefits. * `EMPLOYEE`: Employees are hired and managed by an employer, work under the employer's direct supervision and control, and are protected by law for wages and employment rights.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "label", "updated_at" ], "title": "CompanyEmploymentType", "type": "object" }, "employment_type_id": { "description": "The worker's employment type.", "type": "string" }, "end_date": { "description": "The end date of the worker.", "type": "string" }, "ethnicity": { "description": "The identified ethnicity of the worker, if specified.", "type": "string" }, "gender": { "description": "The gender of the worker, if specified.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_manager": { "description": "Whether the worker is a manager", "type": "boolean" }, "job_function": { "description": "The worker's job function. When expanded, this field requires `job-functions.read`.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "Displayed name of the job function", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "JobFunction", "type": "object" }, "job_function_id": { "description": "ID of the worker's job function.", "type": "string" }, "legal_entity": { "description": "The worker's associated legal entity.\n\nExpandable field", "properties": { "company": { "description": "The company or organization associated with the legal entity\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "doing_business_as_name": { "description": "The doing business as name for the company.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_entities": { "description": "A list of the company's entities.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestLegalEntity" }, "type": "array" }, "legal_entities_id": { "description": "A list of the company's entities.", "items": { "type": "string" }, "type": "array" }, "legal_name": { "description": "The legal name of the company.", "type": "string" }, "name": { "description": "The name of the company.", "type": "string" }, "parent_legal_entity": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The company's ultimate holding entity.\n\nExpandable field", "type": "object" }, "parent_legal_entity_id": { "description": "The company's ultimate holding entity.", "type": "string" }, "phone": { "description": "The phone number for the company.", "type": "string" }, "physical_address": { "description": "The physical address of the holding entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "primary_email": { "description": "The email address used when registering this company.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "legal_entities", "legal_entities_id", "name", "updated_at" ], "title": "Company", "type": "object" }, "company_id": { "description": "The company or organization associated with the legal entity", "type": "string" }, "country": { "description": "The country the legal entity is based in.", "properties": { "code": { "description": "The code of the country.", "type": "string" } }, "required": [ "code" ], "title": "Country", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "entity_level": { "description": "The legal entity's level in a hierarchy. * `PARENT`: The legal entity is considered the ultimate holding entity. * `SUBSIDIARY`: The legal entity is considered a subsidiary, fully or partially held by another. * `BRANCH`: The legal entity is considered a branch, associated with a parent legal entity.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_name": { "description": "The legal name of the legal entity.", "type": "string" }, "mailing_address": { "description": "The mailing address of the legal entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "management_type": { "description": "The legal entity management type in the case of an employer of record (EOR) or professional employment organization (PEO). * `PEO`: The legal entity is considered a Professional Employment Organization (PEO). * `EOR`: The legal entity is considered an Employer of Record (EOR).", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The parent legal entity.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent legal entity.", "type": "string" }, "physical_address": { "description": "The physical address of the legal entity, if it differs from the mailing address.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "registration_date": { "description": "The registration date of the entity.", "type": "string" }, "tax_identifier": { "description": "The tax identifier for the legal entity.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "LegalEntity", "type": "object" }, "legal_entity_id": { "description": "The worker's associated legal entity.", "type": "string" }, "level": { "description": "The level of the worker.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "description": { "description": "The description of the level.", "type": "string" }, "experience_requirements": { "description": "The experience requirements for the level.", "type": "string" }, "global_level": { "anyOf": [ { "description": "Global level is used to track the seniority of levels. The higher up a level is placed on the page, the more senior and higher-ranked the level. Global level is used in workflows, policies, and reports that use the level attribute (e.g., you can use Level Lookup to set up a workflow that notifies the nearest person in an worker's management chain at or above the specified level).", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the level. Must be unique within the company or organization.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLevel", "description": "The parent level.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent level.", "type": "string" }, "rank": { "anyOf": [ { "description": "The rank of the level within its track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "scope_of_responsibilities": { "description": "The scope of responsibilities for the level.", "type": "string" }, "track": { "description": "The track associated with the level, if it's not a global level.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_default": { "description": "Whether this is the company's default track.", "type": "boolean" }, "name": { "description": "The name of the track. Must be unique within the company or organization.", "type": "string" }, "order": { "anyOf": [ { "description": "The one-based horizontal display order of the track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "start_global_level": { "anyOf": [ { "description": "The highest global level occupied by this track. Empty tracks return null.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Track", "type": "object" }, "track_id": { "description": "The track associated with the level. Required during creation. Include global_level when changing it.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Level", "type": "object" }, "level_id": { "description": "The level of the worker.", "type": "string" }, "location": { "description": "The location that the worker is mapped to for tax purposes. In the case that a worker is remote, the location's type is remote.", "properties": { "type": { "description": "The type of location.", "type": "string" }, "work_location_id": { "description": "The work location, if the worker isn't remote.", "type": "string" } }, "required": [ "type", "work_location_id" ], "title": "WorkerLocation", "type": "object" }, "manager": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's manager.\n\nExpandable field", "type": "object" }, "manager_id": { "description": "The worker's manager.", "type": "string" }, "number": { "anyOf": [ { "description": "The worker's number within the organization.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "original_start_date": { "description": "The worker's earliest start date across their employment history, excluding INIT roles.", "type": "string" }, "overtime_exemption": { "description": "The worker's overtime exemption status.", "type": "string" }, "pay_schedule_id": { "description": "The ID of the pay schedule currently associated with the worker.", "type": "string" }, "personal_email": { "description": "The worker's associated personal email address.", "type": "string" }, "race": { "description": "The identified race of the worker, if specified.", "type": "string" }, "start_date": { "description": "The start date of the worker.", "type": "string" }, "status": { "description": "The worker's status within the organization.", "type": "string" }, "teams": { "description": "The worker's assigned teams.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiTeamcb26bc28f32f" }, "type": "array" }, "teams_id": { "description": "The worker's assigned teams.", "items": { "type": "string" }, "type": "array" }, "termination_details": { "description": "The details of the worker's termination, if applicable.", "properties": { "reason": { "description": "This is a description that will be custom to each Rippling company.", "type": "string" }, "type": { "description": "The termination type indicates whether the termination was voluntary or involuntary.", "type": "string" } }, "title": "TerminationDetails", "type": "object" }, "title": { "description": "The worker's title.", "type": "string" }, "title_effective_date": { "description": "Title effective date", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "user": { "description": "The worker's associated user.\n\nExpandable field", "properties": { "active": { "description": "Whether the user is able to access company resources, typically when they are in actively engaged with the company and not after off-boarding.", "type": "boolean" }, "addresses": { "description": "The user's addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiUserAddressedd59b9ba9a1" }, "type": "array" }, "created_at": { "description": "Record creation date", "type": "string" }, "display_name": { "description": "The display name of the user using either the concatenated preferred given and family name or username depending on availability.", "type": "string" }, "emails": { "description": "The user's email addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiEmail5284c8258dc3" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "locale": { "description": "The User's default location for purposes of localization of currency, date time format, or numerical representations pursuant to RFC5646.", "type": "string" }, "name": { "description": "The user's name.", "properties": { "family_name": { "description": "The legal family name of the user, or last name in most Western languages.", "type": "string" }, "formatted": { "description": "The user's full name.", "type": "string" }, "given_name": { "description": "The given legal name of the user, or first name in most Western languages.", "type": "string" }, "middle_name": { "description": "The middle name(s) of the user.", "type": "string" }, "preferred_family_name": { "description": "The preferred family name, or last name in most Western languages, by the user.", "type": "string" }, "preferred_given_name": { "description": "The preferred given name, or first name in most Western languages, by the user.", "type": "string" } }, "title": "UserName", "type": "object" }, "number": { "description": "The permanent profile number of the user.", "type": "string" }, "phone_numbers": { "description": "The user's phone numbers.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoneNumber12060c61ecf5" }, "type": "array" }, "photos": { "description": "The user's photos.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoto2be7c3ae3f39" }, "type": "array" }, "preferred_language": { "description": "The User's preferred written or spoken language in the same format of the HTTP Accept-Language header, pursuant to Section 5.3.5 of RFC7231.", "type": "string" }, "timezone": { "description": "The User's current time zone in IANA database Olson format", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "username": { "description": "The unique identifier across Rippling used by the User for direct authentication into their associated company. Globally unique.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "User", "type": "object" }, "user_id": { "description": "The worker's associated user.", "type": "string" }, "work_email": { "description": "The worker's associated work email address.", "type": "string" }, "work_schedule": { "additionalProperties": { "$ref": "#/components/schemas/OutputRestApiWorkScheduleDay938f88d94f20" }, "description": "The worker's scheduled working hours for each day of the week.", "type": "object" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Worker", "type": "object" }, "worker_id": { "description": "The Platform worker ID from GET /workers/{id}/ when the actor is a worker. Null when the actor is not a worker.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Retrieve a specific activity log event", "x-rippling-entitlements": [ "Activity_Log_Platform_API" ], "x-rippling-required-scopes": [ "activity-log.read" ] } }, "/agents/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/list-agents" }, "operationId": "rippling.rest_api.list_agents", "parameters": [ { "in": "query", "name": "limit", "required": false, "schema": { "maximum": 100, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "filter", "required": false, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "next_link": { "description": "A link to the next page of responses.", "format": "uri", "type": "string" }, "results": { "items": { "$ref": "#/components/schemas/OutputRestApiAgentbe24c139b1b5" }, "type": "array" } }, "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "List agents", "x-rippling-entitlements": [ "Agents_Platform_API" ], "x-rippling-required-scopes": [ "agents.read", "agents.read-write" ] }, "post": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/create-agents" }, "operationId": "rippling.rest_api.create_agents", "parameters": [ { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiAgentRequest6608b6e689ad" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "api_name": { "description": "The API name of the agent", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "description": { "description": "The description of the agent", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_for_evals": { "description": "Whether the agent is used for evaluations", "type": "boolean" }, "name": { "description": "The display name of the agent", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "api_name", "created_at", "id", "name", "updated_at" ], "title": "Agent", "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Create a new agent", "x-rippling-entitlements": [ "Agents_Platform_API" ], "x-rippling-required-scopes": [ "agents.read-write" ] } }, "/agents/sessions/": { "post": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/create-agent-session" }, "operationId": "rippling.rest_api.create_agent_session", "parameters": [ { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiAgentSessionRequestfa0ca0b5fa98" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "agent_id": { "description": "The ID of the agent to run", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "error_message": { "description": "The session error message", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "langsmith_thread_id": { "description": "The stable LangSmith thread identifier for this session", "type": "string" }, "output": { "description": "The output of the session", "type": "object" }, "prompt": { "description": "The prompt to send to the agent", "type": "string" }, "session_resume_receipt": { "description": "Receipt that ACP restored the requested session resume state", "properties": { "status": { "description": "The session resume state restore status", "type": "string" } }, "title": "SessionResumeReceipt", "type": "object" }, "status": { "description": "The status of the session", "type": "string" }, "submission_id": { "description": "Receipt for correlating agent.submission.settled events after create or append-message writes", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "agent_id", "created_at", "id", "prompt", "updated_at" ], "title": "AgentSession", "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Create an agent session", "x-rippling-entitlements": [ "Agents_Platform_API" ], "x-rippling-required-scopes": [ "agent-sessions.read-write" ] } }, "/agents/sessions/{session_id}/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/get-agent-session" }, "operationId": "rippling.rest_api.get_agent_session", "parameters": [ { "in": "path", "name": "session_id", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "agent_id": { "description": "The ID of the agent to run", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "error_message": { "description": "The session error message", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "langsmith_thread_id": { "description": "The stable LangSmith thread identifier for this session", "type": "string" }, "output": { "description": "The output of the session", "type": "object" }, "prompt": { "description": "The prompt to send to the agent", "type": "string" }, "session_resume_receipt": { "description": "Receipt that ACP restored the requested session resume state", "properties": { "status": { "description": "The session resume state restore status", "type": "string" } }, "title": "SessionResumeReceipt", "type": "object" }, "status": { "description": "The status of the session", "type": "string" }, "submission_id": { "description": "Receipt for correlating agent.submission.settled events after create or append-message writes", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "agent_id", "created_at", "id", "prompt", "updated_at" ], "title": "AgentSession", "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Retrieve an agent session", "x-rippling-entitlements": [ "Agents_Platform_API" ], "x-rippling-required-scopes": [ "agent-sessions.read", "agent-sessions.read-write" ] } }, "/agents/sessions/{session_id}/events/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/list-agent-session-events" }, "operationId": "rippling.rest_api.list_agent_session_events", "parameters": [ { "in": "path", "name": "session_id", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "after_sequence", "required": false, "schema": { "minimum": 0, "type": "integer" } }, { "in": "query", "name": "limit", "required": false, "schema": { "maximum": 100, "minimum": 1, "type": "integer" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "events": { "description": "Session events", "items": { "$ref": "#/components/schemas/OutputRestApiAgentSessionEvent49db40ed2ff2" }, "type": "array" }, "is_terminal": { "description": "Whether the session has ended", "type": "boolean" }, "last_sequence": { "anyOf": [ { "description": "The latest event sequence number", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "next_after_sequence": { "anyOf": [ { "description": "Use this sequence number as after_sequence to continue the event stream", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "status": { "description": "The current session status", "type": "string" } }, "title": "AgentSessionEvents", "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "List agent session events", "x-rippling-entitlements": [ "Agents_Platform_API" ], "x-rippling-required-scopes": [ "agent-sessions.read", "agent-sessions.read-write" ] } }, "/agents/sessions/{session_id}/messages/": { "post": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/append-agent-session-message" }, "operationId": "rippling.rest_api.append_agent_session_message", "parameters": [ { "in": "path", "name": "session_id", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "agent_id": { "description": "The ID of the agent.", "type": "string" }, "prompt": { "description": "The next user prompt.", "type": "string" } }, "required": [ "agent_id", "prompt" ], "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "agent_id": { "description": "The ID of the agent to run", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "error_message": { "description": "The session error message", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "langsmith_thread_id": { "description": "The stable LangSmith thread identifier for this session", "type": "string" }, "output": { "description": "The output of the session", "type": "object" }, "prompt": { "description": "The prompt to send to the agent", "type": "string" }, "session_resume_receipt": { "description": "Receipt that ACP restored the requested session resume state", "properties": { "status": { "description": "The session resume state restore status", "type": "string" } }, "title": "SessionResumeReceipt", "type": "object" }, "status": { "description": "The status of the session", "type": "string" }, "submission_id": { "description": "Receipt for correlating agent.submission.settled events after create or append-message writes", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "agent_id", "created_at", "id", "prompt", "updated_at" ], "title": "AgentSession", "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Send an agent session message", "x-rippling-entitlements": [ "Agents_Platform_API" ], "x-rippling-required-scopes": [ "agent-sessions.read-write" ] } }, "/agents/sessions/{session_id}/resume-state/": { "post": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/capture-agent-session-resume-state" }, "operationId": "rippling.rest_api.capture_agent_session_resume_state", "parameters": [ { "in": "path", "name": "session_id", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "Opaque state used to restore an eval agent session.", "properties": { "artifact": { "description": "An opaque base64-encoded agent session resume state", "type": "string" } }, "required": [ "artifact" ], "title": "SessionResumeState", "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Capture an agent session resume state", "x-rippling-entitlements": [ "Agents_Platform_API" ], "x-rippling-required-scopes": [ "agent-sessions.read-write" ] } }, "/agents/{agent_id}/": { "delete": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/delete-agent" }, "operationId": "rippling.rest_api.delete_agent", "parameters": [ { "in": "path", "name": "agent_id", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Agent deleted successfully." } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Delete an agent", "x-rippling-entitlements": [ "Agents_Platform_API" ], "x-rippling-required-scopes": [ "agents.read-write" ] }, "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/get-agent" }, "operationId": "rippling.rest_api.get_agent", "parameters": [ { "in": "path", "name": "agent_id", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "api_name": { "description": "The API name of the agent", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "description": { "description": "The description of the agent", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_for_evals": { "description": "Whether the agent is used for evaluations", "type": "boolean" }, "name": { "description": "The display name of the agent", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "api_name", "created_at", "id", "name", "updated_at" ], "title": "Agent", "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Retrieve an agent", "x-rippling-entitlements": [ "Agents_Platform_API" ], "x-rippling-required-scopes": [ "agents.read", "agents.read-write" ] }, "patch": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/update-agent" }, "operationId": "rippling.rest_api.update_agent", "parameters": [ { "in": "path", "name": "agent_id", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiAgentUpdateRequeste904d29068e5" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "api_name": { "description": "The API name of the agent", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "description": { "description": "The description of the agent", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_for_evals": { "description": "Whether the agent is used for evaluations", "type": "boolean" }, "name": { "description": "The display name of the agent", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "api_name", "created_at", "id", "name", "updated_at" ], "title": "Agent", "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Update an agent", "x-rippling-entitlements": [ "Agents_Platform_API" ], "x-rippling-required-scopes": [ "agents.read-write" ] } }, "/agents/{agent_id}/deployments/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/list-agent-deployments" }, "operationId": "rippling.rest_api.list_agent_deployments", "parameters": [ { "in": "path", "name": "agent_id", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "after_sequence", "required": false, "schema": { "minimum": 0, "type": "integer" } }, { "in": "query", "name": "limit", "required": false, "schema": { "maximum": 100, "minimum": 1, "type": "integer" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "next_link": { "description": "A link to the next page of responses.", "format": "uri", "type": "string" }, "results": { "items": { "$ref": "#/components/schemas/OutputRestApiAgentDeployment83bdbd46d523" }, "type": "array" } }, "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "List agent deployments", "x-rippling-entitlements": [ "Agents_Platform_API" ], "x-rippling-required-scopes": [ "agent-deployments.read", "agent-deployments.read-write" ] }, "post": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/create-agent-deployment" }, "operationId": "rippling.rest_api.create_agent_deployment", "parameters": [ { "in": "path", "name": "agent_id", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiAgentDeploymentRequestd90ba5e2ed2c" } } }, "required": false }, "responses": { "202": { "content": { "application/json": { "schema": { "description": "", "properties": { "deployment_id": { "description": "The ID of the deployment", "type": "string" }, "diagnostics": { "description": "Diagnostics emitted while creating the deployment", "items": { "$ref": "#/components/schemas/OutputRestApiAgentDeploymentDiagnosticfd2356ca2aee" }, "type": "array" }, "is_active": { "description": "Whether the deployment is active", "type": "boolean" }, "outcome": { "description": "The deployment outcome", "type": "string" }, "source_digest": { "description": "The digest of the deployed source revision", "type": "string" }, "source_revision_version": { "anyOf": [ { "description": "The source revision version deployed by the control plane", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "stage": { "description": "The deployment stage", "type": "string" } }, "title": "AgentDeployment", "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Deploy an agent source revision", "x-rippling-entitlements": [ "Agents_Platform_API" ], "x-rippling-required-scopes": [ "agent-deployments.read-write" ] } }, "/agents/{agent_id}/deployments/{deployment_id}/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/get-agent-deployment" }, "operationId": "rippling.rest_api.get_agent_deployment", "parameters": [ { "in": "path", "name": "agent_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "deployment_id", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "deployment_id": { "description": "The ID of the deployment", "type": "string" }, "diagnostics": { "description": "Diagnostics emitted while creating the deployment", "items": { "$ref": "#/components/schemas/OutputRestApiAgentDeploymentDiagnosticfd2356ca2aee" }, "type": "array" }, "is_active": { "description": "Whether the deployment is active", "type": "boolean" }, "outcome": { "description": "The deployment outcome", "type": "string" }, "source_digest": { "description": "The digest of the deployed source revision", "type": "string" }, "source_revision_version": { "anyOf": [ { "description": "The source revision version deployed by the control plane", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "stage": { "description": "The deployment stage", "type": "string" } }, "title": "AgentDeployment", "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Retrieve an agent deployment", "x-rippling-entitlements": [ "Agents_Platform_API" ], "x-rippling-required-scopes": [ "agent-deployments.read", "agent-deployments.read-write" ] } }, "/agents/{agent_id}/sessions/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/list-agent-sessions" }, "operationId": "rippling.rest_api.list_agent_sessions", "parameters": [ { "in": "path", "name": "agent_id", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "limit", "required": false, "schema": { "maximum": 100, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "next_link": { "description": "A link to the next page of responses.", "format": "uri", "type": "string" }, "results": { "items": { "$ref": "#/components/schemas/OutputRestApiAgentSessiona0888e12eb01" }, "type": "array" } }, "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "List agent sessions", "x-rippling-entitlements": [ "Agents_Platform_API" ], "x-rippling-required-scopes": [ "agent-sessions.read", "agent-sessions.read-write" ] } }, "/agents/{agent_id}/source-revisions/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/list-agent-source-revisions" }, "operationId": "rippling.rest_api.list_agent_source_revisions", "parameters": [ { "in": "path", "name": "agent_id", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "limit", "required": false, "schema": { "maximum": 100, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "next_link": { "description": "A link to the next page of responses.", "format": "uri", "type": "string" }, "results": { "items": { "$ref": "#/components/schemas/OutputRestApiAgentSourceRevisionSummary9e198b8dc6d6" }, "type": "array" } }, "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "List agent source revisions", "x-rippling-entitlements": [ "Agents_Platform_API" ], "x-rippling-required-scopes": [ "agent-source-revisions.read", "agent-source-revisions.read-write" ] }, "post": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/create-agent-source-revision" }, "operationId": "rippling.rest_api.create_agent_source_revision", "parameters": [ { "in": "path", "name": "agent_id", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiAgentSourceRevisionRequest0fd9fcd9ef18" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "entrypoint": { "description": "The entrypoint file", "type": "string" }, "files": { "description": "The files in the source revision", "items": { "$ref": "#/components/schemas/OutputRestApiAgentSourceFile075f135fe768" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "source_digest": { "description": "The digest of the source revision", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "version": { "anyOf": [ { "description": "The version number of the source revision", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "required": [ "created_at", "entrypoint", "files", "id", "updated_at" ], "title": "AgentSourceRevision", "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Create an agent source revision", "x-rippling-entitlements": [ "Agents_Platform_API" ], "x-rippling-required-scopes": [ "agent-source-revisions.read-write" ] } }, "/agents/{agent_id}/source-revisions/{source_revision_id}/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/get-agent-source-revision" }, "operationId": "rippling.rest_api.get_agent_source_revision", "parameters": [ { "in": "path", "name": "agent_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "source_revision_id", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "entrypoint": { "description": "The entrypoint file", "type": "string" }, "files": { "description": "The files in the source revision", "items": { "$ref": "#/components/schemas/OutputRestApiAgentSourceFile075f135fe768" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "source_digest": { "description": "The digest of the source revision", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "version": { "anyOf": [ { "description": "The version number of the source revision", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "required": [ "created_at", "entrypoint", "files", "id", "updated_at" ], "title": "AgentSourceRevision", "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Retrieve an agent source revision", "x-rippling-entitlements": [ "Agents_Platform_API" ], "x-rippling-required-scopes": [ "agent-source-revisions.read", "agent-source-revisions.read-write" ] } }, "/app-users/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/list-app-users" }, "operationId": "rippling.rest_api.list_app_users", "parameters": [ { "in": "query", "name": "filter", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "expand", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 100, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "__meta": { "$ref": "#/components/schemas/OutputRestApiRedactedFields9f7657dc2a2f" }, "next_link": { "description": "A link to the next page of responses.", "format": "uri", "type": "string" }, "results": { "items": { "$ref": "#/components/schemas/OutputRestApiAppUser1e982a4b9d56" }, "type": "array" } }, "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "List app users", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "app-users.read" ] } }, "/app-users/{id}/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/get-app-users" }, "operationId": "rippling.rest_api.get_app_users", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "id", "type": "string" } }, { "in": "query", "name": "expand", "required": false, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "__meta": { "properties": { "redacted_fields": { "items": { "$ref": "#/components/schemas/OutputRestApiRedactedField21788a25ef22" }, "type": "array" } }, "type": "object" }, "app_display_name": { "description": "Human-readable display name for the third-party app (e.g. 'Slack', 'GitHub'). Sourced from the customer-configured SpokeOwner.app_display_name; falls back to a title-cased app handle when the customer hasn't set one.", "type": "string" }, "app_handle": { "description": "Machine-readable identifier for the third-party app (e.g. 'slack', 'jira', 'asana'). Stable across the App Shop catalog.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "external_email": { "description": "The user's email address in the third-party app, if known. Null when the app does not expose an email or Rippling did not capture one.", "type": "string" }, "external_username": { "description": "The user's display name in the third-party app, if known. Null when the app does not surface a separate username.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "match_state": { "description": "Whether this third-party account has been matched to a Rippling worker.", "type": "string" }, "push_state": { "description": "Provisioning lifecycle state of this account in the third-party app.", "type": "string" }, "spoke_user_identifier": { "description": "Identifier for the user's account in the third-party app workspace. Depending on the integration, this may be an email, username, account handle, or app-specific user id.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "worker": { "description": "The Rippling worker associated with this external app account. Expanding this field requires both `app-users.read` and `workers.read` scopes.\n\nExpandable field", "properties": { "business_partners": { "description": "Worker's assigned business partners. This field is only populated when explicitly requested via the expand parameter (e.g., ?expand=business_partners). When expanded, returns an empty list ([]) if the worker has no business partners.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiBusinessPartner77b00a069c32" }, "type": "array" }, "business_partners_id": { "description": "Worker's assigned business partners unique identifiers. Returns an empty list ([]) if the worker has no business partners.", "items": { "type": "string" }, "type": "array" }, "citizenship": { "description": "The countries that the worker has citizenship in.", "type": "string" }, "compensation": { "description": "The compensation package for the worker.\n\nExpandable field", "properties": { "annual_compensation": { "description": "The worker's annual compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "annual_salary_equivalent": { "description": "The worker's annual salary equivalent, for insurance purposes. It will be equal to the worker's annual compensation, except for owners that are receiving no cashcompensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "bonus_schedule": { "description": "The worker's bonus schedule.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "hourly_wage": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "id": { "description": "Identifier field", "type": "string" }, "monthly_compensation": { "description": "The worker's monthly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "on_target_commission": { "description": "The worker's on-target commission.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "payment_terms": { "description": "The payment terms for an worker's compensation.", "type": "string" }, "payment_type": { "description": "The payment type for an worker's compensation.", "type": "string" }, "relocation_reimbursement": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "salary_effective_date": { "description": "Salary effective date", "type": "string" }, "signing_bonus": { "description": "The worker's signing bonus.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus": { "description": "The worker's target annual bonus amount.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus_percent": { "anyOf": [ { "description": "The worker's target annual bonus as a percent of annual compensation.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" }, "weekly_compensation": { "description": "The worker's weekly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "worker": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's details.\n\nExpandable field", "type": "object" }, "worker_id": { "description": "The worker's ID.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Compensation", "type": "object" }, "compensation_grade": { "description": "The compensation grade assigned to the worker, if any.", "properties": { "id": { "description": "The compensation grade's unique identifier.", "type": "string" }, "label": { "description": "The compensation grade's label.", "type": "string" } }, "title": "WorkerCompensationGrade", "type": "object" }, "compensation_id": { "description": "The compensation package for the worker.", "type": "string" }, "country": { "description": "The worker's country.", "type": "string" }, "country_fields": { "description": "Country level fields for the worker.", "properties": { "ca": { "description": "Country-wise regional fields for Canada", "properties": { "sin": { "description": "Social Insurance Number (SIN) for Canada employees.", "type": "string" } }, "title": "CanadaFields", "type": "object" }, "nz": { "description": "Country-wise regional fields for New Zealand", "properties": { "ird_number": { "description": "Inland Revenue Department (IRD) number for New Zealand employees.", "type": "string" } }, "title": "NewZealandFields", "type": "object" }, "us": { "description": "Country-wise regional fields for USA", "properties": { "ssn": { "description": "Social Security Number (SSN) for US employees.", "type": "string" } }, "title": "USFields", "type": "object" } }, "title": "CountryFields", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "custom_fields": { "description": "Custom field values defined on the Employee object for this worker\n\nExpandable field", "items": { "additionalProperties": {} }, "type": "array" }, "date_of_birth": { "description": "The worker's date of birth.", "type": "string" }, "department": { "description": "The worker's assigned department.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "department_hierarchy": { "description": "List of departments in the department hierarchy. Refer department_hierarchy_ids for department hierarchy order.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestDepartment" }, "type": "array" }, "department_hierarchy_id": { "description": "The identifier of departments in the department hierarchy ordered from parent department to child department.", "items": { "type": "string" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the department.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestDepartment", "description": "The parent department.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent department.", "type": "string" }, "reference_code": { "description": "Reference code of the department.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Department", "type": "object" }, "department_id": { "description": "The worker's assigned department.", "type": "string" }, "employment_type": { "description": "The worker's employment type.\n\nExpandable field", "properties": { "amount_worked": { "description": "The amount worked for the employment type. * `FULL-TIME`: Full-time is at least 30 hours per week. Full-time workers will typically be eligible for benefits. * `PART-TIME`: Part-time is less than 30 hours per week. These workers may be eligible for benefits, depending on company settings and hours worked. * `TEMPORARY`: These workers are hired on a temporary basis. You can specify how each worker with this employment type will be paid individually.", "type": "string" }, "compensation_time_period": { "description": "The compensation period for the employment type. * `SALARIED`: Employees that are paid a fixed amount per year. * `HOURLY`: Employees that are paid a wage per hour worked.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "label": { "description": "The display label of the employment type.", "type": "string" }, "name": { "description": "The name of the employment type for non-custom employment types.", "type": "string" }, "type": { "description": "The classification of the worker by the company. * `CONTRACTOR`: Contractors are self-employed workers who provide services on a short-term or per-project basis and are not eligible for tax-withholding or benefits. * `EMPLOYEE`: Employees are hired and managed by an employer, work under the employer's direct supervision and control, and are protected by law for wages and employment rights.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "label", "updated_at" ], "title": "CompanyEmploymentType", "type": "object" }, "employment_type_id": { "description": "The worker's employment type.", "type": "string" }, "end_date": { "description": "The end date of the worker.", "type": "string" }, "ethnicity": { "description": "The identified ethnicity of the worker, if specified.", "type": "string" }, "gender": { "description": "The gender of the worker, if specified.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_manager": { "description": "Whether the worker is a manager", "type": "boolean" }, "job_function": { "description": "The worker's job function. When expanded, this field requires `job-functions.read`.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "Displayed name of the job function", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "JobFunction", "type": "object" }, "job_function_id": { "description": "ID of the worker's job function.", "type": "string" }, "legal_entity": { "description": "The worker's associated legal entity.\n\nExpandable field", "properties": { "company": { "description": "The company or organization associated with the legal entity\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "doing_business_as_name": { "description": "The doing business as name for the company.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_entities": { "description": "A list of the company's entities.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestLegalEntity" }, "type": "array" }, "legal_entities_id": { "description": "A list of the company's entities.", "items": { "type": "string" }, "type": "array" }, "legal_name": { "description": "The legal name of the company.", "type": "string" }, "name": { "description": "The name of the company.", "type": "string" }, "parent_legal_entity": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The company's ultimate holding entity.\n\nExpandable field", "type": "object" }, "parent_legal_entity_id": { "description": "The company's ultimate holding entity.", "type": "string" }, "phone": { "description": "The phone number for the company.", "type": "string" }, "physical_address": { "description": "The physical address of the holding entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "primary_email": { "description": "The email address used when registering this company.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "legal_entities", "legal_entities_id", "name", "updated_at" ], "title": "Company", "type": "object" }, "company_id": { "description": "The company or organization associated with the legal entity", "type": "string" }, "country": { "description": "The country the legal entity is based in.", "properties": { "code": { "description": "The code of the country.", "type": "string" } }, "required": [ "code" ], "title": "Country", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "entity_level": { "description": "The legal entity's level in a hierarchy. * `PARENT`: The legal entity is considered the ultimate holding entity. * `SUBSIDIARY`: The legal entity is considered a subsidiary, fully or partially held by another. * `BRANCH`: The legal entity is considered a branch, associated with a parent legal entity.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_name": { "description": "The legal name of the legal entity.", "type": "string" }, "mailing_address": { "description": "The mailing address of the legal entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "management_type": { "description": "The legal entity management type in the case of an employer of record (EOR) or professional employment organization (PEO). * `PEO`: The legal entity is considered a Professional Employment Organization (PEO). * `EOR`: The legal entity is considered an Employer of Record (EOR).", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The parent legal entity.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent legal entity.", "type": "string" }, "physical_address": { "description": "The physical address of the legal entity, if it differs from the mailing address.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "registration_date": { "description": "The registration date of the entity.", "type": "string" }, "tax_identifier": { "description": "The tax identifier for the legal entity.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "LegalEntity", "type": "object" }, "legal_entity_id": { "description": "The worker's associated legal entity.", "type": "string" }, "level": { "description": "The level of the worker.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "description": { "description": "The description of the level.", "type": "string" }, "experience_requirements": { "description": "The experience requirements for the level.", "type": "string" }, "global_level": { "anyOf": [ { "description": "Global level is used to track the seniority of levels. The higher up a level is placed on the page, the more senior and higher-ranked the level. Global level is used in workflows, policies, and reports that use the level attribute (e.g., you can use Level Lookup to set up a workflow that notifies the nearest person in an worker's management chain at or above the specified level).", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the level. Must be unique within the company or organization.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLevel", "description": "The parent level.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent level.", "type": "string" }, "rank": { "anyOf": [ { "description": "The rank of the level within its track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "scope_of_responsibilities": { "description": "The scope of responsibilities for the level.", "type": "string" }, "track": { "description": "The track associated with the level, if it's not a global level.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_default": { "description": "Whether this is the company's default track.", "type": "boolean" }, "name": { "description": "The name of the track. Must be unique within the company or organization.", "type": "string" }, "order": { "anyOf": [ { "description": "The one-based horizontal display order of the track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "start_global_level": { "anyOf": [ { "description": "The highest global level occupied by this track. Empty tracks return null.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Track", "type": "object" }, "track_id": { "description": "The track associated with the level. Required during creation. Include global_level when changing it.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Level", "type": "object" }, "level_id": { "description": "The level of the worker.", "type": "string" }, "location": { "description": "The location that the worker is mapped to for tax purposes. In the case that a worker is remote, the location's type is remote.", "properties": { "type": { "description": "The type of location.", "type": "string" }, "work_location_id": { "description": "The work location, if the worker isn't remote.", "type": "string" } }, "required": [ "type", "work_location_id" ], "title": "WorkerLocation", "type": "object" }, "manager": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's manager.\n\nExpandable field", "type": "object" }, "manager_id": { "description": "The worker's manager.", "type": "string" }, "number": { "anyOf": [ { "description": "The worker's number within the organization.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "original_start_date": { "description": "The worker's earliest start date across their employment history, excluding INIT roles.", "type": "string" }, "overtime_exemption": { "description": "The worker's overtime exemption status.", "type": "string" }, "pay_schedule_id": { "description": "The ID of the pay schedule currently associated with the worker.", "type": "string" }, "personal_email": { "description": "The worker's associated personal email address.", "type": "string" }, "race": { "description": "The identified race of the worker, if specified.", "type": "string" }, "start_date": { "description": "The start date of the worker.", "type": "string" }, "status": { "description": "The worker's status within the organization.", "type": "string" }, "teams": { "description": "The worker's assigned teams.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiTeamcb26bc28f32f" }, "type": "array" }, "teams_id": { "description": "The worker's assigned teams.", "items": { "type": "string" }, "type": "array" }, "termination_details": { "description": "The details of the worker's termination, if applicable.", "properties": { "reason": { "description": "This is a description that will be custom to each Rippling company.", "type": "string" }, "type": { "description": "The termination type indicates whether the termination was voluntary or involuntary.", "type": "string" } }, "title": "TerminationDetails", "type": "object" }, "title": { "description": "The worker's title.", "type": "string" }, "title_effective_date": { "description": "Title effective date", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "user": { "description": "The worker's associated user.\n\nExpandable field", "properties": { "active": { "description": "Whether the user is able to access company resources, typically when they are in actively engaged with the company and not after off-boarding.", "type": "boolean" }, "addresses": { "description": "The user's addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiUserAddressedd59b9ba9a1" }, "type": "array" }, "created_at": { "description": "Record creation date", "type": "string" }, "display_name": { "description": "The display name of the user using either the concatenated preferred given and family name or username depending on availability.", "type": "string" }, "emails": { "description": "The user's email addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiEmail5284c8258dc3" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "locale": { "description": "The User's default location for purposes of localization of currency, date time format, or numerical representations pursuant to RFC5646.", "type": "string" }, "name": { "description": "The user's name.", "properties": { "family_name": { "description": "The legal family name of the user, or last name in most Western languages.", "type": "string" }, "formatted": { "description": "The user's full name.", "type": "string" }, "given_name": { "description": "The given legal name of the user, or first name in most Western languages.", "type": "string" }, "middle_name": { "description": "The middle name(s) of the user.", "type": "string" }, "preferred_family_name": { "description": "The preferred family name, or last name in most Western languages, by the user.", "type": "string" }, "preferred_given_name": { "description": "The preferred given name, or first name in most Western languages, by the user.", "type": "string" } }, "title": "UserName", "type": "object" }, "number": { "description": "The permanent profile number of the user.", "type": "string" }, "phone_numbers": { "description": "The user's phone numbers.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoneNumber12060c61ecf5" }, "type": "array" }, "photos": { "description": "The user's photos.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoto2be7c3ae3f39" }, "type": "array" }, "preferred_language": { "description": "The User's preferred written or spoken language in the same format of the HTTP Accept-Language header, pursuant to Section 5.3.5 of RFC7231.", "type": "string" }, "timezone": { "description": "The User's current time zone in IANA database Olson format", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "username": { "description": "The unique identifier across Rippling used by the User for direct authentication into their associated company. Globally unique.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "User", "type": "object" }, "user_id": { "description": "The worker's associated user.", "type": "string" }, "work_email": { "description": "The worker's associated work email address.", "type": "string" }, "work_schedule": { "additionalProperties": { "$ref": "#/components/schemas/OutputRestApiWorkScheduleDay938f88d94f20" }, "description": "The worker's scheduled working hours for each day of the week.", "type": "object" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Worker", "type": "object" }, "worker_id": { "description": "ID of the Rippling worker associated with this external app account.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Retrieve a specific app user", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "app-users.read" ] } }, "/background-check-candidates/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/list-background-check-candidates" }, "operationId": "rippling.rest_api.list_background_check_candidates", "parameters": [ { "in": "query", "name": "filter", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 100, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "__meta": { "$ref": "#/components/schemas/OutputRestApiRedactedFields9f7657dc2a2f" }, "next_link": { "description": "A link to the next page of responses.", "format": "uri", "type": "string" }, "results": { "items": { "$ref": "#/components/schemas/OutputRestApiBackgroundCheckCandidatec01e79007528" }, "type": "array" } }, "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "List background check candidates", "x-rippling-entitlements": [ "Background_Check_Platform_API" ], "x-rippling-required-scopes": [ "background-check-candidates.read" ] }, "post": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/create-background-check-candidates" }, "operationId": "rippling.rest_api.create_background_check_candidates", "parameters": [ { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiBackgroundCheckCandidateRequest435d27af6ae6" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "\n Background Check Candidate DTO.\n\n Represents a candidate who has been submitted for background check screening.\n\n Required on Create (but nullable on read for legacy rows):\n - email: Required for new candidates, but may be null on read for legacy rows\n - external_id: Required for new candidates, but may be null on read for legacy rows\n\n Optional Fields:\n - owner_id: May be null if no provider is associated\n - first_name: May be null if name is not available\n - last_name: May be null if name is not available\n - middle_name: May be null if not provided\n\n Sensitive Fields:\n - first_name, last_name, middle_name: Name fields are PII marked as sensitive in the model\n - These do not require separate OAuth scopes beyond the resource-level scopes\n (background-check-candidates.read / .read-write) because they are not updating\n role or worker data, only storing candidate names for background check processing\n\n Note: first_name, last_name, and middle_name are NOT filterable.\n Only external_id, email, created_at, and updated_at support filtering.\n ", "properties": { "created_at": { "description": "The timestamp when the candidate was created.", "type": "string" }, "email": { "description": "The email address of the candidate. Required on create, but may be null on read for legacy rows.", "type": "string" }, "external_id": { "description": "The provider's unique identifier for the candidate. Required on create, but may be null on read for legacy rows. Can only be set once (during creation or when null). Cannot be changed after being set.", "type": "string" }, "first_name": { "description": "The first name of the candidate.", "type": "string" }, "id": { "description": "The unique identifier of the background check candidate.", "type": "string" }, "last_name": { "description": "The last name of the candidate.", "type": "string" }, "middle_name": { "description": "The middle name of the candidate.", "type": "string" }, "owner_id": { "description": "The ID of the background check provider (OAuth spoke owner).", "type": "string" }, "updated_at": { "description": "The timestamp when the candidate was last updated.", "type": "string" } }, "required": [ "email", "external_id" ], "title": "BackgroundCheckCandidate", "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Create a new background check candidate", "x-rippling-entitlements": [ "Background_Check_Platform_API" ], "x-rippling-required-scopes": [ "background-check-candidates.read-write" ] } }, "/background-check-candidates/{id}/": { "delete": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/delete-background-check-candidates" }, "operationId": "rippling.rest_api.delete_background_check_candidates", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "id", "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "204": { "description": "The resource was deleted successfully" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Delete a background check candidate", "x-rippling-entitlements": [ "Background_Check_Platform_API" ], "x-rippling-required-scopes": [ "background-check-candidates.read-write" ] }, "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/get-background-check-candidates" }, "operationId": "rippling.rest_api.get_background_check_candidates", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "id", "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "__meta": { "properties": { "redacted_fields": { "items": { "$ref": "#/components/schemas/OutputRestApiRedactedField21788a25ef22" }, "type": "array" } }, "type": "object" }, "created_at": { "description": "The timestamp when the candidate was created.", "type": "string" }, "email": { "description": "The email address of the candidate. Required on create, but may be null on read for legacy rows.", "type": "string" }, "external_id": { "description": "The provider's unique identifier for the candidate. Required on create, but may be null on read for legacy rows. Can only be set once (during creation or when null). Cannot be changed after being set.", "type": "string" }, "first_name": { "description": "The first name of the candidate.", "type": "string" }, "id": { "description": "The unique identifier of the background check candidate.", "type": "string" }, "last_name": { "description": "The last name of the candidate.", "type": "string" }, "middle_name": { "description": "The middle name of the candidate.", "type": "string" }, "owner_id": { "description": "The ID of the background check provider (OAuth spoke owner).", "type": "string" }, "updated_at": { "description": "The timestamp when the candidate was last updated.", "type": "string" } }, "required": [ "email", "external_id" ], "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Retrieve a specific background check candidate", "x-rippling-entitlements": [ "Background_Check_Platform_API" ], "x-rippling-required-scopes": [ "background-check-candidates.read" ] }, "patch": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/update-background-check-candidates" }, "operationId": "rippling.rest_api.update_background_check_candidates", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "id", "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiBackgroundCheckCandidateRequest435d27af6ae6" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "\n Background Check Candidate DTO.\n\n Represents a candidate who has been submitted for background check screening.\n\n Required on Create (but nullable on read for legacy rows):\n - email: Required for new candidates, but may be null on read for legacy rows\n - external_id: Required for new candidates, but may be null on read for legacy rows\n\n Optional Fields:\n - owner_id: May be null if no provider is associated\n - first_name: May be null if name is not available\n - last_name: May be null if name is not available\n - middle_name: May be null if not provided\n\n Sensitive Fields:\n - first_name, last_name, middle_name: Name fields are PII marked as sensitive in the model\n - These do not require separate OAuth scopes beyond the resource-level scopes\n (background-check-candidates.read / .read-write) because they are not updating\n role or worker data, only storing candidate names for background check processing\n\n Note: first_name, last_name, and middle_name are NOT filterable.\n Only external_id, email, created_at, and updated_at support filtering.\n ", "properties": { "created_at": { "description": "The timestamp when the candidate was created.", "type": "string" }, "email": { "description": "The email address of the candidate. Required on create, but may be null on read for legacy rows.", "type": "string" }, "external_id": { "description": "The provider's unique identifier for the candidate. Required on create, but may be null on read for legacy rows. Can only be set once (during creation or when null). Cannot be changed after being set.", "type": "string" }, "first_name": { "description": "The first name of the candidate.", "type": "string" }, "id": { "description": "The unique identifier of the background check candidate.", "type": "string" }, "last_name": { "description": "The last name of the candidate.", "type": "string" }, "middle_name": { "description": "The middle name of the candidate.", "type": "string" }, "owner_id": { "description": "The ID of the background check provider (OAuth spoke owner).", "type": "string" }, "updated_at": { "description": "The timestamp when the candidate was last updated.", "type": "string" } }, "required": [ "email", "external_id" ], "title": "BackgroundCheckCandidate", "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Update a background check candidate", "x-rippling-entitlements": [ "Background_Check_Platform_API" ], "x-rippling-required-scopes": [ "background-check-candidates.read-write" ] } }, "/bill-payments/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/list-bill-payments" }, "operationId": "rippling.rest_api.list_bill_payments", "parameters": [ { "in": "query", "name": "filter", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 100, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "__meta": { "$ref": "#/components/schemas/OutputRestApiRedactedFields9f7657dc2a2f" }, "next_link": { "description": "A link to the next page of responses.", "format": "uri", "type": "string" }, "results": { "items": { "$ref": "#/components/schemas/OutputRestApiBillPaymentee88dd92df5e" }, "type": "array" } }, "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "List bill payments", "x-rippling-entitlements": [ "Internal_Testing" ], "x-rippling-required-scopes": [ "bill-payments.read" ] } }, "/bill-payments/{id}/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/get-bill-payments" }, "operationId": "rippling.rest_api.get_bill_payments", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "id", "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "__meta": { "properties": { "redacted_fields": { "items": { "$ref": "#/components/schemas/OutputRestApiRedactedField21788a25ef22" }, "type": "array" } }, "type": "object" }, "accounting_date": { "description": "Date the transaction is booked in the accounting system, as an ISO 8601 date (YYYY-MM-DD).", "type": "string" }, "approval_status": { "description": "Approval state of the bill. `DRAFT`: not submitted. `PENDING`: awaiting required information before submission. `REQUESTED`: awaiting approval. `APPROVED`: approved. `REJECTED`: rejected. `FINALIZED`: finalized for payment. `ACTIONED`: paid. `CANCELLED`: cancelled. `FAILED`: payment failed.", "type": "string" }, "attachments": { "description": "URLs of other attached files.", "items": { "type": "string" }, "type": "array" }, "check_date": { "description": "Date the company is debited, as an ISO 8601 date. Null when not set.", "type": "string" }, "company_amount": { "description": "Amount in the company's headquarters currency. The `value` is a decimal string.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "credit_method": { "description": "How the vendor is paid: ACH, WIRE, CHECK, GLOBAL_ORDER, EXISTING_CORPORATE_CARD, or MANUALLY_PAID.", "type": "string" }, "debit_method": { "description": "How the company is debited: ACH, WIRE, EXISTING_CORPORATE_CARD, or MANUALLY_PAID.", "type": "string" }, "due_date": { "description": "Invoice due date, as an ISO 8601 date. A draft can omit it.", "type": "string" }, "entity_id": { "description": "ID of the legal entity the transaction belongs to. Use it with `/company-legal-entities/{id}/`.", "type": "string" }, "estimated_payment_arrival": { "description": "When the vendor is expected to receive the payment, as an ISO 8601 date-time in UTC. Null when not set.", "type": "string" }, "gl_sync_state": { "description": "State of the sync to the accounting system. `NOT_FINALIZED`: not ready for accounting review. `FOR_REVIEW`: ready for accounting review. `PENDING_SYNC`: sync is in progress. `SYNCED`: synced to the accounting system. `ERROR`: sync failed. `DO_NOT_SYNC`: marked to be excluded from sync. `EXPORTED`: exported for accounting. `NOT_SYNCABLE`: this record cannot be synced. `AUTO_SYNC`: ready to be synced automatically. Null when no sync state is set.", "type": "string" }, "gl_vendor": { "description": "Vendor in the connected accounting system.", "properties": { "gl_vendor_id": { "description": "ID of the vendor in the accounting system.", "type": "string" }, "id": { "description": "ID of the accounting vendor in Rippling.", "type": "string" }, "name": { "description": "Name of the vendor in the accounting system.", "type": "string" } }, "title": "GLVendor", "type": "object" }, "global_purpose": { "description": "Purpose code for an international payment. Null for domestic payments.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "invoice_number": { "description": "Invoice number. Null when the bill has no invoice number.", "type": "string" }, "line_items": { "description": "Bill line items, including accounting, tax, quantity, and term details.", "items": { "$ref": "#/components/schemas/OutputRestApiBillPaymentLineItem3bf57be649fb" }, "type": "array" }, "memo": { "description": "Memo entered on the transaction.", "type": "string" }, "merchant_amount": { "description": "Amount charged by the merchant, in the merchant currency. The `value` is a decimal string.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "parent_bill_id": { "description": "ID of the bill this payment was split from. Use it with `/bill-payments/{id}/`. Null when it is not a split bill.", "type": "string" }, "payment_amount": { "description": "Amount paid to the vendor, in the payment currency. The value is a decimal string.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "payment_method_fee": { "description": "Payment method fee, in the company's headquarters currency. The `value` is a decimal string. Zero when there is no fee.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "payment_schedule_setting": { "description": "SCHEDULE_NOW when a debit date was chosen; SKIP_FOR_NOW when choosing one was skipped.", "type": "string" }, "payment_velocity": { "description": "How fast the vendor is paid after `check_date`: `TWO_DAY` (accelerated, 2 business days) or `FOUR_DAY` (standard, 4 business days).", "type": "string" }, "receipt": { "description": "URL of the receipt file.", "type": "string" }, "scheduled_payment_date": { "description": "Date used to estimate vendor payment, as an ISO 8601 date. Null when not set.", "type": "string" }, "submitter_id": { "description": "ID of the bill manager who submitted the bill. Use it with `/workers/{id}/`. Can differ from `worker_id`. Null before submission.", "type": "string" }, "transaction_date": { "description": "Invoice date, as an ISO 8601 date-time in UTC. Null when not set.", "type": "string" }, "transaction_type": { "description": "Type of transaction: `BILL_PAYMENT`.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "vendor": { "description": "Vendor the purchase was made from.", "properties": { "id": { "description": "ID of the vendor.", "type": "string" }, "name": { "description": "Name of the vendor.", "type": "string" } }, "title": "Vendor", "type": "object" }, "vendor_memo": { "description": "Memo included on the payment to the vendor. Supported for ACH; null when not set.", "type": "string" }, "vendor_paid_date": { "description": "Date the vendor is paid, as an ISO 8601 date. Null until paid.", "type": "string" }, "worker_id": { "description": "ID of the worker who made the transaction. Use it with `/workers/{id}/`.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Retrieve a specific bill payment", "x-rippling-entitlements": [ "Internal_Testing" ], "x-rippling-required-scopes": [ "bill-payments.read" ] } }, "/break-policies/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/list-break-policies" }, "operationId": "rippling.rest_api.list_break_policies", "parameters": [ { "in": "query", "name": "order_by", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 100, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "__meta": { "$ref": "#/components/schemas/OutputRestApiRedactedFields9f7657dc2a2f" }, "next_link": { "description": "A link to the next page of responses.", "format": "uri", "type": "string" }, "results": { "items": { "$ref": "#/components/schemas/OutputRestApiBreakPolicycdd2c69fe56e" }, "type": "array" } }, "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "List break policies", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "break-policies.read" ] } }, "/break-policies/{id}/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/get-break-policies" }, "operationId": "rippling.rest_api.get_break_policies", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "id", "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "__meta": { "properties": { "redacted_fields": { "items": { "$ref": "#/components/schemas/OutputRestApiRedactedField21788a25ef22" }, "type": "array" } }, "type": "object" }, "country_code": { "description": "ISO 3166-1 alpha-2 country code the policy applies to (e.g. 'US', 'CA', 'GB').", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_default": { "description": "Whether this is a system-seeded default policy (true) or a custom policy created by an admin (false).", "type": "boolean" }, "name": { "description": "The display name of the break policy. For default policies this is the system-generated label (e.g. 'Default Break policy: All Workers | California'); for custom policies this is the admin-provided description.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Retrieve a specific break policy", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "break-policies.read" ] } }, "/break-types/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/list-break-types" }, "operationId": "rippling.rest_api.list_break_types", "parameters": [ { "in": "query", "name": "filter", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "expand", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 100, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "__meta": { "$ref": "#/components/schemas/OutputRestApiRedactedFields9f7657dc2a2f" }, "next_link": { "description": "A link to the next page of responses.", "format": "uri", "type": "string" }, "results": { "items": { "$ref": "#/components/schemas/OutputRestApiBreakType7a4805efe181" }, "type": "array" } }, "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "List break types", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "break-types.read" ] } }, "/break-types/{id}/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/get-break-types" }, "operationId": "rippling.rest_api.get_break_types", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "id", "type": "string" } }, { "in": "query", "name": "expand", "required": false, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "__meta": { "properties": { "redacted_fields": { "items": { "$ref": "#/components/schemas/OutputRestApiRedactedField21788a25ef22" }, "type": "array" } }, "type": "object" }, "break_category": { "description": "The break category. One of: MEAL, REST, or OTHER.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_paid": { "description": "Whether this is a paid break (true) or unpaid (false).", "type": "boolean" }, "name": { "description": "The display name of the break type.", "type": "string" }, "policy": { "description": "The break policy this break type belongs to. Use ?expand=policy to inline the full policy object.\n\nExpandable field", "properties": { "country_code": { "description": "ISO 3166-1 alpha-2 country code the policy applies to (e.g. 'US', 'CA', 'GB').", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_default": { "description": "Whether this is a system-seeded default policy (true) or a custom policy created by an admin (false).", "type": "boolean" }, "name": { "description": "The display name of the break policy. For default policies this is the system-generated label (e.g. 'Default Break policy: All Workers | California'); for custom policies this is the admin-provided description.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "BreakPolicy", "type": "object" }, "policy_id": { "description": "The ID of the break policy this break type belongs to.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Retrieve a specific break type", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "break-types.read" ] } }, "/business-partner-groups/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/list-business-partner-groups" }, "operationId": "rippling.rest_api.list_business_partner_groups", "parameters": [ { "in": "query", "name": "expand", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 100, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "__meta": { "$ref": "#/components/schemas/OutputRestApiRedactedFields9f7657dc2a2f" }, "next_link": { "description": "A link to the next page of responses.", "format": "uri", "type": "string" }, "results": { "items": { "$ref": "#/components/schemas/OutputRestApiBusinessPartnerGroup17ccd8b88b1b" }, "type": "array" } }, "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "List business partner groups", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "business-partner-groups.read" ] }, "post": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/create-business-partner-groups" }, "operationId": "rippling.rest_api.create_business_partner_groups", "parameters": [ { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiBusinessPartnerGroupRequest9765bdaa9d1f" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "default_business_partner": { "description": "Optional default business partner worker to whom all employees will be mapped if not explicitly mapped to a business partner in the group.\n\nExpandable field", "properties": { "business_partners": { "description": "Worker's assigned business partners. This field is only populated when explicitly requested via the expand parameter (e.g., ?expand=business_partners). When expanded, returns an empty list ([]) if the worker has no business partners.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiBusinessPartner01691db528c5" }, "type": "array" }, "business_partners_id": { "description": "Worker's assigned business partners unique identifiers. Returns an empty list ([]) if the worker has no business partners.", "items": { "type": "string" }, "type": "array" }, "citizenship": { "description": "The countries that the worker has citizenship in.", "type": "string" }, "compensation": { "description": "The compensation package for the worker.\n\nExpandable field", "properties": { "annual_compensation": { "description": "The worker's annual compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "annual_salary_equivalent": { "description": "The worker's annual salary equivalent, for insurance purposes. It will be equal to the worker's annual compensation, except for owners that are receiving no cashcompensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "bonus_schedule": { "description": "The worker's bonus schedule.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "hourly_wage": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "id": { "description": "Identifier field", "type": "string" }, "monthly_compensation": { "description": "The worker's monthly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "on_target_commission": { "description": "The worker's on-target commission.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "payment_terms": { "description": "The payment terms for an worker's compensation.", "type": "string" }, "payment_type": { "description": "The payment type for an worker's compensation.", "type": "string" }, "relocation_reimbursement": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "salary_effective_date": { "description": "Salary effective date", "type": "string" }, "signing_bonus": { "description": "The worker's signing bonus.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus": { "description": "The worker's target annual bonus amount.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus_percent": { "anyOf": [ { "description": "The worker's target annual bonus as a percent of annual compensation.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" }, "weekly_compensation": { "description": "The worker's weekly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "worker": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's details.\n\nExpandable field", "type": "object" }, "worker_id": { "description": "The worker's ID.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Compensation", "type": "object" }, "compensation_grade": { "description": "The compensation grade assigned to the worker, if any.", "properties": { "id": { "description": "The compensation grade's unique identifier.", "type": "string" }, "label": { "description": "The compensation grade's label.", "type": "string" } }, "title": "WorkerCompensationGrade", "type": "object" }, "compensation_id": { "description": "The compensation package for the worker.", "type": "string" }, "country": { "description": "The worker's country.", "type": "string" }, "country_fields": { "description": "Country level fields for the worker.", "properties": { "ca": { "description": "Country-wise regional fields for Canada", "properties": { "sin": { "description": "Social Insurance Number (SIN) for Canada employees.", "type": "string" } }, "title": "CanadaFields", "type": "object" }, "nz": { "description": "Country-wise regional fields for New Zealand", "properties": { "ird_number": { "description": "Inland Revenue Department (IRD) number for New Zealand employees.", "type": "string" } }, "title": "NewZealandFields", "type": "object" }, "us": { "description": "Country-wise regional fields for USA", "properties": { "ssn": { "description": "Social Security Number (SSN) for US employees.", "type": "string" } }, "title": "USFields", "type": "object" } }, "title": "CountryFields", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "custom_fields": { "description": "Custom field values defined on the Employee object for this worker\n\nExpandable field", "items": { "additionalProperties": {} }, "type": "array" }, "date_of_birth": { "description": "The worker's date of birth.", "type": "string" }, "department": { "description": "The worker's assigned department.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "department_hierarchy": { "description": "List of departments in the department hierarchy. Refer department_hierarchy_ids for department hierarchy order.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestDepartment" }, "type": "array" }, "department_hierarchy_id": { "description": "The identifier of departments in the department hierarchy ordered from parent department to child department.", "items": { "type": "string" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the department.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestDepartment", "description": "The parent department.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent department.", "type": "string" }, "reference_code": { "description": "Reference code of the department.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Department", "type": "object" }, "department_id": { "description": "The worker's assigned department.", "type": "string" }, "employment_type": { "description": "The worker's employment type.\n\nExpandable field", "properties": { "amount_worked": { "description": "The amount worked for the employment type. * `FULL-TIME`: Full-time is at least 30 hours per week. Full-time workers will typically be eligible for benefits. * `PART-TIME`: Part-time is less than 30 hours per week. These workers may be eligible for benefits, depending on company settings and hours worked. * `TEMPORARY`: These workers are hired on a temporary basis. You can specify how each worker with this employment type will be paid individually.", "type": "string" }, "compensation_time_period": { "description": "The compensation period for the employment type. * `SALARIED`: Employees that are paid a fixed amount per year. * `HOURLY`: Employees that are paid a wage per hour worked.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "label": { "description": "The display label of the employment type.", "type": "string" }, "name": { "description": "The name of the employment type for non-custom employment types.", "type": "string" }, "type": { "description": "The classification of the worker by the company. * `CONTRACTOR`: Contractors are self-employed workers who provide services on a short-term or per-project basis and are not eligible for tax-withholding or benefits. * `EMPLOYEE`: Employees are hired and managed by an employer, work under the employer's direct supervision and control, and are protected by law for wages and employment rights.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "label", "updated_at" ], "title": "CompanyEmploymentType", "type": "object" }, "employment_type_id": { "description": "The worker's employment type.", "type": "string" }, "end_date": { "description": "The end date of the worker.", "type": "string" }, "ethnicity": { "description": "The identified ethnicity of the worker, if specified.", "type": "string" }, "gender": { "description": "The gender of the worker, if specified.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_manager": { "description": "Whether the worker is a manager", "type": "boolean" }, "job_function": { "description": "The worker's job function. When expanded, this field requires `job-functions.read`.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "Displayed name of the job function", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "JobFunction", "type": "object" }, "job_function_id": { "description": "ID of the worker's job function.", "type": "string" }, "legal_entity": { "description": "The worker's associated legal entity.\n\nExpandable field", "properties": { "company": { "description": "The company or organization associated with the legal entity\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "doing_business_as_name": { "description": "The doing business as name for the company.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_entities": { "description": "A list of the company's entities.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestLegalEntity" }, "type": "array" }, "legal_entities_id": { "description": "A list of the company's entities.", "items": { "type": "string" }, "type": "array" }, "legal_name": { "description": "The legal name of the company.", "type": "string" }, "name": { "description": "The name of the company.", "type": "string" }, "parent_legal_entity": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The company's ultimate holding entity.\n\nExpandable field", "type": "object" }, "parent_legal_entity_id": { "description": "The company's ultimate holding entity.", "type": "string" }, "phone": { "description": "The phone number for the company.", "type": "string" }, "physical_address": { "description": "The physical address of the holding entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "primary_email": { "description": "The email address used when registering this company.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "legal_entities", "legal_entities_id", "name", "updated_at" ], "title": "Company", "type": "object" }, "company_id": { "description": "The company or organization associated with the legal entity", "type": "string" }, "country": { "description": "The country the legal entity is based in.", "properties": { "code": { "description": "The code of the country.", "type": "string" } }, "required": [ "code" ], "title": "Country", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "entity_level": { "description": "The legal entity's level in a hierarchy. * `PARENT`: The legal entity is considered the ultimate holding entity. * `SUBSIDIARY`: The legal entity is considered a subsidiary, fully or partially held by another. * `BRANCH`: The legal entity is considered a branch, associated with a parent legal entity.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_name": { "description": "The legal name of the legal entity.", "type": "string" }, "mailing_address": { "description": "The mailing address of the legal entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "management_type": { "description": "The legal entity management type in the case of an employer of record (EOR) or professional employment organization (PEO). * `PEO`: The legal entity is considered a Professional Employment Organization (PEO). * `EOR`: The legal entity is considered an Employer of Record (EOR).", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The parent legal entity.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent legal entity.", "type": "string" }, "physical_address": { "description": "The physical address of the legal entity, if it differs from the mailing address.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "registration_date": { "description": "The registration date of the entity.", "type": "string" }, "tax_identifier": { "description": "The tax identifier for the legal entity.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "LegalEntity", "type": "object" }, "legal_entity_id": { "description": "The worker's associated legal entity.", "type": "string" }, "level": { "description": "The level of the worker.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "description": { "description": "The description of the level.", "type": "string" }, "experience_requirements": { "description": "The experience requirements for the level.", "type": "string" }, "global_level": { "anyOf": [ { "description": "Global level is used to track the seniority of levels. The higher up a level is placed on the page, the more senior and higher-ranked the level. Global level is used in workflows, policies, and reports that use the level attribute (e.g., you can use Level Lookup to set up a workflow that notifies the nearest person in an worker's management chain at or above the specified level).", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the level. Must be unique within the company or organization.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLevel", "description": "The parent level.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent level.", "type": "string" }, "rank": { "anyOf": [ { "description": "The rank of the level within its track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "scope_of_responsibilities": { "description": "The scope of responsibilities for the level.", "type": "string" }, "track": { "description": "The track associated with the level, if it's not a global level.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_default": { "description": "Whether this is the company's default track.", "type": "boolean" }, "name": { "description": "The name of the track. Must be unique within the company or organization.", "type": "string" }, "order": { "anyOf": [ { "description": "The one-based horizontal display order of the track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "start_global_level": { "anyOf": [ { "description": "The highest global level occupied by this track. Empty tracks return null.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Track", "type": "object" }, "track_id": { "description": "The track associated with the level. Required during creation. Include global_level when changing it.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Level", "type": "object" }, "level_id": { "description": "The level of the worker.", "type": "string" }, "location": { "description": "The location that the worker is mapped to for tax purposes. In the case that a worker is remote, the location's type is remote.", "properties": { "type": { "description": "The type of location.", "type": "string" }, "work_location_id": { "description": "The work location, if the worker isn't remote.", "type": "string" } }, "required": [ "type", "work_location_id" ], "title": "WorkerLocation", "type": "object" }, "manager": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's manager.\n\nExpandable field", "type": "object" }, "manager_id": { "description": "The worker's manager.", "type": "string" }, "number": { "anyOf": [ { "description": "The worker's number within the organization.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "original_start_date": { "description": "The worker's earliest start date across their employment history, excluding INIT roles.", "type": "string" }, "overtime_exemption": { "description": "The worker's overtime exemption status.", "type": "string" }, "pay_schedule_id": { "description": "The ID of the pay schedule currently associated with the worker.", "type": "string" }, "personal_email": { "description": "The worker's associated personal email address.", "type": "string" }, "race": { "description": "The identified race of the worker, if specified.", "type": "string" }, "start_date": { "description": "The start date of the worker.", "type": "string" }, "status": { "description": "The worker's status within the organization.", "type": "string" }, "teams": { "description": "The worker's assigned teams.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiTeamcb26bc28f32f" }, "type": "array" }, "teams_id": { "description": "The worker's assigned teams.", "items": { "type": "string" }, "type": "array" }, "termination_details": { "description": "The details of the worker's termination, if applicable.", "properties": { "reason": { "description": "This is a description that will be custom to each Rippling company.", "type": "string" }, "type": { "description": "The termination type indicates whether the termination was voluntary or involuntary.", "type": "string" } }, "title": "TerminationDetails", "type": "object" }, "title": { "description": "The worker's title.", "type": "string" }, "title_effective_date": { "description": "Title effective date", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "user": { "description": "The worker's associated user.\n\nExpandable field", "properties": { "active": { "description": "Whether the user is able to access company resources, typically when they are in actively engaged with the company and not after off-boarding.", "type": "boolean" }, "addresses": { "description": "The user's addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiUserAddressedd59b9ba9a1" }, "type": "array" }, "created_at": { "description": "Record creation date", "type": "string" }, "display_name": { "description": "The display name of the user using either the concatenated preferred given and family name or username depending on availability.", "type": "string" }, "emails": { "description": "The user's email addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiEmail5284c8258dc3" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "locale": { "description": "The User's default location for purposes of localization of currency, date time format, or numerical representations pursuant to RFC5646.", "type": "string" }, "name": { "description": "The user's name.", "properties": { "family_name": { "description": "The legal family name of the user, or last name in most Western languages.", "type": "string" }, "formatted": { "description": "The user's full name.", "type": "string" }, "given_name": { "description": "The given legal name of the user, or first name in most Western languages.", "type": "string" }, "middle_name": { "description": "The middle name(s) of the user.", "type": "string" }, "preferred_family_name": { "description": "The preferred family name, or last name in most Western languages, by the user.", "type": "string" }, "preferred_given_name": { "description": "The preferred given name, or first name in most Western languages, by the user.", "type": "string" } }, "title": "UserName", "type": "object" }, "number": { "description": "The permanent profile number of the user.", "type": "string" }, "phone_numbers": { "description": "The user's phone numbers.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoneNumber12060c61ecf5" }, "type": "array" }, "photos": { "description": "The user's photos.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoto2be7c3ae3f39" }, "type": "array" }, "preferred_language": { "description": "The User's preferred written or spoken language in the same format of the HTTP Accept-Language header, pursuant to Section 5.3.5 of RFC7231.", "type": "string" }, "timezone": { "description": "The User's current time zone in IANA database Olson format", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "username": { "description": "The unique identifier across Rippling used by the User for direct authentication into their associated company. Globally unique.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "User", "type": "object" }, "user_id": { "description": "The worker's associated user.", "type": "string" }, "work_email": { "description": "The worker's associated work email address.", "type": "string" }, "work_schedule": { "additionalProperties": { "$ref": "#/components/schemas/OutputRestApiWorkScheduleDay938f88d94f20" }, "description": "The worker's scheduled working hours for each day of the week.", "type": "object" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Worker", "type": "object" }, "default_business_partner_id": { "description": "Id of Optional default business partner worker to whom all employees will be mapped if not explicitly mapped to a business partner in the group.", "type": "string" }, "domain": { "description": "Type of business partner group", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "Name used to identify business partner group", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "BusinessPartnerGroup", "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Create a new business partner group", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "business-partner-groups.read-write" ] } }, "/business-partner-groups/{id}/": { "delete": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/delete-business-partner-groups" }, "operationId": "rippling.rest_api.delete_business_partner_groups", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "id", "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "204": { "description": "The resource was deleted successfully" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Delete a business partner group", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "business-partner-groups.read-write" ] }, "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/get-business-partner-groups" }, "operationId": "rippling.rest_api.get_business_partner_groups", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "id", "type": "string" } }, { "in": "query", "name": "expand", "required": false, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "__meta": { "properties": { "redacted_fields": { "items": { "$ref": "#/components/schemas/OutputRestApiRedactedField21788a25ef22" }, "type": "array" } }, "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "default_business_partner": { "description": "Optional default business partner worker to whom all employees will be mapped if not explicitly mapped to a business partner in the group.\n\nExpandable field", "properties": { "business_partners": { "description": "Worker's assigned business partners. This field is only populated when explicitly requested via the expand parameter (e.g., ?expand=business_partners). When expanded, returns an empty list ([]) if the worker has no business partners.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiBusinessPartner01691db528c5" }, "type": "array" }, "business_partners_id": { "description": "Worker's assigned business partners unique identifiers. Returns an empty list ([]) if the worker has no business partners.", "items": { "type": "string" }, "type": "array" }, "citizenship": { "description": "The countries that the worker has citizenship in.", "type": "string" }, "compensation": { "description": "The compensation package for the worker.\n\nExpandable field", "properties": { "annual_compensation": { "description": "The worker's annual compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "annual_salary_equivalent": { "description": "The worker's annual salary equivalent, for insurance purposes. It will be equal to the worker's annual compensation, except for owners that are receiving no cashcompensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "bonus_schedule": { "description": "The worker's bonus schedule.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "hourly_wage": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "id": { "description": "Identifier field", "type": "string" }, "monthly_compensation": { "description": "The worker's monthly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "on_target_commission": { "description": "The worker's on-target commission.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "payment_terms": { "description": "The payment terms for an worker's compensation.", "type": "string" }, "payment_type": { "description": "The payment type for an worker's compensation.", "type": "string" }, "relocation_reimbursement": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "salary_effective_date": { "description": "Salary effective date", "type": "string" }, "signing_bonus": { "description": "The worker's signing bonus.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus": { "description": "The worker's target annual bonus amount.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus_percent": { "anyOf": [ { "description": "The worker's target annual bonus as a percent of annual compensation.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" }, "weekly_compensation": { "description": "The worker's weekly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "worker": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's details.\n\nExpandable field", "type": "object" }, "worker_id": { "description": "The worker's ID.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Compensation", "type": "object" }, "compensation_grade": { "description": "The compensation grade assigned to the worker, if any.", "properties": { "id": { "description": "The compensation grade's unique identifier.", "type": "string" }, "label": { "description": "The compensation grade's label.", "type": "string" } }, "title": "WorkerCompensationGrade", "type": "object" }, "compensation_id": { "description": "The compensation package for the worker.", "type": "string" }, "country": { "description": "The worker's country.", "type": "string" }, "country_fields": { "description": "Country level fields for the worker.", "properties": { "ca": { "description": "Country-wise regional fields for Canada", "properties": { "sin": { "description": "Social Insurance Number (SIN) for Canada employees.", "type": "string" } }, "title": "CanadaFields", "type": "object" }, "nz": { "description": "Country-wise regional fields for New Zealand", "properties": { "ird_number": { "description": "Inland Revenue Department (IRD) number for New Zealand employees.", "type": "string" } }, "title": "NewZealandFields", "type": "object" }, "us": { "description": "Country-wise regional fields for USA", "properties": { "ssn": { "description": "Social Security Number (SSN) for US employees.", "type": "string" } }, "title": "USFields", "type": "object" } }, "title": "CountryFields", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "custom_fields": { "description": "Custom field values defined on the Employee object for this worker\n\nExpandable field", "items": { "additionalProperties": {} }, "type": "array" }, "date_of_birth": { "description": "The worker's date of birth.", "type": "string" }, "department": { "description": "The worker's assigned department.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "department_hierarchy": { "description": "List of departments in the department hierarchy. Refer department_hierarchy_ids for department hierarchy order.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestDepartment" }, "type": "array" }, "department_hierarchy_id": { "description": "The identifier of departments in the department hierarchy ordered from parent department to child department.", "items": { "type": "string" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the department.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestDepartment", "description": "The parent department.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent department.", "type": "string" }, "reference_code": { "description": "Reference code of the department.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Department", "type": "object" }, "department_id": { "description": "The worker's assigned department.", "type": "string" }, "employment_type": { "description": "The worker's employment type.\n\nExpandable field", "properties": { "amount_worked": { "description": "The amount worked for the employment type. * `FULL-TIME`: Full-time is at least 30 hours per week. Full-time workers will typically be eligible for benefits. * `PART-TIME`: Part-time is less than 30 hours per week. These workers may be eligible for benefits, depending on company settings and hours worked. * `TEMPORARY`: These workers are hired on a temporary basis. You can specify how each worker with this employment type will be paid individually.", "type": "string" }, "compensation_time_period": { "description": "The compensation period for the employment type. * `SALARIED`: Employees that are paid a fixed amount per year. * `HOURLY`: Employees that are paid a wage per hour worked.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "label": { "description": "The display label of the employment type.", "type": "string" }, "name": { "description": "The name of the employment type for non-custom employment types.", "type": "string" }, "type": { "description": "The classification of the worker by the company. * `CONTRACTOR`: Contractors are self-employed workers who provide services on a short-term or per-project basis and are not eligible for tax-withholding or benefits. * `EMPLOYEE`: Employees are hired and managed by an employer, work under the employer's direct supervision and control, and are protected by law for wages and employment rights.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "label", "updated_at" ], "title": "CompanyEmploymentType", "type": "object" }, "employment_type_id": { "description": "The worker's employment type.", "type": "string" }, "end_date": { "description": "The end date of the worker.", "type": "string" }, "ethnicity": { "description": "The identified ethnicity of the worker, if specified.", "type": "string" }, "gender": { "description": "The gender of the worker, if specified.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_manager": { "description": "Whether the worker is a manager", "type": "boolean" }, "job_function": { "description": "The worker's job function. When expanded, this field requires `job-functions.read`.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "Displayed name of the job function", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "JobFunction", "type": "object" }, "job_function_id": { "description": "ID of the worker's job function.", "type": "string" }, "legal_entity": { "description": "The worker's associated legal entity.\n\nExpandable field", "properties": { "company": { "description": "The company or organization associated with the legal entity\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "doing_business_as_name": { "description": "The doing business as name for the company.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_entities": { "description": "A list of the company's entities.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestLegalEntity" }, "type": "array" }, "legal_entities_id": { "description": "A list of the company's entities.", "items": { "type": "string" }, "type": "array" }, "legal_name": { "description": "The legal name of the company.", "type": "string" }, "name": { "description": "The name of the company.", "type": "string" }, "parent_legal_entity": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The company's ultimate holding entity.\n\nExpandable field", "type": "object" }, "parent_legal_entity_id": { "description": "The company's ultimate holding entity.", "type": "string" }, "phone": { "description": "The phone number for the company.", "type": "string" }, "physical_address": { "description": "The physical address of the holding entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "primary_email": { "description": "The email address used when registering this company.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "legal_entities", "legal_entities_id", "name", "updated_at" ], "title": "Company", "type": "object" }, "company_id": { "description": "The company or organization associated with the legal entity", "type": "string" }, "country": { "description": "The country the legal entity is based in.", "properties": { "code": { "description": "The code of the country.", "type": "string" } }, "required": [ "code" ], "title": "Country", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "entity_level": { "description": "The legal entity's level in a hierarchy. * `PARENT`: The legal entity is considered the ultimate holding entity. * `SUBSIDIARY`: The legal entity is considered a subsidiary, fully or partially held by another. * `BRANCH`: The legal entity is considered a branch, associated with a parent legal entity.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_name": { "description": "The legal name of the legal entity.", "type": "string" }, "mailing_address": { "description": "The mailing address of the legal entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "management_type": { "description": "The legal entity management type in the case of an employer of record (EOR) or professional employment organization (PEO). * `PEO`: The legal entity is considered a Professional Employment Organization (PEO). * `EOR`: The legal entity is considered an Employer of Record (EOR).", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The parent legal entity.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent legal entity.", "type": "string" }, "physical_address": { "description": "The physical address of the legal entity, if it differs from the mailing address.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "registration_date": { "description": "The registration date of the entity.", "type": "string" }, "tax_identifier": { "description": "The tax identifier for the legal entity.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "LegalEntity", "type": "object" }, "legal_entity_id": { "description": "The worker's associated legal entity.", "type": "string" }, "level": { "description": "The level of the worker.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "description": { "description": "The description of the level.", "type": "string" }, "experience_requirements": { "description": "The experience requirements for the level.", "type": "string" }, "global_level": { "anyOf": [ { "description": "Global level is used to track the seniority of levels. The higher up a level is placed on the page, the more senior and higher-ranked the level. Global level is used in workflows, policies, and reports that use the level attribute (e.g., you can use Level Lookup to set up a workflow that notifies the nearest person in an worker's management chain at or above the specified level).", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the level. Must be unique within the company or organization.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLevel", "description": "The parent level.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent level.", "type": "string" }, "rank": { "anyOf": [ { "description": "The rank of the level within its track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "scope_of_responsibilities": { "description": "The scope of responsibilities for the level.", "type": "string" }, "track": { "description": "The track associated with the level, if it's not a global level.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_default": { "description": "Whether this is the company's default track.", "type": "boolean" }, "name": { "description": "The name of the track. Must be unique within the company or organization.", "type": "string" }, "order": { "anyOf": [ { "description": "The one-based horizontal display order of the track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "start_global_level": { "anyOf": [ { "description": "The highest global level occupied by this track. Empty tracks return null.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Track", "type": "object" }, "track_id": { "description": "The track associated with the level. Required during creation. Include global_level when changing it.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Level", "type": "object" }, "level_id": { "description": "The level of the worker.", "type": "string" }, "location": { "description": "The location that the worker is mapped to for tax purposes. In the case that a worker is remote, the location's type is remote.", "properties": { "type": { "description": "The type of location.", "type": "string" }, "work_location_id": { "description": "The work location, if the worker isn't remote.", "type": "string" } }, "required": [ "type", "work_location_id" ], "title": "WorkerLocation", "type": "object" }, "manager": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's manager.\n\nExpandable field", "type": "object" }, "manager_id": { "description": "The worker's manager.", "type": "string" }, "number": { "anyOf": [ { "description": "The worker's number within the organization.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "original_start_date": { "description": "The worker's earliest start date across their employment history, excluding INIT roles.", "type": "string" }, "overtime_exemption": { "description": "The worker's overtime exemption status.", "type": "string" }, "pay_schedule_id": { "description": "The ID of the pay schedule currently associated with the worker.", "type": "string" }, "personal_email": { "description": "The worker's associated personal email address.", "type": "string" }, "race": { "description": "The identified race of the worker, if specified.", "type": "string" }, "start_date": { "description": "The start date of the worker.", "type": "string" }, "status": { "description": "The worker's status within the organization.", "type": "string" }, "teams": { "description": "The worker's assigned teams.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiTeamcb26bc28f32f" }, "type": "array" }, "teams_id": { "description": "The worker's assigned teams.", "items": { "type": "string" }, "type": "array" }, "termination_details": { "description": "The details of the worker's termination, if applicable.", "properties": { "reason": { "description": "This is a description that will be custom to each Rippling company.", "type": "string" }, "type": { "description": "The termination type indicates whether the termination was voluntary or involuntary.", "type": "string" } }, "title": "TerminationDetails", "type": "object" }, "title": { "description": "The worker's title.", "type": "string" }, "title_effective_date": { "description": "Title effective date", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "user": { "description": "The worker's associated user.\n\nExpandable field", "properties": { "active": { "description": "Whether the user is able to access company resources, typically when they are in actively engaged with the company and not after off-boarding.", "type": "boolean" }, "addresses": { "description": "The user's addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiUserAddressedd59b9ba9a1" }, "type": "array" }, "created_at": { "description": "Record creation date", "type": "string" }, "display_name": { "description": "The display name of the user using either the concatenated preferred given and family name or username depending on availability.", "type": "string" }, "emails": { "description": "The user's email addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiEmail5284c8258dc3" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "locale": { "description": "The User's default location for purposes of localization of currency, date time format, or numerical representations pursuant to RFC5646.", "type": "string" }, "name": { "description": "The user's name.", "properties": { "family_name": { "description": "The legal family name of the user, or last name in most Western languages.", "type": "string" }, "formatted": { "description": "The user's full name.", "type": "string" }, "given_name": { "description": "The given legal name of the user, or first name in most Western languages.", "type": "string" }, "middle_name": { "description": "The middle name(s) of the user.", "type": "string" }, "preferred_family_name": { "description": "The preferred family name, or last name in most Western languages, by the user.", "type": "string" }, "preferred_given_name": { "description": "The preferred given name, or first name in most Western languages, by the user.", "type": "string" } }, "title": "UserName", "type": "object" }, "number": { "description": "The permanent profile number of the user.", "type": "string" }, "phone_numbers": { "description": "The user's phone numbers.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoneNumber12060c61ecf5" }, "type": "array" }, "photos": { "description": "The user's photos.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoto2be7c3ae3f39" }, "type": "array" }, "preferred_language": { "description": "The User's preferred written or spoken language in the same format of the HTTP Accept-Language header, pursuant to Section 5.3.5 of RFC7231.", "type": "string" }, "timezone": { "description": "The User's current time zone in IANA database Olson format", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "username": { "description": "The unique identifier across Rippling used by the User for direct authentication into their associated company. Globally unique.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "User", "type": "object" }, "user_id": { "description": "The worker's associated user.", "type": "string" }, "work_email": { "description": "The worker's associated work email address.", "type": "string" }, "work_schedule": { "additionalProperties": { "$ref": "#/components/schemas/OutputRestApiWorkScheduleDay938f88d94f20" }, "description": "The worker's scheduled working hours for each day of the week.", "type": "object" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Worker", "type": "object" }, "default_business_partner_id": { "description": "Id of Optional default business partner worker to whom all employees will be mapped if not explicitly mapped to a business partner in the group.", "type": "string" }, "domain": { "description": "Type of business partner group", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "Name used to identify business partner group", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Retrieve a specific business partner group", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "business-partner-groups.read" ] } }, "/business-partners/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/list-business-partners" }, "operationId": "rippling.rest_api.list_business_partners", "parameters": [ { "in": "query", "name": "filter", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "expand", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 100, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "__meta": { "$ref": "#/components/schemas/OutputRestApiRedactedFields9f7657dc2a2f" }, "next_link": { "description": "A link to the next page of responses.", "format": "uri", "type": "string" }, "results": { "items": { "$ref": "#/components/schemas/OutputRestApiBusinessPartner9723c10abb09" }, "type": "array" } }, "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "List business partners", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "business-partners.read" ] }, "post": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/create-business-partners" }, "operationId": "rippling.rest_api.create_business_partners", "parameters": [ { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiBusinessPartnerRequest7e2756c35994" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "business_partner_group": { "description": "Business partner group the business partner is a part of\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "default_business_partner": { "description": "Optional default business partner worker to whom all employees will be mapped if not explicitly mapped to a business partner in the group.\n\nExpandable field", "properties": { "business_partners": { "description": "Worker's assigned business partners. This field is only populated when explicitly requested via the expand parameter (e.g., ?expand=business_partners). When expanded, returns an empty list ([]) if the worker has no business partners.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestBusinessPartner" }, "type": "array" }, "business_partners_id": { "description": "Worker's assigned business partners unique identifiers. Returns an empty list ([]) if the worker has no business partners.", "items": { "type": "string" }, "type": "array" }, "citizenship": { "description": "The countries that the worker has citizenship in.", "type": "string" }, "compensation": { "description": "The compensation package for the worker.\n\nExpandable field", "properties": { "annual_compensation": { "description": "The worker's annual compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "annual_salary_equivalent": { "description": "The worker's annual salary equivalent, for insurance purposes. It will be equal to the worker's annual compensation, except for owners that are receiving no cashcompensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "bonus_schedule": { "description": "The worker's bonus schedule.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "hourly_wage": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "id": { "description": "Identifier field", "type": "string" }, "monthly_compensation": { "description": "The worker's monthly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "on_target_commission": { "description": "The worker's on-target commission.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "payment_terms": { "description": "The payment terms for an worker's compensation.", "type": "string" }, "payment_type": { "description": "The payment type for an worker's compensation.", "type": "string" }, "relocation_reimbursement": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "salary_effective_date": { "description": "Salary effective date", "type": "string" }, "signing_bonus": { "description": "The worker's signing bonus.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus": { "description": "The worker's target annual bonus amount.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus_percent": { "anyOf": [ { "description": "The worker's target annual bonus as a percent of annual compensation.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" }, "weekly_compensation": { "description": "The worker's weekly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "worker": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's details.\n\nExpandable field", "type": "object" }, "worker_id": { "description": "The worker's ID.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Compensation", "type": "object" }, "compensation_grade": { "description": "The compensation grade assigned to the worker, if any.", "properties": { "id": { "description": "The compensation grade's unique identifier.", "type": "string" }, "label": { "description": "The compensation grade's label.", "type": "string" } }, "title": "WorkerCompensationGrade", "type": "object" }, "compensation_id": { "description": "The compensation package for the worker.", "type": "string" }, "country": { "description": "The worker's country.", "type": "string" }, "country_fields": { "description": "Country level fields for the worker.", "properties": { "ca": { "description": "Country-wise regional fields for Canada", "properties": { "sin": { "description": "Social Insurance Number (SIN) for Canada employees.", "type": "string" } }, "title": "CanadaFields", "type": "object" }, "nz": { "description": "Country-wise regional fields for New Zealand", "properties": { "ird_number": { "description": "Inland Revenue Department (IRD) number for New Zealand employees.", "type": "string" } }, "title": "NewZealandFields", "type": "object" }, "us": { "description": "Country-wise regional fields for USA", "properties": { "ssn": { "description": "Social Security Number (SSN) for US employees.", "type": "string" } }, "title": "USFields", "type": "object" } }, "title": "CountryFields", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "custom_fields": { "description": "Custom field values defined on the Employee object for this worker\n\nExpandable field", "items": { "additionalProperties": {} }, "type": "array" }, "date_of_birth": { "description": "The worker's date of birth.", "type": "string" }, "department": { "description": "The worker's assigned department.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "department_hierarchy": { "description": "List of departments in the department hierarchy. Refer department_hierarchy_ids for department hierarchy order.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestDepartment" }, "type": "array" }, "department_hierarchy_id": { "description": "The identifier of departments in the department hierarchy ordered from parent department to child department.", "items": { "type": "string" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the department.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestDepartment", "description": "The parent department.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent department.", "type": "string" }, "reference_code": { "description": "Reference code of the department.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Department", "type": "object" }, "department_id": { "description": "The worker's assigned department.", "type": "string" }, "employment_type": { "description": "The worker's employment type.\n\nExpandable field", "properties": { "amount_worked": { "description": "The amount worked for the employment type. * `FULL-TIME`: Full-time is at least 30 hours per week. Full-time workers will typically be eligible for benefits. * `PART-TIME`: Part-time is less than 30 hours per week. These workers may be eligible for benefits, depending on company settings and hours worked. * `TEMPORARY`: These workers are hired on a temporary basis. You can specify how each worker with this employment type will be paid individually.", "type": "string" }, "compensation_time_period": { "description": "The compensation period for the employment type. * `SALARIED`: Employees that are paid a fixed amount per year. * `HOURLY`: Employees that are paid a wage per hour worked.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "label": { "description": "The display label of the employment type.", "type": "string" }, "name": { "description": "The name of the employment type for non-custom employment types.", "type": "string" }, "type": { "description": "The classification of the worker by the company. * `CONTRACTOR`: Contractors are self-employed workers who provide services on a short-term or per-project basis and are not eligible for tax-withholding or benefits. * `EMPLOYEE`: Employees are hired and managed by an employer, work under the employer's direct supervision and control, and are protected by law for wages and employment rights.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "label", "updated_at" ], "title": "CompanyEmploymentType", "type": "object" }, "employment_type_id": { "description": "The worker's employment type.", "type": "string" }, "end_date": { "description": "The end date of the worker.", "type": "string" }, "ethnicity": { "description": "The identified ethnicity of the worker, if specified.", "type": "string" }, "gender": { "description": "The gender of the worker, if specified.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_manager": { "description": "Whether the worker is a manager", "type": "boolean" }, "job_function": { "description": "The worker's job function. When expanded, this field requires `job-functions.read`.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "Displayed name of the job function", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "JobFunction", "type": "object" }, "job_function_id": { "description": "ID of the worker's job function.", "type": "string" }, "legal_entity": { "description": "The worker's associated legal entity.\n\nExpandable field", "properties": { "company": { "description": "The company or organization associated with the legal entity\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "doing_business_as_name": { "description": "The doing business as name for the company.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_entities": { "description": "A list of the company's entities.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestLegalEntity" }, "type": "array" }, "legal_entities_id": { "description": "A list of the company's entities.", "items": { "type": "string" }, "type": "array" }, "legal_name": { "description": "The legal name of the company.", "type": "string" }, "name": { "description": "The name of the company.", "type": "string" }, "parent_legal_entity": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The company's ultimate holding entity.\n\nExpandable field", "type": "object" }, "parent_legal_entity_id": { "description": "The company's ultimate holding entity.", "type": "string" }, "phone": { "description": "The phone number for the company.", "type": "string" }, "physical_address": { "description": "The physical address of the holding entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "primary_email": { "description": "The email address used when registering this company.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "legal_entities", "legal_entities_id", "name", "updated_at" ], "title": "Company", "type": "object" }, "company_id": { "description": "The company or organization associated with the legal entity", "type": "string" }, "country": { "description": "The country the legal entity is based in.", "properties": { "code": { "description": "The code of the country.", "type": "string" } }, "required": [ "code" ], "title": "Country", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "entity_level": { "description": "The legal entity's level in a hierarchy. * `PARENT`: The legal entity is considered the ultimate holding entity. * `SUBSIDIARY`: The legal entity is considered a subsidiary, fully or partially held by another. * `BRANCH`: The legal entity is considered a branch, associated with a parent legal entity.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_name": { "description": "The legal name of the legal entity.", "type": "string" }, "mailing_address": { "description": "The mailing address of the legal entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "management_type": { "description": "The legal entity management type in the case of an employer of record (EOR) or professional employment organization (PEO). * `PEO`: The legal entity is considered a Professional Employment Organization (PEO). * `EOR`: The legal entity is considered an Employer of Record (EOR).", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The parent legal entity.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent legal entity.", "type": "string" }, "physical_address": { "description": "The physical address of the legal entity, if it differs from the mailing address.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "registration_date": { "description": "The registration date of the entity.", "type": "string" }, "tax_identifier": { "description": "The tax identifier for the legal entity.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "LegalEntity", "type": "object" }, "legal_entity_id": { "description": "The worker's associated legal entity.", "type": "string" }, "level": { "description": "The level of the worker.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "description": { "description": "The description of the level.", "type": "string" }, "experience_requirements": { "description": "The experience requirements for the level.", "type": "string" }, "global_level": { "anyOf": [ { "description": "Global level is used to track the seniority of levels. The higher up a level is placed on the page, the more senior and higher-ranked the level. Global level is used in workflows, policies, and reports that use the level attribute (e.g., you can use Level Lookup to set up a workflow that notifies the nearest person in an worker's management chain at or above the specified level).", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the level. Must be unique within the company or organization.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLevel", "description": "The parent level.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent level.", "type": "string" }, "rank": { "anyOf": [ { "description": "The rank of the level within its track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "scope_of_responsibilities": { "description": "The scope of responsibilities for the level.", "type": "string" }, "track": { "description": "The track associated with the level, if it's not a global level.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_default": { "description": "Whether this is the company's default track.", "type": "boolean" }, "name": { "description": "The name of the track. Must be unique within the company or organization.", "type": "string" }, "order": { "anyOf": [ { "description": "The one-based horizontal display order of the track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "start_global_level": { "anyOf": [ { "description": "The highest global level occupied by this track. Empty tracks return null.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Track", "type": "object" }, "track_id": { "description": "The track associated with the level. Required during creation. Include global_level when changing it.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Level", "type": "object" }, "level_id": { "description": "The level of the worker.", "type": "string" }, "location": { "description": "The location that the worker is mapped to for tax purposes. In the case that a worker is remote, the location's type is remote.", "properties": { "type": { "description": "The type of location.", "type": "string" }, "work_location_id": { "description": "The work location, if the worker isn't remote.", "type": "string" } }, "required": [ "type", "work_location_id" ], "title": "WorkerLocation", "type": "object" }, "manager": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's manager.\n\nExpandable field", "type": "object" }, "manager_id": { "description": "The worker's manager.", "type": "string" }, "number": { "anyOf": [ { "description": "The worker's number within the organization.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "original_start_date": { "description": "The worker's earliest start date across their employment history, excluding INIT roles.", "type": "string" }, "overtime_exemption": { "description": "The worker's overtime exemption status.", "type": "string" }, "pay_schedule_id": { "description": "The ID of the pay schedule currently associated with the worker.", "type": "string" }, "personal_email": { "description": "The worker's associated personal email address.", "type": "string" }, "race": { "description": "The identified race of the worker, if specified.", "type": "string" }, "start_date": { "description": "The start date of the worker.", "type": "string" }, "status": { "description": "The worker's status within the organization.", "type": "string" }, "teams": { "description": "The worker's assigned teams.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiTeamcb26bc28f32f" }, "type": "array" }, "teams_id": { "description": "The worker's assigned teams.", "items": { "type": "string" }, "type": "array" }, "termination_details": { "description": "The details of the worker's termination, if applicable.", "properties": { "reason": { "description": "This is a description that will be custom to each Rippling company.", "type": "string" }, "type": { "description": "The termination type indicates whether the termination was voluntary or involuntary.", "type": "string" } }, "title": "TerminationDetails", "type": "object" }, "title": { "description": "The worker's title.", "type": "string" }, "title_effective_date": { "description": "Title effective date", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "user": { "description": "The worker's associated user.\n\nExpandable field", "properties": { "active": { "description": "Whether the user is able to access company resources, typically when they are in actively engaged with the company and not after off-boarding.", "type": "boolean" }, "addresses": { "description": "The user's addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiUserAddressedd59b9ba9a1" }, "type": "array" }, "created_at": { "description": "Record creation date", "type": "string" }, "display_name": { "description": "The display name of the user using either the concatenated preferred given and family name or username depending on availability.", "type": "string" }, "emails": { "description": "The user's email addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiEmail5284c8258dc3" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "locale": { "description": "The User's default location for purposes of localization of currency, date time format, or numerical representations pursuant to RFC5646.", "type": "string" }, "name": { "description": "The user's name.", "properties": { "family_name": { "description": "The legal family name of the user, or last name in most Western languages.", "type": "string" }, "formatted": { "description": "The user's full name.", "type": "string" }, "given_name": { "description": "The given legal name of the user, or first name in most Western languages.", "type": "string" }, "middle_name": { "description": "The middle name(s) of the user.", "type": "string" }, "preferred_family_name": { "description": "The preferred family name, or last name in most Western languages, by the user.", "type": "string" }, "preferred_given_name": { "description": "The preferred given name, or first name in most Western languages, by the user.", "type": "string" } }, "title": "UserName", "type": "object" }, "number": { "description": "The permanent profile number of the user.", "type": "string" }, "phone_numbers": { "description": "The user's phone numbers.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoneNumber12060c61ecf5" }, "type": "array" }, "photos": { "description": "The user's photos.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoto2be7c3ae3f39" }, "type": "array" }, "preferred_language": { "description": "The User's preferred written or spoken language in the same format of the HTTP Accept-Language header, pursuant to Section 5.3.5 of RFC7231.", "type": "string" }, "timezone": { "description": "The User's current time zone in IANA database Olson format", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "username": { "description": "The unique identifier across Rippling used by the User for direct authentication into their associated company. Globally unique.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "User", "type": "object" }, "user_id": { "description": "The worker's associated user.", "type": "string" }, "work_email": { "description": "The worker's associated work email address.", "type": "string" }, "work_schedule": { "additionalProperties": { "$ref": "#/components/schemas/OutputRestApiWorkScheduleDay938f88d94f20" }, "description": "The worker's scheduled working hours for each day of the week.", "type": "object" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Worker", "type": "object" }, "default_business_partner_id": { "description": "Id of Optional default business partner worker to whom all employees will be mapped if not explicitly mapped to a business partner in the group.", "type": "string" }, "domain": { "description": "Type of business partner group", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "Name used to identify business partner group", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "BusinessPartnerGroup", "type": "object" }, "business_partner_group_id": { "description": "Identifier of business partner group the business parter is a part of", "type": "string" }, "client_group": { "description": "Group of workers associated with the business partner\n\nExpandable field", "properties": { "allow_non_employees": { "description": "Whether the group allows non employees", "type": "boolean" }, "app_owner_id": { "description": "The id of the group's app owner.", "type": "string" }, "can_override_role_states": { "description": "Whether the group can override role states", "type": "boolean" }, "created_at": { "description": "Record creation date", "type": "string" }, "cumulatively_exhaustive_default": { "description": "Whether the group is the cumulatively exhaustive default", "type": "boolean" }, "description": { "description": "The group's description.", "type": "string" }, "display_name": { "description": "The group's display name.", "type": "string" }, "group_type": { "description": "The group type", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "ignore_prov_group_matching": { "description": "Whether to ignore provisioning group matching when determining group membership", "type": "boolean" }, "include_terminated": { "description": "Whether the group include terminated roles", "type": "boolean" }, "is_invisible": { "description": "Whether the group is invisible", "type": "boolean" }, "mutually_exclusive_key": { "description": "The group's mutually exclusive key", "type": "string" }, "name": { "description": "The group's name.", "type": "string" }, "parent": { "description": "The group's parent.", "type": "string" }, "priority": { "anyOf": [ { "description": "The group's priority when calculating mutual exclusivity", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "read_only": { "description": "Whether the group is read only.", "type": "boolean" }, "sub_group_type": { "description": "The sub group type", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Supergroup", "type": "object" }, "client_group_id": { "description": "Identifier of group of workers associated with the business partner", "type": "string" }, "client_group_member_count": { "anyOf": [ { "description": "Number of workers associated with the business partner", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "worker": { "description": "Worker who is the business partner\n\nExpandable field", "properties": { "business_partners": { "description": "Worker's assigned business partners. This field is only populated when explicitly requested via the expand parameter (e.g., ?expand=business_partners). When expanded, returns an empty list ([]) if the worker has no business partners.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestBusinessPartner" }, "type": "array" }, "business_partners_id": { "description": "Worker's assigned business partners unique identifiers. Returns an empty list ([]) if the worker has no business partners.", "items": { "type": "string" }, "type": "array" }, "citizenship": { "description": "The countries that the worker has citizenship in.", "type": "string" }, "compensation": { "description": "The compensation package for the worker.\n\nExpandable field", "properties": { "annual_compensation": { "description": "The worker's annual compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "annual_salary_equivalent": { "description": "The worker's annual salary equivalent, for insurance purposes. It will be equal to the worker's annual compensation, except for owners that are receiving no cashcompensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "bonus_schedule": { "description": "The worker's bonus schedule.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "hourly_wage": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "id": { "description": "Identifier field", "type": "string" }, "monthly_compensation": { "description": "The worker's monthly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "on_target_commission": { "description": "The worker's on-target commission.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "payment_terms": { "description": "The payment terms for an worker's compensation.", "type": "string" }, "payment_type": { "description": "The payment type for an worker's compensation.", "type": "string" }, "relocation_reimbursement": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "salary_effective_date": { "description": "Salary effective date", "type": "string" }, "signing_bonus": { "description": "The worker's signing bonus.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus": { "description": "The worker's target annual bonus amount.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus_percent": { "anyOf": [ { "description": "The worker's target annual bonus as a percent of annual compensation.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" }, "weekly_compensation": { "description": "The worker's weekly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "worker": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's details.\n\nExpandable field", "type": "object" }, "worker_id": { "description": "The worker's ID.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Compensation", "type": "object" }, "compensation_grade": { "description": "The compensation grade assigned to the worker, if any.", "properties": { "id": { "description": "The compensation grade's unique identifier.", "type": "string" }, "label": { "description": "The compensation grade's label.", "type": "string" } }, "title": "WorkerCompensationGrade", "type": "object" }, "compensation_id": { "description": "The compensation package for the worker.", "type": "string" }, "country": { "description": "The worker's country.", "type": "string" }, "country_fields": { "description": "Country level fields for the worker.", "properties": { "ca": { "description": "Country-wise regional fields for Canada", "properties": { "sin": { "description": "Social Insurance Number (SIN) for Canada employees.", "type": "string" } }, "title": "CanadaFields", "type": "object" }, "nz": { "description": "Country-wise regional fields for New Zealand", "properties": { "ird_number": { "description": "Inland Revenue Department (IRD) number for New Zealand employees.", "type": "string" } }, "title": "NewZealandFields", "type": "object" }, "us": { "description": "Country-wise regional fields for USA", "properties": { "ssn": { "description": "Social Security Number (SSN) for US employees.", "type": "string" } }, "title": "USFields", "type": "object" } }, "title": "CountryFields", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "custom_fields": { "description": "Custom field values defined on the Employee object for this worker\n\nExpandable field", "items": { "additionalProperties": {} }, "type": "array" }, "date_of_birth": { "description": "The worker's date of birth.", "type": "string" }, "department": { "description": "The worker's assigned department.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "department_hierarchy": { "description": "List of departments in the department hierarchy. Refer department_hierarchy_ids for department hierarchy order.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestDepartment" }, "type": "array" }, "department_hierarchy_id": { "description": "The identifier of departments in the department hierarchy ordered from parent department to child department.", "items": { "type": "string" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the department.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestDepartment", "description": "The parent department.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent department.", "type": "string" }, "reference_code": { "description": "Reference code of the department.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Department", "type": "object" }, "department_id": { "description": "The worker's assigned department.", "type": "string" }, "employment_type": { "description": "The worker's employment type.\n\nExpandable field", "properties": { "amount_worked": { "description": "The amount worked for the employment type. * `FULL-TIME`: Full-time is at least 30 hours per week. Full-time workers will typically be eligible for benefits. * `PART-TIME`: Part-time is less than 30 hours per week. These workers may be eligible for benefits, depending on company settings and hours worked. * `TEMPORARY`: These workers are hired on a temporary basis. You can specify how each worker with this employment type will be paid individually.", "type": "string" }, "compensation_time_period": { "description": "The compensation period for the employment type. * `SALARIED`: Employees that are paid a fixed amount per year. * `HOURLY`: Employees that are paid a wage per hour worked.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "label": { "description": "The display label of the employment type.", "type": "string" }, "name": { "description": "The name of the employment type for non-custom employment types.", "type": "string" }, "type": { "description": "The classification of the worker by the company. * `CONTRACTOR`: Contractors are self-employed workers who provide services on a short-term or per-project basis and are not eligible for tax-withholding or benefits. * `EMPLOYEE`: Employees are hired and managed by an employer, work under the employer's direct supervision and control, and are protected by law for wages and employment rights.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "label", "updated_at" ], "title": "CompanyEmploymentType", "type": "object" }, "employment_type_id": { "description": "The worker's employment type.", "type": "string" }, "end_date": { "description": "The end date of the worker.", "type": "string" }, "ethnicity": { "description": "The identified ethnicity of the worker, if specified.", "type": "string" }, "gender": { "description": "The gender of the worker, if specified.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_manager": { "description": "Whether the worker is a manager", "type": "boolean" }, "job_function": { "description": "The worker's job function. When expanded, this field requires `job-functions.read`.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "Displayed name of the job function", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "JobFunction", "type": "object" }, "job_function_id": { "description": "ID of the worker's job function.", "type": "string" }, "legal_entity": { "description": "The worker's associated legal entity.\n\nExpandable field", "properties": { "company": { "description": "The company or organization associated with the legal entity\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "doing_business_as_name": { "description": "The doing business as name for the company.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_entities": { "description": "A list of the company's entities.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestLegalEntity" }, "type": "array" }, "legal_entities_id": { "description": "A list of the company's entities.", "items": { "type": "string" }, "type": "array" }, "legal_name": { "description": "The legal name of the company.", "type": "string" }, "name": { "description": "The name of the company.", "type": "string" }, "parent_legal_entity": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The company's ultimate holding entity.\n\nExpandable field", "type": "object" }, "parent_legal_entity_id": { "description": "The company's ultimate holding entity.", "type": "string" }, "phone": { "description": "The phone number for the company.", "type": "string" }, "physical_address": { "description": "The physical address of the holding entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "primary_email": { "description": "The email address used when registering this company.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "legal_entities", "legal_entities_id", "name", "updated_at" ], "title": "Company", "type": "object" }, "company_id": { "description": "The company or organization associated with the legal entity", "type": "string" }, "country": { "description": "The country the legal entity is based in.", "properties": { "code": { "description": "The code of the country.", "type": "string" } }, "required": [ "code" ], "title": "Country", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "entity_level": { "description": "The legal entity's level in a hierarchy. * `PARENT`: The legal entity is considered the ultimate holding entity. * `SUBSIDIARY`: The legal entity is considered a subsidiary, fully or partially held by another. * `BRANCH`: The legal entity is considered a branch, associated with a parent legal entity.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_name": { "description": "The legal name of the legal entity.", "type": "string" }, "mailing_address": { "description": "The mailing address of the legal entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "management_type": { "description": "The legal entity management type in the case of an employer of record (EOR) or professional employment organization (PEO). * `PEO`: The legal entity is considered a Professional Employment Organization (PEO). * `EOR`: The legal entity is considered an Employer of Record (EOR).", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The parent legal entity.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent legal entity.", "type": "string" }, "physical_address": { "description": "The physical address of the legal entity, if it differs from the mailing address.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "registration_date": { "description": "The registration date of the entity.", "type": "string" }, "tax_identifier": { "description": "The tax identifier for the legal entity.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "LegalEntity", "type": "object" }, "legal_entity_id": { "description": "The worker's associated legal entity.", "type": "string" }, "level": { "description": "The level of the worker.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "description": { "description": "The description of the level.", "type": "string" }, "experience_requirements": { "description": "The experience requirements for the level.", "type": "string" }, "global_level": { "anyOf": [ { "description": "Global level is used to track the seniority of levels. The higher up a level is placed on the page, the more senior and higher-ranked the level. Global level is used in workflows, policies, and reports that use the level attribute (e.g., you can use Level Lookup to set up a workflow that notifies the nearest person in an worker's management chain at or above the specified level).", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the level. Must be unique within the company or organization.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLevel", "description": "The parent level.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent level.", "type": "string" }, "rank": { "anyOf": [ { "description": "The rank of the level within its track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "scope_of_responsibilities": { "description": "The scope of responsibilities for the level.", "type": "string" }, "track": { "description": "The track associated with the level, if it's not a global level.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_default": { "description": "Whether this is the company's default track.", "type": "boolean" }, "name": { "description": "The name of the track. Must be unique within the company or organization.", "type": "string" }, "order": { "anyOf": [ { "description": "The one-based horizontal display order of the track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "start_global_level": { "anyOf": [ { "description": "The highest global level occupied by this track. Empty tracks return null.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Track", "type": "object" }, "track_id": { "description": "The track associated with the level. Required during creation. Include global_level when changing it.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Level", "type": "object" }, "level_id": { "description": "The level of the worker.", "type": "string" }, "location": { "description": "The location that the worker is mapped to for tax purposes. In the case that a worker is remote, the location's type is remote.", "properties": { "type": { "description": "The type of location.", "type": "string" }, "work_location_id": { "description": "The work location, if the worker isn't remote.", "type": "string" } }, "required": [ "type", "work_location_id" ], "title": "WorkerLocation", "type": "object" }, "manager": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's manager.\n\nExpandable field", "type": "object" }, "manager_id": { "description": "The worker's manager.", "type": "string" }, "number": { "anyOf": [ { "description": "The worker's number within the organization.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "original_start_date": { "description": "The worker's earliest start date across their employment history, excluding INIT roles.", "type": "string" }, "overtime_exemption": { "description": "The worker's overtime exemption status.", "type": "string" }, "pay_schedule_id": { "description": "The ID of the pay schedule currently associated with the worker.", "type": "string" }, "personal_email": { "description": "The worker's associated personal email address.", "type": "string" }, "race": { "description": "The identified race of the worker, if specified.", "type": "string" }, "start_date": { "description": "The start date of the worker.", "type": "string" }, "status": { "description": "The worker's status within the organization.", "type": "string" }, "teams": { "description": "The worker's assigned teams.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiTeamcb26bc28f32f" }, "type": "array" }, "teams_id": { "description": "The worker's assigned teams.", "items": { "type": "string" }, "type": "array" }, "termination_details": { "description": "The details of the worker's termination, if applicable.", "properties": { "reason": { "description": "This is a description that will be custom to each Rippling company.", "type": "string" }, "type": { "description": "The termination type indicates whether the termination was voluntary or involuntary.", "type": "string" } }, "title": "TerminationDetails", "type": "object" }, "title": { "description": "The worker's title.", "type": "string" }, "title_effective_date": { "description": "Title effective date", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "user": { "description": "The worker's associated user.\n\nExpandable field", "properties": { "active": { "description": "Whether the user is able to access company resources, typically when they are in actively engaged with the company and not after off-boarding.", "type": "boolean" }, "addresses": { "description": "The user's addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiUserAddressedd59b9ba9a1" }, "type": "array" }, "created_at": { "description": "Record creation date", "type": "string" }, "display_name": { "description": "The display name of the user using either the concatenated preferred given and family name or username depending on availability.", "type": "string" }, "emails": { "description": "The user's email addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiEmail5284c8258dc3" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "locale": { "description": "The User's default location for purposes of localization of currency, date time format, or numerical representations pursuant to RFC5646.", "type": "string" }, "name": { "description": "The user's name.", "properties": { "family_name": { "description": "The legal family name of the user, or last name in most Western languages.", "type": "string" }, "formatted": { "description": "The user's full name.", "type": "string" }, "given_name": { "description": "The given legal name of the user, or first name in most Western languages.", "type": "string" }, "middle_name": { "description": "The middle name(s) of the user.", "type": "string" }, "preferred_family_name": { "description": "The preferred family name, or last name in most Western languages, by the user.", "type": "string" }, "preferred_given_name": { "description": "The preferred given name, or first name in most Western languages, by the user.", "type": "string" } }, "title": "UserName", "type": "object" }, "number": { "description": "The permanent profile number of the user.", "type": "string" }, "phone_numbers": { "description": "The user's phone numbers.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoneNumber12060c61ecf5" }, "type": "array" }, "photos": { "description": "The user's photos.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoto2be7c3ae3f39" }, "type": "array" }, "preferred_language": { "description": "The User's preferred written or spoken language in the same format of the HTTP Accept-Language header, pursuant to Section 5.3.5 of RFC7231.", "type": "string" }, "timezone": { "description": "The User's current time zone in IANA database Olson format", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "username": { "description": "The unique identifier across Rippling used by the User for direct authentication into their associated company. Globally unique.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "User", "type": "object" }, "user_id": { "description": "The worker's associated user.", "type": "string" }, "work_email": { "description": "The worker's associated work email address.", "type": "string" }, "work_schedule": { "additionalProperties": { "$ref": "#/components/schemas/OutputRestApiWorkScheduleDay938f88d94f20" }, "description": "The worker's scheduled working hours for each day of the week.", "type": "object" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Worker", "type": "object" }, "worker_id": { "description": "Identifier of worker who is the business partner", "type": "string" } }, "required": [ "business_partner_group_id", "created_at", "id", "updated_at", "worker_id" ], "title": "BusinessPartner", "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Create a new business partner", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "business-partners.read-write" ] } }, "/business-partners/{id}/": { "delete": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/delete-business-partners" }, "operationId": "rippling.rest_api.delete_business_partners", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "id", "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "204": { "description": "The resource was deleted successfully" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Delete a business partner", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "business-partners.read-write" ] }, "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/get-business-partners" }, "operationId": "rippling.rest_api.get_business_partners", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "id", "type": "string" } }, { "in": "query", "name": "expand", "required": false, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "__meta": { "properties": { "redacted_fields": { "items": { "$ref": "#/components/schemas/OutputRestApiRedactedField21788a25ef22" }, "type": "array" } }, "type": "object" }, "business_partner_group": { "description": "Business partner group the business partner is a part of\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "default_business_partner": { "description": "Optional default business partner worker to whom all employees will be mapped if not explicitly mapped to a business partner in the group.\n\nExpandable field", "properties": { "business_partners": { "description": "Worker's assigned business partners. This field is only populated when explicitly requested via the expand parameter (e.g., ?expand=business_partners). When expanded, returns an empty list ([]) if the worker has no business partners.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestBusinessPartner" }, "type": "array" }, "business_partners_id": { "description": "Worker's assigned business partners unique identifiers. Returns an empty list ([]) if the worker has no business partners.", "items": { "type": "string" }, "type": "array" }, "citizenship": { "description": "The countries that the worker has citizenship in.", "type": "string" }, "compensation": { "description": "The compensation package for the worker.\n\nExpandable field", "properties": { "annual_compensation": { "description": "The worker's annual compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "annual_salary_equivalent": { "description": "The worker's annual salary equivalent, for insurance purposes. It will be equal to the worker's annual compensation, except for owners that are receiving no cashcompensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "bonus_schedule": { "description": "The worker's bonus schedule.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "hourly_wage": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "id": { "description": "Identifier field", "type": "string" }, "monthly_compensation": { "description": "The worker's monthly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "on_target_commission": { "description": "The worker's on-target commission.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "payment_terms": { "description": "The payment terms for an worker's compensation.", "type": "string" }, "payment_type": { "description": "The payment type for an worker's compensation.", "type": "string" }, "relocation_reimbursement": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "salary_effective_date": { "description": "Salary effective date", "type": "string" }, "signing_bonus": { "description": "The worker's signing bonus.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus": { "description": "The worker's target annual bonus amount.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus_percent": { "anyOf": [ { "description": "The worker's target annual bonus as a percent of annual compensation.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" }, "weekly_compensation": { "description": "The worker's weekly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "worker": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's details.\n\nExpandable field", "type": "object" }, "worker_id": { "description": "The worker's ID.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Compensation", "type": "object" }, "compensation_grade": { "description": "The compensation grade assigned to the worker, if any.", "properties": { "id": { "description": "The compensation grade's unique identifier.", "type": "string" }, "label": { "description": "The compensation grade's label.", "type": "string" } }, "title": "WorkerCompensationGrade", "type": "object" }, "compensation_id": { "description": "The compensation package for the worker.", "type": "string" }, "country": { "description": "The worker's country.", "type": "string" }, "country_fields": { "description": "Country level fields for the worker.", "properties": { "ca": { "description": "Country-wise regional fields for Canada", "properties": { "sin": { "description": "Social Insurance Number (SIN) for Canada employees.", "type": "string" } }, "title": "CanadaFields", "type": "object" }, "nz": { "description": "Country-wise regional fields for New Zealand", "properties": { "ird_number": { "description": "Inland Revenue Department (IRD) number for New Zealand employees.", "type": "string" } }, "title": "NewZealandFields", "type": "object" }, "us": { "description": "Country-wise regional fields for USA", "properties": { "ssn": { "description": "Social Security Number (SSN) for US employees.", "type": "string" } }, "title": "USFields", "type": "object" } }, "title": "CountryFields", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "custom_fields": { "description": "Custom field values defined on the Employee object for this worker\n\nExpandable field", "items": { "additionalProperties": {} }, "type": "array" }, "date_of_birth": { "description": "The worker's date of birth.", "type": "string" }, "department": { "description": "The worker's assigned department.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "department_hierarchy": { "description": "List of departments in the department hierarchy. Refer department_hierarchy_ids for department hierarchy order.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestDepartment" }, "type": "array" }, "department_hierarchy_id": { "description": "The identifier of departments in the department hierarchy ordered from parent department to child department.", "items": { "type": "string" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the department.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestDepartment", "description": "The parent department.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent department.", "type": "string" }, "reference_code": { "description": "Reference code of the department.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Department", "type": "object" }, "department_id": { "description": "The worker's assigned department.", "type": "string" }, "employment_type": { "description": "The worker's employment type.\n\nExpandable field", "properties": { "amount_worked": { "description": "The amount worked for the employment type. * `FULL-TIME`: Full-time is at least 30 hours per week. Full-time workers will typically be eligible for benefits. * `PART-TIME`: Part-time is less than 30 hours per week. These workers may be eligible for benefits, depending on company settings and hours worked. * `TEMPORARY`: These workers are hired on a temporary basis. You can specify how each worker with this employment type will be paid individually.", "type": "string" }, "compensation_time_period": { "description": "The compensation period for the employment type. * `SALARIED`: Employees that are paid a fixed amount per year. * `HOURLY`: Employees that are paid a wage per hour worked.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "label": { "description": "The display label of the employment type.", "type": "string" }, "name": { "description": "The name of the employment type for non-custom employment types.", "type": "string" }, "type": { "description": "The classification of the worker by the company. * `CONTRACTOR`: Contractors are self-employed workers who provide services on a short-term or per-project basis and are not eligible for tax-withholding or benefits. * `EMPLOYEE`: Employees are hired and managed by an employer, work under the employer's direct supervision and control, and are protected by law for wages and employment rights.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "label", "updated_at" ], "title": "CompanyEmploymentType", "type": "object" }, "employment_type_id": { "description": "The worker's employment type.", "type": "string" }, "end_date": { "description": "The end date of the worker.", "type": "string" }, "ethnicity": { "description": "The identified ethnicity of the worker, if specified.", "type": "string" }, "gender": { "description": "The gender of the worker, if specified.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_manager": { "description": "Whether the worker is a manager", "type": "boolean" }, "job_function": { "description": "The worker's job function. When expanded, this field requires `job-functions.read`.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "Displayed name of the job function", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "JobFunction", "type": "object" }, "job_function_id": { "description": "ID of the worker's job function.", "type": "string" }, "legal_entity": { "description": "The worker's associated legal entity.\n\nExpandable field", "properties": { "company": { "description": "The company or organization associated with the legal entity\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "doing_business_as_name": { "description": "The doing business as name for the company.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_entities": { "description": "A list of the company's entities.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestLegalEntity" }, "type": "array" }, "legal_entities_id": { "description": "A list of the company's entities.", "items": { "type": "string" }, "type": "array" }, "legal_name": { "description": "The legal name of the company.", "type": "string" }, "name": { "description": "The name of the company.", "type": "string" }, "parent_legal_entity": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The company's ultimate holding entity.\n\nExpandable field", "type": "object" }, "parent_legal_entity_id": { "description": "The company's ultimate holding entity.", "type": "string" }, "phone": { "description": "The phone number for the company.", "type": "string" }, "physical_address": { "description": "The physical address of the holding entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "primary_email": { "description": "The email address used when registering this company.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "legal_entities", "legal_entities_id", "name", "updated_at" ], "title": "Company", "type": "object" }, "company_id": { "description": "The company or organization associated with the legal entity", "type": "string" }, "country": { "description": "The country the legal entity is based in.", "properties": { "code": { "description": "The code of the country.", "type": "string" } }, "required": [ "code" ], "title": "Country", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "entity_level": { "description": "The legal entity's level in a hierarchy. * `PARENT`: The legal entity is considered the ultimate holding entity. * `SUBSIDIARY`: The legal entity is considered a subsidiary, fully or partially held by another. * `BRANCH`: The legal entity is considered a branch, associated with a parent legal entity.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_name": { "description": "The legal name of the legal entity.", "type": "string" }, "mailing_address": { "description": "The mailing address of the legal entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "management_type": { "description": "The legal entity management type in the case of an employer of record (EOR) or professional employment organization (PEO). * `PEO`: The legal entity is considered a Professional Employment Organization (PEO). * `EOR`: The legal entity is considered an Employer of Record (EOR).", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The parent legal entity.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent legal entity.", "type": "string" }, "physical_address": { "description": "The physical address of the legal entity, if it differs from the mailing address.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "registration_date": { "description": "The registration date of the entity.", "type": "string" }, "tax_identifier": { "description": "The tax identifier for the legal entity.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "LegalEntity", "type": "object" }, "legal_entity_id": { "description": "The worker's associated legal entity.", "type": "string" }, "level": { "description": "The level of the worker.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "description": { "description": "The description of the level.", "type": "string" }, "experience_requirements": { "description": "The experience requirements for the level.", "type": "string" }, "global_level": { "anyOf": [ { "description": "Global level is used to track the seniority of levels. The higher up a level is placed on the page, the more senior and higher-ranked the level. Global level is used in workflows, policies, and reports that use the level attribute (e.g., you can use Level Lookup to set up a workflow that notifies the nearest person in an worker's management chain at or above the specified level).", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the level. Must be unique within the company or organization.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLevel", "description": "The parent level.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent level.", "type": "string" }, "rank": { "anyOf": [ { "description": "The rank of the level within its track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "scope_of_responsibilities": { "description": "The scope of responsibilities for the level.", "type": "string" }, "track": { "description": "The track associated with the level, if it's not a global level.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_default": { "description": "Whether this is the company's default track.", "type": "boolean" }, "name": { "description": "The name of the track. Must be unique within the company or organization.", "type": "string" }, "order": { "anyOf": [ { "description": "The one-based horizontal display order of the track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "start_global_level": { "anyOf": [ { "description": "The highest global level occupied by this track. Empty tracks return null.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Track", "type": "object" }, "track_id": { "description": "The track associated with the level. Required during creation. Include global_level when changing it.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Level", "type": "object" }, "level_id": { "description": "The level of the worker.", "type": "string" }, "location": { "description": "The location that the worker is mapped to for tax purposes. In the case that a worker is remote, the location's type is remote.", "properties": { "type": { "description": "The type of location.", "type": "string" }, "work_location_id": { "description": "The work location, if the worker isn't remote.", "type": "string" } }, "required": [ "type", "work_location_id" ], "title": "WorkerLocation", "type": "object" }, "manager": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's manager.\n\nExpandable field", "type": "object" }, "manager_id": { "description": "The worker's manager.", "type": "string" }, "number": { "anyOf": [ { "description": "The worker's number within the organization.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "original_start_date": { "description": "The worker's earliest start date across their employment history, excluding INIT roles.", "type": "string" }, "overtime_exemption": { "description": "The worker's overtime exemption status.", "type": "string" }, "pay_schedule_id": { "description": "The ID of the pay schedule currently associated with the worker.", "type": "string" }, "personal_email": { "description": "The worker's associated personal email address.", "type": "string" }, "race": { "description": "The identified race of the worker, if specified.", "type": "string" }, "start_date": { "description": "The start date of the worker.", "type": "string" }, "status": { "description": "The worker's status within the organization.", "type": "string" }, "teams": { "description": "The worker's assigned teams.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiTeamcb26bc28f32f" }, "type": "array" }, "teams_id": { "description": "The worker's assigned teams.", "items": { "type": "string" }, "type": "array" }, "termination_details": { "description": "The details of the worker's termination, if applicable.", "properties": { "reason": { "description": "This is a description that will be custom to each Rippling company.", "type": "string" }, "type": { "description": "The termination type indicates whether the termination was voluntary or involuntary.", "type": "string" } }, "title": "TerminationDetails", "type": "object" }, "title": { "description": "The worker's title.", "type": "string" }, "title_effective_date": { "description": "Title effective date", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "user": { "description": "The worker's associated user.\n\nExpandable field", "properties": { "active": { "description": "Whether the user is able to access company resources, typically when they are in actively engaged with the company and not after off-boarding.", "type": "boolean" }, "addresses": { "description": "The user's addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiUserAddressedd59b9ba9a1" }, "type": "array" }, "created_at": { "description": "Record creation date", "type": "string" }, "display_name": { "description": "The display name of the user using either the concatenated preferred given and family name or username depending on availability.", "type": "string" }, "emails": { "description": "The user's email addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiEmail5284c8258dc3" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "locale": { "description": "The User's default location for purposes of localization of currency, date time format, or numerical representations pursuant to RFC5646.", "type": "string" }, "name": { "description": "The user's name.", "properties": { "family_name": { "description": "The legal family name of the user, or last name in most Western languages.", "type": "string" }, "formatted": { "description": "The user's full name.", "type": "string" }, "given_name": { "description": "The given legal name of the user, or first name in most Western languages.", "type": "string" }, "middle_name": { "description": "The middle name(s) of the user.", "type": "string" }, "preferred_family_name": { "description": "The preferred family name, or last name in most Western languages, by the user.", "type": "string" }, "preferred_given_name": { "description": "The preferred given name, or first name in most Western languages, by the user.", "type": "string" } }, "title": "UserName", "type": "object" }, "number": { "description": "The permanent profile number of the user.", "type": "string" }, "phone_numbers": { "description": "The user's phone numbers.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoneNumber12060c61ecf5" }, "type": "array" }, "photos": { "description": "The user's photos.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoto2be7c3ae3f39" }, "type": "array" }, "preferred_language": { "description": "The User's preferred written or spoken language in the same format of the HTTP Accept-Language header, pursuant to Section 5.3.5 of RFC7231.", "type": "string" }, "timezone": { "description": "The User's current time zone in IANA database Olson format", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "username": { "description": "The unique identifier across Rippling used by the User for direct authentication into their associated company. Globally unique.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "User", "type": "object" }, "user_id": { "description": "The worker's associated user.", "type": "string" }, "work_email": { "description": "The worker's associated work email address.", "type": "string" }, "work_schedule": { "additionalProperties": { "$ref": "#/components/schemas/OutputRestApiWorkScheduleDay938f88d94f20" }, "description": "The worker's scheduled working hours for each day of the week.", "type": "object" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Worker", "type": "object" }, "default_business_partner_id": { "description": "Id of Optional default business partner worker to whom all employees will be mapped if not explicitly mapped to a business partner in the group.", "type": "string" }, "domain": { "description": "Type of business partner group", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "Name used to identify business partner group", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "BusinessPartnerGroup", "type": "object" }, "business_partner_group_id": { "description": "Identifier of business partner group the business parter is a part of", "type": "string" }, "client_group": { "description": "Group of workers associated with the business partner\n\nExpandable field", "properties": { "allow_non_employees": { "description": "Whether the group allows non employees", "type": "boolean" }, "app_owner_id": { "description": "The id of the group's app owner.", "type": "string" }, "can_override_role_states": { "description": "Whether the group can override role states", "type": "boolean" }, "created_at": { "description": "Record creation date", "type": "string" }, "cumulatively_exhaustive_default": { "description": "Whether the group is the cumulatively exhaustive default", "type": "boolean" }, "description": { "description": "The group's description.", "type": "string" }, "display_name": { "description": "The group's display name.", "type": "string" }, "group_type": { "description": "The group type", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "ignore_prov_group_matching": { "description": "Whether to ignore provisioning group matching when determining group membership", "type": "boolean" }, "include_terminated": { "description": "Whether the group include terminated roles", "type": "boolean" }, "is_invisible": { "description": "Whether the group is invisible", "type": "boolean" }, "mutually_exclusive_key": { "description": "The group's mutually exclusive key", "type": "string" }, "name": { "description": "The group's name.", "type": "string" }, "parent": { "description": "The group's parent.", "type": "string" }, "priority": { "anyOf": [ { "description": "The group's priority when calculating mutual exclusivity", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "read_only": { "description": "Whether the group is read only.", "type": "boolean" }, "sub_group_type": { "description": "The sub group type", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Supergroup", "type": "object" }, "client_group_id": { "description": "Identifier of group of workers associated with the business partner", "type": "string" }, "client_group_member_count": { "anyOf": [ { "description": "Number of workers associated with the business partner", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "worker": { "description": "Worker who is the business partner\n\nExpandable field", "properties": { "business_partners": { "description": "Worker's assigned business partners. This field is only populated when explicitly requested via the expand parameter (e.g., ?expand=business_partners). When expanded, returns an empty list ([]) if the worker has no business partners.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestBusinessPartner" }, "type": "array" }, "business_partners_id": { "description": "Worker's assigned business partners unique identifiers. Returns an empty list ([]) if the worker has no business partners.", "items": { "type": "string" }, "type": "array" }, "citizenship": { "description": "The countries that the worker has citizenship in.", "type": "string" }, "compensation": { "description": "The compensation package for the worker.\n\nExpandable field", "properties": { "annual_compensation": { "description": "The worker's annual compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "annual_salary_equivalent": { "description": "The worker's annual salary equivalent, for insurance purposes. It will be equal to the worker's annual compensation, except for owners that are receiving no cashcompensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "bonus_schedule": { "description": "The worker's bonus schedule.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "hourly_wage": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "id": { "description": "Identifier field", "type": "string" }, "monthly_compensation": { "description": "The worker's monthly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "on_target_commission": { "description": "The worker's on-target commission.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "payment_terms": { "description": "The payment terms for an worker's compensation.", "type": "string" }, "payment_type": { "description": "The payment type for an worker's compensation.", "type": "string" }, "relocation_reimbursement": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "salary_effective_date": { "description": "Salary effective date", "type": "string" }, "signing_bonus": { "description": "The worker's signing bonus.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus": { "description": "The worker's target annual bonus amount.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus_percent": { "anyOf": [ { "description": "The worker's target annual bonus as a percent of annual compensation.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" }, "weekly_compensation": { "description": "The worker's weekly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "worker": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's details.\n\nExpandable field", "type": "object" }, "worker_id": { "description": "The worker's ID.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Compensation", "type": "object" }, "compensation_grade": { "description": "The compensation grade assigned to the worker, if any.", "properties": { "id": { "description": "The compensation grade's unique identifier.", "type": "string" }, "label": { "description": "The compensation grade's label.", "type": "string" } }, "title": "WorkerCompensationGrade", "type": "object" }, "compensation_id": { "description": "The compensation package for the worker.", "type": "string" }, "country": { "description": "The worker's country.", "type": "string" }, "country_fields": { "description": "Country level fields for the worker.", "properties": { "ca": { "description": "Country-wise regional fields for Canada", "properties": { "sin": { "description": "Social Insurance Number (SIN) for Canada employees.", "type": "string" } }, "title": "CanadaFields", "type": "object" }, "nz": { "description": "Country-wise regional fields for New Zealand", "properties": { "ird_number": { "description": "Inland Revenue Department (IRD) number for New Zealand employees.", "type": "string" } }, "title": "NewZealandFields", "type": "object" }, "us": { "description": "Country-wise regional fields for USA", "properties": { "ssn": { "description": "Social Security Number (SSN) for US employees.", "type": "string" } }, "title": "USFields", "type": "object" } }, "title": "CountryFields", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "custom_fields": { "description": "Custom field values defined on the Employee object for this worker\n\nExpandable field", "items": { "additionalProperties": {} }, "type": "array" }, "date_of_birth": { "description": "The worker's date of birth.", "type": "string" }, "department": { "description": "The worker's assigned department.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "department_hierarchy": { "description": "List of departments in the department hierarchy. Refer department_hierarchy_ids for department hierarchy order.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestDepartment" }, "type": "array" }, "department_hierarchy_id": { "description": "The identifier of departments in the department hierarchy ordered from parent department to child department.", "items": { "type": "string" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the department.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestDepartment", "description": "The parent department.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent department.", "type": "string" }, "reference_code": { "description": "Reference code of the department.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Department", "type": "object" }, "department_id": { "description": "The worker's assigned department.", "type": "string" }, "employment_type": { "description": "The worker's employment type.\n\nExpandable field", "properties": { "amount_worked": { "description": "The amount worked for the employment type. * `FULL-TIME`: Full-time is at least 30 hours per week. Full-time workers will typically be eligible for benefits. * `PART-TIME`: Part-time is less than 30 hours per week. These workers may be eligible for benefits, depending on company settings and hours worked. * `TEMPORARY`: These workers are hired on a temporary basis. You can specify how each worker with this employment type will be paid individually.", "type": "string" }, "compensation_time_period": { "description": "The compensation period for the employment type. * `SALARIED`: Employees that are paid a fixed amount per year. * `HOURLY`: Employees that are paid a wage per hour worked.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "label": { "description": "The display label of the employment type.", "type": "string" }, "name": { "description": "The name of the employment type for non-custom employment types.", "type": "string" }, "type": { "description": "The classification of the worker by the company. * `CONTRACTOR`: Contractors are self-employed workers who provide services on a short-term or per-project basis and are not eligible for tax-withholding or benefits. * `EMPLOYEE`: Employees are hired and managed by an employer, work under the employer's direct supervision and control, and are protected by law for wages and employment rights.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "label", "updated_at" ], "title": "CompanyEmploymentType", "type": "object" }, "employment_type_id": { "description": "The worker's employment type.", "type": "string" }, "end_date": { "description": "The end date of the worker.", "type": "string" }, "ethnicity": { "description": "The identified ethnicity of the worker, if specified.", "type": "string" }, "gender": { "description": "The gender of the worker, if specified.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_manager": { "description": "Whether the worker is a manager", "type": "boolean" }, "job_function": { "description": "The worker's job function. When expanded, this field requires `job-functions.read`.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "Displayed name of the job function", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "JobFunction", "type": "object" }, "job_function_id": { "description": "ID of the worker's job function.", "type": "string" }, "legal_entity": { "description": "The worker's associated legal entity.\n\nExpandable field", "properties": { "company": { "description": "The company or organization associated with the legal entity\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "doing_business_as_name": { "description": "The doing business as name for the company.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_entities": { "description": "A list of the company's entities.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestLegalEntity" }, "type": "array" }, "legal_entities_id": { "description": "A list of the company's entities.", "items": { "type": "string" }, "type": "array" }, "legal_name": { "description": "The legal name of the company.", "type": "string" }, "name": { "description": "The name of the company.", "type": "string" }, "parent_legal_entity": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The company's ultimate holding entity.\n\nExpandable field", "type": "object" }, "parent_legal_entity_id": { "description": "The company's ultimate holding entity.", "type": "string" }, "phone": { "description": "The phone number for the company.", "type": "string" }, "physical_address": { "description": "The physical address of the holding entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "primary_email": { "description": "The email address used when registering this company.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "legal_entities", "legal_entities_id", "name", "updated_at" ], "title": "Company", "type": "object" }, "company_id": { "description": "The company or organization associated with the legal entity", "type": "string" }, "country": { "description": "The country the legal entity is based in.", "properties": { "code": { "description": "The code of the country.", "type": "string" } }, "required": [ "code" ], "title": "Country", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "entity_level": { "description": "The legal entity's level in a hierarchy. * `PARENT`: The legal entity is considered the ultimate holding entity. * `SUBSIDIARY`: The legal entity is considered a subsidiary, fully or partially held by another. * `BRANCH`: The legal entity is considered a branch, associated with a parent legal entity.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_name": { "description": "The legal name of the legal entity.", "type": "string" }, "mailing_address": { "description": "The mailing address of the legal entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "management_type": { "description": "The legal entity management type in the case of an employer of record (EOR) or professional employment organization (PEO). * `PEO`: The legal entity is considered a Professional Employment Organization (PEO). * `EOR`: The legal entity is considered an Employer of Record (EOR).", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The parent legal entity.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent legal entity.", "type": "string" }, "physical_address": { "description": "The physical address of the legal entity, if it differs from the mailing address.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "registration_date": { "description": "The registration date of the entity.", "type": "string" }, "tax_identifier": { "description": "The tax identifier for the legal entity.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "LegalEntity", "type": "object" }, "legal_entity_id": { "description": "The worker's associated legal entity.", "type": "string" }, "level": { "description": "The level of the worker.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "description": { "description": "The description of the level.", "type": "string" }, "experience_requirements": { "description": "The experience requirements for the level.", "type": "string" }, "global_level": { "anyOf": [ { "description": "Global level is used to track the seniority of levels. The higher up a level is placed on the page, the more senior and higher-ranked the level. Global level is used in workflows, policies, and reports that use the level attribute (e.g., you can use Level Lookup to set up a workflow that notifies the nearest person in an worker's management chain at or above the specified level).", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the level. Must be unique within the company or organization.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLevel", "description": "The parent level.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent level.", "type": "string" }, "rank": { "anyOf": [ { "description": "The rank of the level within its track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "scope_of_responsibilities": { "description": "The scope of responsibilities for the level.", "type": "string" }, "track": { "description": "The track associated with the level, if it's not a global level.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_default": { "description": "Whether this is the company's default track.", "type": "boolean" }, "name": { "description": "The name of the track. Must be unique within the company or organization.", "type": "string" }, "order": { "anyOf": [ { "description": "The one-based horizontal display order of the track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "start_global_level": { "anyOf": [ { "description": "The highest global level occupied by this track. Empty tracks return null.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Track", "type": "object" }, "track_id": { "description": "The track associated with the level. Required during creation. Include global_level when changing it.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Level", "type": "object" }, "level_id": { "description": "The level of the worker.", "type": "string" }, "location": { "description": "The location that the worker is mapped to for tax purposes. In the case that a worker is remote, the location's type is remote.", "properties": { "type": { "description": "The type of location.", "type": "string" }, "work_location_id": { "description": "The work location, if the worker isn't remote.", "type": "string" } }, "required": [ "type", "work_location_id" ], "title": "WorkerLocation", "type": "object" }, "manager": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's manager.\n\nExpandable field", "type": "object" }, "manager_id": { "description": "The worker's manager.", "type": "string" }, "number": { "anyOf": [ { "description": "The worker's number within the organization.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "original_start_date": { "description": "The worker's earliest start date across their employment history, excluding INIT roles.", "type": "string" }, "overtime_exemption": { "description": "The worker's overtime exemption status.", "type": "string" }, "pay_schedule_id": { "description": "The ID of the pay schedule currently associated with the worker.", "type": "string" }, "personal_email": { "description": "The worker's associated personal email address.", "type": "string" }, "race": { "description": "The identified race of the worker, if specified.", "type": "string" }, "start_date": { "description": "The start date of the worker.", "type": "string" }, "status": { "description": "The worker's status within the organization.", "type": "string" }, "teams": { "description": "The worker's assigned teams.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiTeamcb26bc28f32f" }, "type": "array" }, "teams_id": { "description": "The worker's assigned teams.", "items": { "type": "string" }, "type": "array" }, "termination_details": { "description": "The details of the worker's termination, if applicable.", "properties": { "reason": { "description": "This is a description that will be custom to each Rippling company.", "type": "string" }, "type": { "description": "The termination type indicates whether the termination was voluntary or involuntary.", "type": "string" } }, "title": "TerminationDetails", "type": "object" }, "title": { "description": "The worker's title.", "type": "string" }, "title_effective_date": { "description": "Title effective date", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "user": { "description": "The worker's associated user.\n\nExpandable field", "properties": { "active": { "description": "Whether the user is able to access company resources, typically when they are in actively engaged with the company and not after off-boarding.", "type": "boolean" }, "addresses": { "description": "The user's addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiUserAddressedd59b9ba9a1" }, "type": "array" }, "created_at": { "description": "Record creation date", "type": "string" }, "display_name": { "description": "The display name of the user using either the concatenated preferred given and family name or username depending on availability.", "type": "string" }, "emails": { "description": "The user's email addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiEmail5284c8258dc3" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "locale": { "description": "The User's default location for purposes of localization of currency, date time format, or numerical representations pursuant to RFC5646.", "type": "string" }, "name": { "description": "The user's name.", "properties": { "family_name": { "description": "The legal family name of the user, or last name in most Western languages.", "type": "string" }, "formatted": { "description": "The user's full name.", "type": "string" }, "given_name": { "description": "The given legal name of the user, or first name in most Western languages.", "type": "string" }, "middle_name": { "description": "The middle name(s) of the user.", "type": "string" }, "preferred_family_name": { "description": "The preferred family name, or last name in most Western languages, by the user.", "type": "string" }, "preferred_given_name": { "description": "The preferred given name, or first name in most Western languages, by the user.", "type": "string" } }, "title": "UserName", "type": "object" }, "number": { "description": "The permanent profile number of the user.", "type": "string" }, "phone_numbers": { "description": "The user's phone numbers.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoneNumber12060c61ecf5" }, "type": "array" }, "photos": { "description": "The user's photos.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoto2be7c3ae3f39" }, "type": "array" }, "preferred_language": { "description": "The User's preferred written or spoken language in the same format of the HTTP Accept-Language header, pursuant to Section 5.3.5 of RFC7231.", "type": "string" }, "timezone": { "description": "The User's current time zone in IANA database Olson format", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "username": { "description": "The unique identifier across Rippling used by the User for direct authentication into their associated company. Globally unique.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "User", "type": "object" }, "user_id": { "description": "The worker's associated user.", "type": "string" }, "work_email": { "description": "The worker's associated work email address.", "type": "string" }, "work_schedule": { "additionalProperties": { "$ref": "#/components/schemas/OutputRestApiWorkScheduleDay938f88d94f20" }, "description": "The worker's scheduled working hours for each day of the week.", "type": "object" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Worker", "type": "object" }, "worker_id": { "description": "Identifier of worker who is the business partner", "type": "string" } }, "required": [ "business_partner_group_id", "created_at", "id", "updated_at", "worker_id" ], "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Retrieve a specific business partner", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "business-partners.read" ] } }, "/business-structure-paths/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/list-business-structure-paths" }, "operationId": "rippling.rest_api.list_business_structure_paths", "parameters": [ { "in": "query", "name": "expand", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 100, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "__meta": { "$ref": "#/components/schemas/OutputRestApiRedactedFields9f7657dc2a2f" }, "next_link": { "description": "A link to the next page of responses.", "format": "uri", "type": "string" }, "results": { "items": { "$ref": "#/components/schemas/OutputRestApiBusinessStructurePath9cd0fa37b4bd" }, "type": "array" } }, "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "List business-structure-paths", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "business-structure-paths.read" ] }, "post": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/create-business-structure-paths" }, "operationId": "rippling.rest_api.create_business_structure_paths", "parameters": [ { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiBusinessStructurePathRequest5cf088885bd3" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "job_codes": { "description": "Ordered list of full JobCode objects for each job in the path, top to bottom. Populate via ?expand=job_codes. Requires both business-structure-paths.read and job-codes.read scopes.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiJobCodeeda25ec6c9a8" }, "type": "array" }, "job_codes_id": { "description": "Ordered list of Job code IDs from top to bottom.", "items": { "type": "string" }, "type": "array" }, "name": { "description": "Name of the path (e.g. 'SF Office > Coffee > Barista').", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestBusinessStructurePath", "description": "The parent path.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "Id of the parent BusinessStructurePath. None for root path.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "BusinessStructurePath", "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Create a new business-structure-path", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "business-structure-paths.read-write" ] } }, "/business-structure-paths/{id}/": { "delete": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/delete-business-structure-paths" }, "operationId": "rippling.rest_api.delete_business_structure_paths", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "id", "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "204": { "description": "The resource was deleted successfully" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Delete a business-structure-path", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "business-structure-paths.read-write" ] }, "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/get-business-structure-paths" }, "operationId": "rippling.rest_api.get_business_structure_paths", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "id", "type": "string" } }, { "in": "query", "name": "expand", "required": false, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "__meta": { "properties": { "redacted_fields": { "items": { "$ref": "#/components/schemas/OutputRestApiRedactedField21788a25ef22" }, "type": "array" } }, "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "job_codes": { "description": "Ordered list of full JobCode objects for each job in the path, top to bottom. Populate via ?expand=job_codes. Requires both business-structure-paths.read and job-codes.read scopes.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiJobCodeeda25ec6c9a8" }, "type": "array" }, "job_codes_id": { "description": "Ordered list of Job code IDs from top to bottom.", "items": { "type": "string" }, "type": "array" }, "name": { "description": "Name of the path (e.g. 'SF Office > Coffee > Barista').", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestBusinessStructurePath", "description": "The parent path.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "Id of the parent BusinessStructurePath. None for root path.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Retrieve a specific business-structure-path", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "business-structure-paths.read" ] } }, "/candidate-applications/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/list-candidate-applications" }, "operationId": "rippling.rest_api.list_candidate_applications", "parameters": [ { "in": "query", "name": "expand", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "candidate_id", "required": true, "schema": { "format": "id", "type": "string" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 100, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "__meta": { "$ref": "#/components/schemas/OutputRestApiRedactedFields9f7657dc2a2f" }, "next_link": { "description": "A link to the next page of responses.", "format": "uri", "type": "string" }, "results": { "items": { "$ref": "#/components/schemas/OutputRestApiApplication37f1c9a97e1a" }, "type": "array" } }, "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "List candidate applications", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "candidate-applications.read" ] } }, "/candidates/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/list-candidates" }, "operationId": "rippling.rest_api.list_candidates", "parameters": [ { "in": "query", "name": "order_by", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 100, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "__meta": { "$ref": "#/components/schemas/OutputRestApiRedactedFields9f7657dc2a2f" }, "next_link": { "description": "A link to the next page of responses.", "format": "uri", "type": "string" }, "results": { "items": { "$ref": "#/components/schemas/OutputRestApiCandidatee9564ab26ba9" }, "type": "array" } }, "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "List candidates", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "candidates.read" ] } }, "/card-transactions/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/list-card-transactions" }, "operationId": "rippling.rest_api.list_card_transactions", "parameters": [ { "in": "query", "name": "filter", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 100, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "__meta": { "$ref": "#/components/schemas/OutputRestApiRedactedFields9f7657dc2a2f" }, "next_link": { "description": "A link to the next page of responses.", "format": "uri", "type": "string" }, "results": { "items": { "$ref": "#/components/schemas/OutputRestApiCardTransactiond05e14d0c745" }, "type": "array" } }, "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "List card transactions", "x-rippling-entitlements": [ "Internal_Testing" ], "x-rippling-required-scopes": [ "card-transactions.read" ] } }, "/card-transactions/{id}/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/get-card-transactions" }, "operationId": "rippling.rest_api.get_card_transactions", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "id", "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "__meta": { "properties": { "redacted_fields": { "items": { "$ref": "#/components/schemas/OutputRestApiRedactedField21788a25ef22" }, "type": "array" } }, "type": "object" }, "accounting_date": { "description": "Date the transaction is booked in the accounting system, as an ISO 8601 date (YYYY-MM-DD).", "type": "string" }, "approval_status": { "description": "Approval status of the transaction. `DRAFT`: not submitted for approval. `PENDING`: awaiting required information or submission before approval. `REQUESTED`: submitted and awaiting approval. `APPROVED`: approved. `REJECTED`: rejected. `FINALIZED`: finalized for payment. `ACTIONED`: payment or reimbursement completed. `CANCELLED`: cancelled. `FAILED`: payment failed. Null for card authorizations.", "type": "string" }, "attachments": { "description": "URLs of other attached files.", "items": { "type": "string" }, "type": "array" }, "authorization_state": { "description": "State of the card authorization. `PENDING`: an active hold awaiting completion. `CLOSED`: the authorization completed and the charge posted. `REVERSED`: the authorization was reversed and the hold released. `EXPIRED`: the hold expired without completion. Null for posted card transactions.", "type": "string" }, "card_id": { "description": "ID of the Spend card used. No public API is currently available to retrieve this card.", "type": "string" }, "company_amount": { "description": "Amount in the company's headquarters currency. The `value` is a decimal string.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "entity_id": { "description": "ID of the legal entity the transaction belongs to. Use it with `/company-legal-entities/{id}/`.", "type": "string" }, "gl_sync_state": { "description": "State of the sync to the accounting system. `NOT_FINALIZED`: not ready for accounting review. `FOR_REVIEW`: ready for accounting review. `PENDING_SYNC`: sync is in progress. `SYNCED`: synced to the accounting system. `ERROR`: sync failed. `DO_NOT_SYNC`: marked to be excluded from sync. `EXPORTED`: exported for accounting. `NOT_SYNCABLE`: this record cannot be synced. `AUTO_SYNC`: ready to be synced automatically. Null when no sync state is set.", "type": "string" }, "gl_vendor": { "description": "Vendor in the connected accounting system.", "properties": { "gl_vendor_id": { "description": "ID of the vendor in the accounting system.", "type": "string" }, "id": { "description": "ID of the accounting vendor in Rippling.", "type": "string" }, "name": { "description": "Name of the vendor in the accounting system.", "type": "string" } }, "title": "GLVendor", "type": "object" }, "id": { "description": "Identifier field", "type": "string" }, "line_items": { "description": "Category splits of the transaction amount.", "items": { "$ref": "#/components/schemas/OutputRestApiLineItem8d6adc67985a" }, "type": "array" }, "memo": { "description": "Memo entered on the transaction.", "type": "string" }, "merchant_amount": { "description": "Amount charged by the merchant, in the merchant currency. The `value` is a decimal string.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "receipt": { "description": "URL of the receipt file.", "type": "string" }, "transaction_date": { "description": "When the purchase or authorization happened, as an ISO 8601 date-time in UTC.", "type": "string" }, "transaction_type": { "description": "`CARD_TRANSACTION`: a posted card charge. `CARD_AUTHORIZATION`: a hold placed by the card network before the charge posts.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "vendor": { "description": "Vendor the purchase was made from.", "properties": { "id": { "description": "ID of the vendor.", "type": "string" }, "name": { "description": "Name of the vendor.", "type": "string" } }, "title": "Vendor", "type": "object" }, "worker_id": { "description": "ID of the worker who made the transaction. Use it with `/workers/{id}/`.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Retrieve a specific card transaction", "x-rippling-entitlements": [ "Internal_Testing" ], "x-rippling-required-scopes": [ "card-transactions.read" ] } }, "/companies/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/list-companies" }, "operationId": "rippling.rest_api.list_companies", "parameters": [ { "in": "query", "name": "expand", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 100, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "__meta": { "$ref": "#/components/schemas/OutputRestApiRedactedFields9f7657dc2a2f" }, "next_link": { "description": "A link to the next page of responses.", "format": "uri", "type": "string" }, "results": { "items": { "$ref": "#/components/schemas/OutputRestApiCompany17fa1ad76b50" }, "type": "array" } }, "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "List companies", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "companies.read" ] } }, "/company-legal-entities/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/list-company-legal-entities" }, "operationId": "rippling.rest_api.list_company_legal_entities", "parameters": [ { "in": "query", "name": "filter", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 100, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "__meta": { "$ref": "#/components/schemas/OutputRestApiRedactedFields9f7657dc2a2f" }, "next_link": { "description": "A link to the next page of responses.", "format": "uri", "type": "string" }, "results": { "items": { "$ref": "#/components/schemas/OutputRestApiCompanyLegalEntity6fca92c61d9a" }, "type": "array" } }, "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "List company legal entities", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "company-legal-entities.read" ] } }, "/company-legal-entities/{id}/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/get-company-legal-entities" }, "operationId": "rippling.rest_api.get_company_legal_entities", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "id", "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "__meta": { "properties": { "redacted_fields": { "items": { "$ref": "#/components/schemas/OutputRestApiRedactedField21788a25ef22" }, "type": "array" } }, "type": "object" }, "company_id": { "description": "The company associated with this entity relationship.", "type": "string" }, "country_code": { "description": "The ISO country code for the entity.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "entity_level": { "description": "The entity's level in a hierarchy. * `PARENT`: The legal entity is considered the ultimate holding entity. * `SUBSIDIARY`: The legal entity is considered a subsidiary, fully or partially held by another. * `BRANCH`: The legal entity is considered a branch, associated with a parent legal entity.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_archived": { "description": "True if this entity relationship has been archived.", "type": "boolean" }, "is_cor": { "description": "True if this entity is managed as a Contractor of Record.", "type": "boolean" }, "is_eor": { "description": "True if this entity is managed as an Employer of Record.", "type": "boolean" }, "is_peo": { "description": "True if this entity is managed as a Professional Employment Organization.", "type": "boolean" }, "legal_name": { "description": "The legal name of the entity.", "type": "string" }, "mailing_address": { "description": "The mailing address of the entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "management_type": { "description": "The entity management type. * `EOR`: The entity is managed as an Employer of Record. * `COR`: The entity is managed as a Contractor of Record. * `PEO`: The entity is managed as a Professional Employment Organization. * `null`: The entity is a direct hire with no managed employment type.", "type": "string" }, "physical_address": { "description": "The physical address of the entity, if it differs from the mailing address.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "registration_date": { "description": "The registration date of the entity.", "type": "string" }, "tax_identifier": { "description": "The tax identifier for this entity.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Retrieve a specific company legal entity", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "company-legal-entities.read" ] } }, "/company-legal-entity-workers/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/list-company-legal-entity-workers" }, "operationId": "rippling.rest_api.list_company_legal_entity_workers", "parameters": [ { "in": "query", "name": "filter", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 100, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "__meta": { "$ref": "#/components/schemas/OutputRestApiRedactedFields9f7657dc2a2f" }, "next_link": { "description": "A link to the next page of responses.", "format": "uri", "type": "string" }, "results": { "items": { "$ref": "#/components/schemas/OutputRestApiCompanyLegalEntityWorker8af1a3ed7249" }, "type": "array" } }, "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "List company-legal-entity-workers", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "company-legal-entity-workers.read" ] } }, "/company-legal-entity-workers/{id}/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/get-company-legal-entity-workers" }, "operationId": "rippling.rest_api.get_company_legal_entity_workers", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "id", "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "__meta": { "properties": { "redacted_fields": { "items": { "$ref": "#/components/schemas/OutputRestApiRedactedField21788a25ef22" }, "type": "array" } }, "type": "object" }, "company_entity_id": { "description": "The worker's associated company legal entity (CER ID).", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "status": { "description": "The worker's status within the organization.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Retrieve a specific company-legal-entity-worker", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "company-legal-entity-workers.read" ] } }, "/compensation-bands-details/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/list-compensation-bands-details" }, "operationId": "rippling.rest_api.list_compensation_bands_details", "parameters": [ { "in": "query", "name": "filter", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "expand", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 100, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "__meta": { "$ref": "#/components/schemas/OutputRestApiRedactedFields9f7657dc2a2f" }, "next_link": { "description": "A link to the next page of responses.", "format": "uri", "type": "string" }, "results": { "items": { "$ref": "#/components/schemas/OutputRestApiCompensationBandsDetails70f178fbc985" }, "type": "array" } }, "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "List compensation bands details", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "compensation-bands-details.read" ] } }, "/compensation-bands-details/{id}/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/get-compensation-bands-details" }, "operationId": "rippling.rest_api.get_compensation_bands_details", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "id", "type": "string" } }, { "in": "query", "name": "expand", "required": false, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "__meta": { "properties": { "redacted_fields": { "items": { "$ref": "#/components/schemas/OutputRestApiRedactedField21788a25ef22" }, "type": "array" } }, "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "internal_job_code": { "description": "Internal job code", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "worker": { "description": "The worker associated with compensation bands\n\nExpandable field", "properties": { "business_partners": { "description": "Worker's assigned business partners. This field is only populated when explicitly requested via the expand parameter (e.g., ?expand=business_partners). When expanded, returns an empty list ([]) if the worker has no business partners.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiBusinessPartner77b00a069c32" }, "type": "array" }, "business_partners_id": { "description": "Worker's assigned business partners unique identifiers. Returns an empty list ([]) if the worker has no business partners.", "items": { "type": "string" }, "type": "array" }, "citizenship": { "description": "The countries that the worker has citizenship in.", "type": "string" }, "compensation": { "description": "The compensation package for the worker.\n\nExpandable field", "properties": { "annual_compensation": { "description": "The worker's annual compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "annual_salary_equivalent": { "description": "The worker's annual salary equivalent, for insurance purposes. It will be equal to the worker's annual compensation, except for owners that are receiving no cashcompensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "bonus_schedule": { "description": "The worker's bonus schedule.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "hourly_wage": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "id": { "description": "Identifier field", "type": "string" }, "monthly_compensation": { "description": "The worker's monthly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "on_target_commission": { "description": "The worker's on-target commission.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "payment_terms": { "description": "The payment terms for an worker's compensation.", "type": "string" }, "payment_type": { "description": "The payment type for an worker's compensation.", "type": "string" }, "relocation_reimbursement": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "salary_effective_date": { "description": "Salary effective date", "type": "string" }, "signing_bonus": { "description": "The worker's signing bonus.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus": { "description": "The worker's target annual bonus amount.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus_percent": { "anyOf": [ { "description": "The worker's target annual bonus as a percent of annual compensation.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" }, "weekly_compensation": { "description": "The worker's weekly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "worker": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's details.\n\nExpandable field", "type": "object" }, "worker_id": { "description": "The worker's ID.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Compensation", "type": "object" }, "compensation_grade": { "description": "The compensation grade assigned to the worker, if any.", "properties": { "id": { "description": "The compensation grade's unique identifier.", "type": "string" }, "label": { "description": "The compensation grade's label.", "type": "string" } }, "title": "WorkerCompensationGrade", "type": "object" }, "compensation_id": { "description": "The compensation package for the worker.", "type": "string" }, "country": { "description": "The worker's country.", "type": "string" }, "country_fields": { "description": "Country level fields for the worker.", "properties": { "ca": { "description": "Country-wise regional fields for Canada", "properties": { "sin": { "description": "Social Insurance Number (SIN) for Canada employees.", "type": "string" } }, "title": "CanadaFields", "type": "object" }, "nz": { "description": "Country-wise regional fields for New Zealand", "properties": { "ird_number": { "description": "Inland Revenue Department (IRD) number for New Zealand employees.", "type": "string" } }, "title": "NewZealandFields", "type": "object" }, "us": { "description": "Country-wise regional fields for USA", "properties": { "ssn": { "description": "Social Security Number (SSN) for US employees.", "type": "string" } }, "title": "USFields", "type": "object" } }, "title": "CountryFields", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "custom_fields": { "description": "Custom field values defined on the Employee object for this worker\n\nExpandable field", "items": { "additionalProperties": {} }, "type": "array" }, "date_of_birth": { "description": "The worker's date of birth.", "type": "string" }, "department": { "description": "The worker's assigned department.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "department_hierarchy": { "description": "List of departments in the department hierarchy. Refer department_hierarchy_ids for department hierarchy order.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestDepartment" }, "type": "array" }, "department_hierarchy_id": { "description": "The identifier of departments in the department hierarchy ordered from parent department to child department.", "items": { "type": "string" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the department.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestDepartment", "description": "The parent department.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent department.", "type": "string" }, "reference_code": { "description": "Reference code of the department.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Department", "type": "object" }, "department_id": { "description": "The worker's assigned department.", "type": "string" }, "employment_type": { "description": "The worker's employment type.\n\nExpandable field", "properties": { "amount_worked": { "description": "The amount worked for the employment type. * `FULL-TIME`: Full-time is at least 30 hours per week. Full-time workers will typically be eligible for benefits. * `PART-TIME`: Part-time is less than 30 hours per week. These workers may be eligible for benefits, depending on company settings and hours worked. * `TEMPORARY`: These workers are hired on a temporary basis. You can specify how each worker with this employment type will be paid individually.", "type": "string" }, "compensation_time_period": { "description": "The compensation period for the employment type. * `SALARIED`: Employees that are paid a fixed amount per year. * `HOURLY`: Employees that are paid a wage per hour worked.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "label": { "description": "The display label of the employment type.", "type": "string" }, "name": { "description": "The name of the employment type for non-custom employment types.", "type": "string" }, "type": { "description": "The classification of the worker by the company. * `CONTRACTOR`: Contractors are self-employed workers who provide services on a short-term or per-project basis and are not eligible for tax-withholding or benefits. * `EMPLOYEE`: Employees are hired and managed by an employer, work under the employer's direct supervision and control, and are protected by law for wages and employment rights.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "label", "updated_at" ], "title": "CompanyEmploymentType", "type": "object" }, "employment_type_id": { "description": "The worker's employment type.", "type": "string" }, "end_date": { "description": "The end date of the worker.", "type": "string" }, "ethnicity": { "description": "The identified ethnicity of the worker, if specified.", "type": "string" }, "gender": { "description": "The gender of the worker, if specified.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_manager": { "description": "Whether the worker is a manager", "type": "boolean" }, "job_function": { "description": "The worker's job function. When expanded, this field requires `job-functions.read`.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "Displayed name of the job function", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "JobFunction", "type": "object" }, "job_function_id": { "description": "ID of the worker's job function.", "type": "string" }, "legal_entity": { "description": "The worker's associated legal entity.\n\nExpandable field", "properties": { "company": { "description": "The company or organization associated with the legal entity\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "doing_business_as_name": { "description": "The doing business as name for the company.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_entities": { "description": "A list of the company's entities.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestLegalEntity" }, "type": "array" }, "legal_entities_id": { "description": "A list of the company's entities.", "items": { "type": "string" }, "type": "array" }, "legal_name": { "description": "The legal name of the company.", "type": "string" }, "name": { "description": "The name of the company.", "type": "string" }, "parent_legal_entity": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The company's ultimate holding entity.\n\nExpandable field", "type": "object" }, "parent_legal_entity_id": { "description": "The company's ultimate holding entity.", "type": "string" }, "phone": { "description": "The phone number for the company.", "type": "string" }, "physical_address": { "description": "The physical address of the holding entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "primary_email": { "description": "The email address used when registering this company.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "legal_entities", "legal_entities_id", "name", "updated_at" ], "title": "Company", "type": "object" }, "company_id": { "description": "The company or organization associated with the legal entity", "type": "string" }, "country": { "description": "The country the legal entity is based in.", "properties": { "code": { "description": "The code of the country.", "type": "string" } }, "required": [ "code" ], "title": "Country", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "entity_level": { "description": "The legal entity's level in a hierarchy. * `PARENT`: The legal entity is considered the ultimate holding entity. * `SUBSIDIARY`: The legal entity is considered a subsidiary, fully or partially held by another. * `BRANCH`: The legal entity is considered a branch, associated with a parent legal entity.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_name": { "description": "The legal name of the legal entity.", "type": "string" }, "mailing_address": { "description": "The mailing address of the legal entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "management_type": { "description": "The legal entity management type in the case of an employer of record (EOR) or professional employment organization (PEO). * `PEO`: The legal entity is considered a Professional Employment Organization (PEO). * `EOR`: The legal entity is considered an Employer of Record (EOR).", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The parent legal entity.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent legal entity.", "type": "string" }, "physical_address": { "description": "The physical address of the legal entity, if it differs from the mailing address.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "registration_date": { "description": "The registration date of the entity.", "type": "string" }, "tax_identifier": { "description": "The tax identifier for the legal entity.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "LegalEntity", "type": "object" }, "legal_entity_id": { "description": "The worker's associated legal entity.", "type": "string" }, "level": { "description": "The level of the worker.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "description": { "description": "The description of the level.", "type": "string" }, "experience_requirements": { "description": "The experience requirements for the level.", "type": "string" }, "global_level": { "anyOf": [ { "description": "Global level is used to track the seniority of levels. The higher up a level is placed on the page, the more senior and higher-ranked the level. Global level is used in workflows, policies, and reports that use the level attribute (e.g., you can use Level Lookup to set up a workflow that notifies the nearest person in an worker's management chain at or above the specified level).", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the level. Must be unique within the company or organization.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLevel", "description": "The parent level.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent level.", "type": "string" }, "rank": { "anyOf": [ { "description": "The rank of the level within its track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "scope_of_responsibilities": { "description": "The scope of responsibilities for the level.", "type": "string" }, "track": { "description": "The track associated with the level, if it's not a global level.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_default": { "description": "Whether this is the company's default track.", "type": "boolean" }, "name": { "description": "The name of the track. Must be unique within the company or organization.", "type": "string" }, "order": { "anyOf": [ { "description": "The one-based horizontal display order of the track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "start_global_level": { "anyOf": [ { "description": "The highest global level occupied by this track. Empty tracks return null.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Track", "type": "object" }, "track_id": { "description": "The track associated with the level. Required during creation. Include global_level when changing it.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Level", "type": "object" }, "level_id": { "description": "The level of the worker.", "type": "string" }, "location": { "description": "The location that the worker is mapped to for tax purposes. In the case that a worker is remote, the location's type is remote.", "properties": { "type": { "description": "The type of location.", "type": "string" }, "work_location_id": { "description": "The work location, if the worker isn't remote.", "type": "string" } }, "required": [ "type", "work_location_id" ], "title": "WorkerLocation", "type": "object" }, "manager": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's manager.\n\nExpandable field", "type": "object" }, "manager_id": { "description": "The worker's manager.", "type": "string" }, "number": { "anyOf": [ { "description": "The worker's number within the organization.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "original_start_date": { "description": "The worker's earliest start date across their employment history, excluding INIT roles.", "type": "string" }, "overtime_exemption": { "description": "The worker's overtime exemption status.", "type": "string" }, "pay_schedule_id": { "description": "The ID of the pay schedule currently associated with the worker.", "type": "string" }, "personal_email": { "description": "The worker's associated personal email address.", "type": "string" }, "race": { "description": "The identified race of the worker, if specified.", "type": "string" }, "start_date": { "description": "The start date of the worker.", "type": "string" }, "status": { "description": "The worker's status within the organization.", "type": "string" }, "teams": { "description": "The worker's assigned teams.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiTeamcb26bc28f32f" }, "type": "array" }, "teams_id": { "description": "The worker's assigned teams.", "items": { "type": "string" }, "type": "array" }, "termination_details": { "description": "The details of the worker's termination, if applicable.", "properties": { "reason": { "description": "This is a description that will be custom to each Rippling company.", "type": "string" }, "type": { "description": "The termination type indicates whether the termination was voluntary or involuntary.", "type": "string" } }, "title": "TerminationDetails", "type": "object" }, "title": { "description": "The worker's title.", "type": "string" }, "title_effective_date": { "description": "Title effective date", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "user": { "description": "The worker's associated user.\n\nExpandable field", "properties": { "active": { "description": "Whether the user is able to access company resources, typically when they are in actively engaged with the company and not after off-boarding.", "type": "boolean" }, "addresses": { "description": "The user's addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiUserAddressedd59b9ba9a1" }, "type": "array" }, "created_at": { "description": "Record creation date", "type": "string" }, "display_name": { "description": "The display name of the user using either the concatenated preferred given and family name or username depending on availability.", "type": "string" }, "emails": { "description": "The user's email addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiEmail5284c8258dc3" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "locale": { "description": "The User's default location for purposes of localization of currency, date time format, or numerical representations pursuant to RFC5646.", "type": "string" }, "name": { "description": "The user's name.", "properties": { "family_name": { "description": "The legal family name of the user, or last name in most Western languages.", "type": "string" }, "formatted": { "description": "The user's full name.", "type": "string" }, "given_name": { "description": "The given legal name of the user, or first name in most Western languages.", "type": "string" }, "middle_name": { "description": "The middle name(s) of the user.", "type": "string" }, "preferred_family_name": { "description": "The preferred family name, or last name in most Western languages, by the user.", "type": "string" }, "preferred_given_name": { "description": "The preferred given name, or first name in most Western languages, by the user.", "type": "string" } }, "title": "UserName", "type": "object" }, "number": { "description": "The permanent profile number of the user.", "type": "string" }, "phone_numbers": { "description": "The user's phone numbers.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoneNumber12060c61ecf5" }, "type": "array" }, "photos": { "description": "The user's photos.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoto2be7c3ae3f39" }, "type": "array" }, "preferred_language": { "description": "The User's preferred written or spoken language in the same format of the HTTP Accept-Language header, pursuant to Section 5.3.5 of RFC7231.", "type": "string" }, "timezone": { "description": "The User's current time zone in IANA database Olson format", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "username": { "description": "The unique identifier across Rippling used by the User for direct authentication into their associated company. Globally unique.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "User", "type": "object" }, "user_id": { "description": "The worker's associated user.", "type": "string" }, "work_email": { "description": "The worker's associated work email address.", "type": "string" }, "work_schedule": { "additionalProperties": { "$ref": "#/components/schemas/OutputRestApiWorkScheduleDay938f88d94f20" }, "description": "The worker's scheduled working hours for each day of the week.", "type": "object" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Worker", "type": "object" }, "worker_id": { "description": "ID of the worker associated with compensation bands", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Retrieve a specific compensation bands detail", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "compensation-bands-details.read" ] } }, "/compensations/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/list-compensations" }, "operationId": "rippling.rest_api.list_compensations", "parameters": [ { "in": "query", "name": "expand", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 100, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "__meta": { "$ref": "#/components/schemas/OutputRestApiRedactedFields9f7657dc2a2f" }, "next_link": { "description": "A link to the next page of responses.", "format": "uri", "type": "string" }, "results": { "items": { "$ref": "#/components/schemas/OutputRestApiCompensation752572462dc4" }, "type": "array" } }, "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "List compensations", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "compensations.read" ] } }, "/compensations/{id}/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/get-compensations" }, "operationId": "rippling.rest_api.get_compensations", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "id", "type": "string" } }, { "in": "query", "name": "expand", "required": false, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "__meta": { "properties": { "redacted_fields": { "items": { "$ref": "#/components/schemas/OutputRestApiRedactedField21788a25ef22" }, "type": "array" } }, "type": "object" }, "annual_compensation": { "description": "The worker's annual compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "annual_salary_equivalent": { "description": "The worker's annual salary equivalent, for insurance purposes. It will be equal to the worker's annual compensation, except for owners that are receiving no cashcompensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "bonus_schedule": { "description": "The worker's bonus schedule.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "hourly_wage": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "id": { "description": "Identifier field", "type": "string" }, "monthly_compensation": { "description": "The worker's monthly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "on_target_commission": { "description": "The worker's on-target commission.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "payment_terms": { "description": "The payment terms for an worker's compensation.", "type": "string" }, "payment_type": { "description": "The payment type for an worker's compensation.", "type": "string" }, "relocation_reimbursement": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "salary_effective_date": { "description": "Salary effective date", "type": "string" }, "signing_bonus": { "description": "The worker's signing bonus.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus": { "description": "The worker's target annual bonus amount.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus_percent": { "anyOf": [ { "description": "The worker's target annual bonus as a percent of annual compensation.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" }, "weekly_compensation": { "description": "The worker's weekly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "worker": { "description": "The worker's details.\n\nExpandable field", "properties": { "business_partners": { "description": "Worker's assigned business partners. This field is only populated when explicitly requested via the expand parameter (e.g., ?expand=business_partners). When expanded, returns an empty list ([]) if the worker has no business partners.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiBusinessPartner77b00a069c32" }, "type": "array" }, "business_partners_id": { "description": "Worker's assigned business partners unique identifiers. Returns an empty list ([]) if the worker has no business partners.", "items": { "type": "string" }, "type": "array" }, "citizenship": { "description": "The countries that the worker has citizenship in.", "type": "string" }, "compensation": { "$ref": "#/components/schemas/OutputRestCompensation", "description": "The compensation package for the worker.\n\nExpandable field", "type": "object" }, "compensation_grade": { "description": "The compensation grade assigned to the worker, if any.", "properties": { "id": { "description": "The compensation grade's unique identifier.", "type": "string" }, "label": { "description": "The compensation grade's label.", "type": "string" } }, "title": "WorkerCompensationGrade", "type": "object" }, "compensation_id": { "description": "The compensation package for the worker.", "type": "string" }, "country": { "description": "The worker's country.", "type": "string" }, "country_fields": { "description": "Country level fields for the worker.", "properties": { "ca": { "description": "Country-wise regional fields for Canada", "properties": { "sin": { "description": "Social Insurance Number (SIN) for Canada employees.", "type": "string" } }, "title": "CanadaFields", "type": "object" }, "nz": { "description": "Country-wise regional fields for New Zealand", "properties": { "ird_number": { "description": "Inland Revenue Department (IRD) number for New Zealand employees.", "type": "string" } }, "title": "NewZealandFields", "type": "object" }, "us": { "description": "Country-wise regional fields for USA", "properties": { "ssn": { "description": "Social Security Number (SSN) for US employees.", "type": "string" } }, "title": "USFields", "type": "object" } }, "title": "CountryFields", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "custom_fields": { "description": "Custom field values defined on the Employee object for this worker\n\nExpandable field", "items": { "additionalProperties": {} }, "type": "array" }, "date_of_birth": { "description": "The worker's date of birth.", "type": "string" }, "department": { "description": "The worker's assigned department.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "department_hierarchy": { "description": "List of departments in the department hierarchy. Refer department_hierarchy_ids for department hierarchy order.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestDepartment" }, "type": "array" }, "department_hierarchy_id": { "description": "The identifier of departments in the department hierarchy ordered from parent department to child department.", "items": { "type": "string" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the department.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestDepartment", "description": "The parent department.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent department.", "type": "string" }, "reference_code": { "description": "Reference code of the department.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Department", "type": "object" }, "department_id": { "description": "The worker's assigned department.", "type": "string" }, "employment_type": { "description": "The worker's employment type.\n\nExpandable field", "properties": { "amount_worked": { "description": "The amount worked for the employment type. * `FULL-TIME`: Full-time is at least 30 hours per week. Full-time workers will typically be eligible for benefits. * `PART-TIME`: Part-time is less than 30 hours per week. These workers may be eligible for benefits, depending on company settings and hours worked. * `TEMPORARY`: These workers are hired on a temporary basis. You can specify how each worker with this employment type will be paid individually.", "type": "string" }, "compensation_time_period": { "description": "The compensation period for the employment type. * `SALARIED`: Employees that are paid a fixed amount per year. * `HOURLY`: Employees that are paid a wage per hour worked.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "label": { "description": "The display label of the employment type.", "type": "string" }, "name": { "description": "The name of the employment type for non-custom employment types.", "type": "string" }, "type": { "description": "The classification of the worker by the company. * `CONTRACTOR`: Contractors are self-employed workers who provide services on a short-term or per-project basis and are not eligible for tax-withholding or benefits. * `EMPLOYEE`: Employees are hired and managed by an employer, work under the employer's direct supervision and control, and are protected by law for wages and employment rights.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "label", "updated_at" ], "title": "CompanyEmploymentType", "type": "object" }, "employment_type_id": { "description": "The worker's employment type.", "type": "string" }, "end_date": { "description": "The end date of the worker.", "type": "string" }, "ethnicity": { "description": "The identified ethnicity of the worker, if specified.", "type": "string" }, "gender": { "description": "The gender of the worker, if specified.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_manager": { "description": "Whether the worker is a manager", "type": "boolean" }, "job_function": { "description": "The worker's job function. When expanded, this field requires `job-functions.read`.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "Displayed name of the job function", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "JobFunction", "type": "object" }, "job_function_id": { "description": "ID of the worker's job function.", "type": "string" }, "legal_entity": { "description": "The worker's associated legal entity.\n\nExpandable field", "properties": { "company": { "description": "The company or organization associated with the legal entity\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "doing_business_as_name": { "description": "The doing business as name for the company.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_entities": { "description": "A list of the company's entities.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestLegalEntity" }, "type": "array" }, "legal_entities_id": { "description": "A list of the company's entities.", "items": { "type": "string" }, "type": "array" }, "legal_name": { "description": "The legal name of the company.", "type": "string" }, "name": { "description": "The name of the company.", "type": "string" }, "parent_legal_entity": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The company's ultimate holding entity.\n\nExpandable field", "type": "object" }, "parent_legal_entity_id": { "description": "The company's ultimate holding entity.", "type": "string" }, "phone": { "description": "The phone number for the company.", "type": "string" }, "physical_address": { "description": "The physical address of the holding entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "primary_email": { "description": "The email address used when registering this company.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "legal_entities", "legal_entities_id", "name", "updated_at" ], "title": "Company", "type": "object" }, "company_id": { "description": "The company or organization associated with the legal entity", "type": "string" }, "country": { "description": "The country the legal entity is based in.", "properties": { "code": { "description": "The code of the country.", "type": "string" } }, "required": [ "code" ], "title": "Country", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "entity_level": { "description": "The legal entity's level in a hierarchy. * `PARENT`: The legal entity is considered the ultimate holding entity. * `SUBSIDIARY`: The legal entity is considered a subsidiary, fully or partially held by another. * `BRANCH`: The legal entity is considered a branch, associated with a parent legal entity.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_name": { "description": "The legal name of the legal entity.", "type": "string" }, "mailing_address": { "description": "The mailing address of the legal entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "management_type": { "description": "The legal entity management type in the case of an employer of record (EOR) or professional employment organization (PEO). * `PEO`: The legal entity is considered a Professional Employment Organization (PEO). * `EOR`: The legal entity is considered an Employer of Record (EOR).", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The parent legal entity.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent legal entity.", "type": "string" }, "physical_address": { "description": "The physical address of the legal entity, if it differs from the mailing address.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "registration_date": { "description": "The registration date of the entity.", "type": "string" }, "tax_identifier": { "description": "The tax identifier for the legal entity.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "LegalEntity", "type": "object" }, "legal_entity_id": { "description": "The worker's associated legal entity.", "type": "string" }, "level": { "description": "The level of the worker.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "description": { "description": "The description of the level.", "type": "string" }, "experience_requirements": { "description": "The experience requirements for the level.", "type": "string" }, "global_level": { "anyOf": [ { "description": "Global level is used to track the seniority of levels. The higher up a level is placed on the page, the more senior and higher-ranked the level. Global level is used in workflows, policies, and reports that use the level attribute (e.g., you can use Level Lookup to set up a workflow that notifies the nearest person in an worker's management chain at or above the specified level).", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the level. Must be unique within the company or organization.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLevel", "description": "The parent level.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent level.", "type": "string" }, "rank": { "anyOf": [ { "description": "The rank of the level within its track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "scope_of_responsibilities": { "description": "The scope of responsibilities for the level.", "type": "string" }, "track": { "description": "The track associated with the level, if it's not a global level.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_default": { "description": "Whether this is the company's default track.", "type": "boolean" }, "name": { "description": "The name of the track. Must be unique within the company or organization.", "type": "string" }, "order": { "anyOf": [ { "description": "The one-based horizontal display order of the track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "start_global_level": { "anyOf": [ { "description": "The highest global level occupied by this track. Empty tracks return null.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Track", "type": "object" }, "track_id": { "description": "The track associated with the level. Required during creation. Include global_level when changing it.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Level", "type": "object" }, "level_id": { "description": "The level of the worker.", "type": "string" }, "location": { "description": "The location that the worker is mapped to for tax purposes. In the case that a worker is remote, the location's type is remote.", "properties": { "type": { "description": "The type of location.", "type": "string" }, "work_location_id": { "description": "The work location, if the worker isn't remote.", "type": "string" } }, "required": [ "type", "work_location_id" ], "title": "WorkerLocation", "type": "object" }, "manager": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's manager.\n\nExpandable field", "type": "object" }, "manager_id": { "description": "The worker's manager.", "type": "string" }, "number": { "anyOf": [ { "description": "The worker's number within the organization.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "original_start_date": { "description": "The worker's earliest start date across their employment history, excluding INIT roles.", "type": "string" }, "overtime_exemption": { "description": "The worker's overtime exemption status.", "type": "string" }, "pay_schedule_id": { "description": "The ID of the pay schedule currently associated with the worker.", "type": "string" }, "personal_email": { "description": "The worker's associated personal email address.", "type": "string" }, "race": { "description": "The identified race of the worker, if specified.", "type": "string" }, "start_date": { "description": "The start date of the worker.", "type": "string" }, "status": { "description": "The worker's status within the organization.", "type": "string" }, "teams": { "description": "The worker's assigned teams.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiTeamcb26bc28f32f" }, "type": "array" }, "teams_id": { "description": "The worker's assigned teams.", "items": { "type": "string" }, "type": "array" }, "termination_details": { "description": "The details of the worker's termination, if applicable.", "properties": { "reason": { "description": "This is a description that will be custom to each Rippling company.", "type": "string" }, "type": { "description": "The termination type indicates whether the termination was voluntary or involuntary.", "type": "string" } }, "title": "TerminationDetails", "type": "object" }, "title": { "description": "The worker's title.", "type": "string" }, "title_effective_date": { "description": "Title effective date", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "user": { "description": "The worker's associated user.\n\nExpandable field", "properties": { "active": { "description": "Whether the user is able to access company resources, typically when they are in actively engaged with the company and not after off-boarding.", "type": "boolean" }, "addresses": { "description": "The user's addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiUserAddressedd59b9ba9a1" }, "type": "array" }, "created_at": { "description": "Record creation date", "type": "string" }, "display_name": { "description": "The display name of the user using either the concatenated preferred given and family name or username depending on availability.", "type": "string" }, "emails": { "description": "The user's email addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiEmail5284c8258dc3" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "locale": { "description": "The User's default location for purposes of localization of currency, date time format, or numerical representations pursuant to RFC5646.", "type": "string" }, "name": { "description": "The user's name.", "properties": { "family_name": { "description": "The legal family name of the user, or last name in most Western languages.", "type": "string" }, "formatted": { "description": "The user's full name.", "type": "string" }, "given_name": { "description": "The given legal name of the user, or first name in most Western languages.", "type": "string" }, "middle_name": { "description": "The middle name(s) of the user.", "type": "string" }, "preferred_family_name": { "description": "The preferred family name, or last name in most Western languages, by the user.", "type": "string" }, "preferred_given_name": { "description": "The preferred given name, or first name in most Western languages, by the user.", "type": "string" } }, "title": "UserName", "type": "object" }, "number": { "description": "The permanent profile number of the user.", "type": "string" }, "phone_numbers": { "description": "The user's phone numbers.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoneNumber12060c61ecf5" }, "type": "array" }, "photos": { "description": "The user's photos.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoto2be7c3ae3f39" }, "type": "array" }, "preferred_language": { "description": "The User's preferred written or spoken language in the same format of the HTTP Accept-Language header, pursuant to Section 5.3.5 of RFC7231.", "type": "string" }, "timezone": { "description": "The User's current time zone in IANA database Olson format", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "username": { "description": "The unique identifier across Rippling used by the User for direct authentication into their associated company. Globally unique.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "User", "type": "object" }, "user_id": { "description": "The worker's associated user.", "type": "string" }, "work_email": { "description": "The worker's associated work email address.", "type": "string" }, "work_schedule": { "additionalProperties": { "$ref": "#/components/schemas/OutputRestApiWorkScheduleDay938f88d94f20" }, "description": "The worker's scheduled working hours for each day of the week.", "type": "object" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Worker", "type": "object" }, "worker_id": { "description": "The worker's ID.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Retrieve a specific compensation", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "compensations.read" ] } }, "/custom-apps/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/list-custom-apps" }, "operationId": "rippling.rest_api.list_custom_apps", "parameters": [ { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "__meta": { "$ref": "#/components/schemas/OutputRestApiRedactedFields9f7657dc2a2f" }, "next_link": { "description": "A link to the next page of responses.", "format": "uri", "type": "string" }, "results": { "items": { "$ref": "#/components/schemas/OutputRestApiCustomAppe481dbc8a4b8" }, "type": "array" } }, "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "List CustomApp", "x-rippling-entitlements": [ "Custom_Apps_Platform_API" ], "x-rippling-required-scopes": [ "custom-apps.read" ] }, "post": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/create-custom-apps" }, "operationId": "rippling.rest_api.create_custom_apps", "parameters": [ { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiCustomAppRequestd4f45c40993f" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "api_name": { "description": "The unique api name of the custom app", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "description": { "description": "The description of the custom app", "type": "string" }, "icon": { "description": "The icon URL of the custom app", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The display name of the custom app", "type": "string" }, "pages": { "description": "The pages of the custom app", "items": { "$ref": "#/components/schemas/OutputRestApiPageSummary831a5e01076d" }, "type": "array" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "api_name", "name" ], "title": "CustomApp", "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Create a new CustomApp", "x-rippling-entitlements": [ "Custom_Apps_Platform_API" ], "x-rippling-required-scopes": [ "custom-apps.read-write" ] } }, "/custom-apps/{id}/": { "delete": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/delete-custom-apps" }, "operationId": "rippling.rest_api.delete_custom_apps", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "id", "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "204": { "description": "The resource was deleted successfully" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Delete a CustomApp", "x-rippling-entitlements": [ "Custom_Apps_Platform_API" ], "x-rippling-required-scopes": [ "custom-apps.read-write" ] }, "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/get-custom-apps" }, "operationId": "rippling.rest_api.get_custom_apps", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "id", "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "__meta": { "properties": { "redacted_fields": { "items": { "$ref": "#/components/schemas/OutputRestApiRedactedField21788a25ef22" }, "type": "array" } }, "type": "object" }, "api_name": { "description": "The unique api name of the custom app", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "description": { "description": "The description of the custom app", "type": "string" }, "icon": { "description": "The icon URL of the custom app", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The display name of the custom app", "type": "string" }, "pages": { "description": "The pages of the custom app", "items": { "$ref": "#/components/schemas/OutputRestApiPageSummary831a5e01076d" }, "type": "array" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "api_name", "name" ], "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Retrieve a specific CustomApp", "x-rippling-entitlements": [ "Custom_Apps_Platform_API" ], "x-rippling-required-scopes": [ "custom-apps.read" ] }, "patch": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/update-custom-apps" }, "operationId": "rippling.rest_api.update_custom_apps", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "id", "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiCustomAppRequestd4f45c40993f" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "api_name": { "description": "The unique api name of the custom app", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "description": { "description": "The description of the custom app", "type": "string" }, "icon": { "description": "The icon URL of the custom app", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The display name of the custom app", "type": "string" }, "pages": { "description": "The pages of the custom app", "items": { "$ref": "#/components/schemas/OutputRestApiPageSummary831a5e01076d" }, "type": "array" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "api_name", "name" ], "title": "CustomApp", "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Update a CustomApp", "x-rippling-entitlements": [ "Custom_Apps_Platform_API" ], "x-rippling-required-scopes": [ "custom-apps.read-write" ] } }, "/custom-fields/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/list-custom-fields" }, "operationId": "rippling.rest_api.list_custom_fields", "parameters": [ { "in": "query", "name": "order_by", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 100, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "__meta": { "$ref": "#/components/schemas/OutputRestApiRedactedFields9f7657dc2a2f" }, "next_link": { "description": "A link to the next page of responses.", "format": "uri", "type": "string" }, "results": { "items": { "$ref": "#/components/schemas/OutputRestApiCustomField760477f10998" }, "type": "array" } }, "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "List custom fields", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "custom-fields.read" ] } }, "/custom-objects/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/list-custom-objects" }, "operationId": "rippling.rest_api.list_custom_objects", "parameters": [ { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 100, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "next_link": { "description": "A link to the next page of responses.", "format": "uri", "type": "string" }, "results": { "items": { "$ref": "#/components/schemas/OutputRestApiCustomObjecta49caa0ec2a2" }, "type": "array" } }, "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "List custom objects", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "custom-objects.read", "custom-objects.read-write", "custom-objects.read-write.owner" ] }, "post": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/create-custom-objects" }, "operationId": "rippling.rest_api.create_custom_objects", "parameters": [ { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "category": { "description": "The category that this custom object belongs to.", "type": "string" }, "description": { "description": "A description of the custom object.", "type": "string" }, "name": { "description": "The name of the custom object.", "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "api_name": { "description": "The api name of the custom object", "type": "string" }, "category_id": { "description": "The category of the custom object", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "description": { "description": "The description of the custom object", "type": "string" }, "enable_history": { "description": "Whether to record the history of the custom object", "type": "boolean" }, "id": { "description": "Identifier field", "type": "string" }, "managed_package_install_id": { "description": "The id of the package which the custom object belongs to", "type": "string" }, "name": { "description": "The name of the custom object", "type": "string" }, "native_category_id": { "description": "The native category of the custom object if belongs to", "type": "string" }, "owner_id": { "description": "The id of the owner for the custom object", "type": "string" }, "plural_label": { "description": "The plural label of the custom object", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "category_id", "created_at", "enable_history", "id", "name", "plural_label", "updated_at" ], "title": "CustomObject", "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Create a new custom object", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "custom-objects.read-write.owner" ] } }, "/custom-objects/{custom_object_api_name}/": { "delete": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/delete-custom-objects" }, "operationId": "rippling.rest_api.delete_custom_objects", "parameters": [ { "in": "path", "name": "custom_object_api_name", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "204": { "description": "The resource was deleted successfully" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Delete a custom object", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "custom-objects.read-write", "custom-objects.read-write.owner" ] }, "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/get-custom-objects" }, "operationId": "rippling.rest_api.get_custom_objects", "parameters": [ { "in": "path", "name": "custom_object_api_name", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "api_name": { "description": "The api name of the custom object", "type": "string" }, "category_id": { "description": "The category of the custom object", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "description": { "description": "The description of the custom object", "type": "string" }, "enable_history": { "description": "Whether to record the history of the custom object", "type": "boolean" }, "id": { "description": "Identifier field", "type": "string" }, "managed_package_install_id": { "description": "The id of the package which the custom object belongs to", "type": "string" }, "name": { "description": "The name of the custom object", "type": "string" }, "native_category_id": { "description": "The native category of the custom object if belongs to", "type": "string" }, "owner_id": { "description": "The id of the owner for the custom object", "type": "string" }, "plural_label": { "description": "The plural label of the custom object", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "category_id", "created_at", "enable_history", "id", "name", "plural_label", "updated_at" ], "title": "CustomObject", "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Retrieve a specific custom object", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "custom-objects.read", "custom-objects.read-write", "custom-objects.read-write.owner" ] }, "patch": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/update-custom-objects" }, "operationId": "rippling.rest_api.update_custom_objects", "parameters": [ { "in": "path", "name": "custom_object_api_name", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "category": { "description": "The category that this custom object belongs to.", "type": "string" }, "description": { "description": "A description of the custom object.", "type": "string" }, "name": { "description": "The name of the custom object.", "type": "string" }, "owner_role": { "description": "The role that owns this custom object.", "type": "string" }, "plural_label": { "description": "The plural label for the custom object.", "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "api_name": { "description": "The api name of the custom object", "type": "string" }, "category_id": { "description": "The category of the custom object", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "description": { "description": "The description of the custom object", "type": "string" }, "enable_history": { "description": "Whether to record the history of the custom object", "type": "boolean" }, "id": { "description": "Identifier field", "type": "string" }, "managed_package_install_id": { "description": "The id of the package which the custom object belongs to", "type": "string" }, "name": { "description": "The name of the custom object", "type": "string" }, "native_category_id": { "description": "The native category of the custom object if belongs to", "type": "string" }, "owner_id": { "description": "The id of the owner for the custom object", "type": "string" }, "plural_label": { "description": "The plural label of the custom object", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "category_id", "created_at", "enable_history", "id", "name", "plural_label", "updated_at" ], "title": "CustomObject", "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Update a custom object", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "custom-objects.read-write", "custom-objects.read-write.owner" ] } }, "/custom-objects/{custom_object_api_name}/fields/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/list-custom-objects-custom-object-api-name-fields" }, "operationId": "rippling.rest_api.list_custom_objects_custom_object_api_name_fields", "parameters": [ { "in": "path", "name": "custom_object_api_name", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 100, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "next_link": { "description": "A link to the next page of responses.", "format": "uri", "type": "string" }, "results": { "items": { "$ref": "#/components/schemas/OutputRestApiCustomObjectField5cc7c0ac740a" }, "type": "array" } }, "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "List custom object fields", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "custom-objects.read", "custom-objects.read-write", "custom-objects.read-write.owner" ] }, "post": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/create-custom-objects-custom-object-api-name-fields" }, "operationId": "rippling.rest_api.create_custom_objects_custom_object_api_name_fields", "parameters": [ { "in": "path", "name": "custom_object_api_name", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data_type": { "additionalProperties": true, "description": "The data type configuration for the field.", "properties": { "num_of_decimal_places": { "description": "Configured fractional scale for NUMBER, PERCENTAGE, and CURRENCY fields. Availability above the legacy per-type limit is capability-gated.", "maximum": 15, "minimum": 0, "type": "integer" } }, "type": "object" }, "derived_aggregated_field": { "description": "Configuration for derived aggregated fields.", "type": "object" }, "derived_field_formula": { "description": "The formula for derived fields.", "type": "string" }, "description": { "description": "A description of the field.", "type": "string" }, "enable_history": { "description": "Whether to track history for this field.", "type": "boolean" }, "formula_attr_metas": { "description": "Metadata for formula attributes.", "type": "object" }, "is_unique": { "description": "Whether field values must be unique.", "type": "boolean" }, "name": { "description": "The name of the field.", "type": "string" }, "required": { "description": "Whether this field is required.", "type": "boolean" }, "rql_definition": { "description": "The RQL definition for computed fields.", "type": "object" }, "section": { "description": "The section configuration for the field.", "type": "object" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "api_name": { "description": "The api name of the custom object field", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "custom_object": { "description": "The custom object which the field belongs to", "type": "string" }, "data_type": { "additionalProperties": true, "description": "The data type configuration for the field.", "properties": { "num_of_decimal_places": { "anyOf": [ { "description": "Configured fractional scale for NUMBER, PERCENTAGE, and CURRENCY fields. Availability above the legacy per-type limit is capability-gated.", "maximum": 15, "minimum": 0, "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "type": "object" }, "description": { "description": "The description of the custom object field", "type": "string" }, "enable_history": { "description": "whether the history is enable for the field", "type": "boolean" }, "id": { "description": "Identifier field", "type": "string" }, "is_immutable": { "description": "whether the field is imuatable", "type": "boolean" }, "is_standard": { "description": "whether the field is standard field", "type": "boolean" }, "is_unique": { "description": "This field specifies whether a particular column value has unique values", "type": "boolean" }, "managed_package_install_id": { "description": "The id of the package which the custom object field belongs to", "type": "string" }, "name": { "description": "The name of the custom object field", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "api_name", "created_at", "custom_object", "data_type", "enable_history", "id", "is_immutable", "is_standard", "is_unique", "name", "updated_at" ], "title": "CustomObjectField", "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Create a new custom object field", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "custom-objects.read-write", "custom-objects.read-write.owner" ] } }, "/custom-objects/{custom_object_api_name}/fields/{field_api_name}/": { "delete": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/delete-custom-objects-custom-object-api-name-fields" }, "operationId": "rippling.rest_api.delete_custom_objects_custom_object_api_name_fields", "parameters": [ { "in": "path", "name": "custom_object_api_name", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "field_api_name", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "204": { "description": "The resource was deleted successfully" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Delete a custom object field", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "custom-objects.read-write", "custom-objects.read-write.owner" ] }, "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/get-custom-objects-custom-object-api-name-fields" }, "operationId": "rippling.rest_api.get_custom_objects_custom_object_api_name_fields", "parameters": [ { "in": "path", "name": "custom_object_api_name", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "field_api_name", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "api_name": { "description": "The api name of the custom object field", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "custom_object": { "description": "The custom object which the field belongs to", "type": "string" }, "data_type": { "additionalProperties": true, "description": "The data type configuration for the field.", "properties": { "num_of_decimal_places": { "anyOf": [ { "description": "Configured fractional scale for NUMBER, PERCENTAGE, and CURRENCY fields. Availability above the legacy per-type limit is capability-gated.", "maximum": 15, "minimum": 0, "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "type": "object" }, "description": { "description": "The description of the custom object field", "type": "string" }, "enable_history": { "description": "whether the history is enable for the field", "type": "boolean" }, "id": { "description": "Identifier field", "type": "string" }, "is_immutable": { "description": "whether the field is imuatable", "type": "boolean" }, "is_standard": { "description": "whether the field is standard field", "type": "boolean" }, "is_unique": { "description": "This field specifies whether a particular column value has unique values", "type": "boolean" }, "managed_package_install_id": { "description": "The id of the package which the custom object field belongs to", "type": "string" }, "name": { "description": "The name of the custom object field", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "api_name", "created_at", "custom_object", "data_type", "enable_history", "id", "is_immutable", "is_standard", "is_unique", "name", "updated_at" ], "title": "CustomObjectField", "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Retrieve a specific custom object field", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "custom-objects.read", "custom-objects.read-write", "custom-objects.read-write.owner" ] }, "patch": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/update-custom-objects-custom-object-api-name-fields" }, "operationId": "rippling.rest_api.update_custom_objects_custom_object_api_name_fields", "parameters": [ { "in": "path", "name": "custom_object_api_name", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "field_api_name", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "data_type": { "additionalProperties": true, "description": "The data type configuration for the field.", "properties": { "num_of_decimal_places": { "description": "Configured fractional scale for NUMBER, PERCENTAGE, and CURRENCY fields. Availability above the legacy per-type limit is capability-gated.", "maximum": 15, "minimum": 0, "type": "integer" } }, "type": "object" }, "derived_field_formula": { "description": "The formula for derived fields.", "type": "string" }, "description": { "description": "A description of the field.", "type": "string" }, "enable_history": { "description": "Whether to track history for this field.", "type": "boolean" }, "formula_attr_metas": { "description": "Metadata for formula attributes.", "type": "object" }, "is_unique": { "description": "Whether field values must be unique.", "type": "boolean" }, "name": { "description": "The name of the field.", "type": "string" }, "name_field_details": { "description": "Configuration for name field display.", "type": "object" }, "required": { "description": "Whether this field is required.", "type": "boolean" }, "rql_definition": { "description": "The RQL definition for computed fields.", "type": "object" }, "section": { "description": "The section configuration for the field.", "type": "object" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "api_name": { "description": "The api name of the custom object field", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "custom_object": { "description": "The custom object which the field belongs to", "type": "string" }, "data_type": { "additionalProperties": true, "description": "The data type configuration for the field.", "properties": { "num_of_decimal_places": { "anyOf": [ { "description": "Configured fractional scale for NUMBER, PERCENTAGE, and CURRENCY fields. Availability above the legacy per-type limit is capability-gated.", "maximum": 15, "minimum": 0, "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "type": "object" }, "description": { "description": "The description of the custom object field", "type": "string" }, "enable_history": { "description": "whether the history is enable for the field", "type": "boolean" }, "id": { "description": "Identifier field", "type": "string" }, "is_immutable": { "description": "whether the field is imuatable", "type": "boolean" }, "is_standard": { "description": "whether the field is standard field", "type": "boolean" }, "is_unique": { "description": "This field specifies whether a particular column value has unique values", "type": "boolean" }, "managed_package_install_id": { "description": "The id of the package which the custom object field belongs to", "type": "string" }, "name": { "description": "The name of the custom object field", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "api_name", "created_at", "custom_object", "data_type", "enable_history", "id", "is_immutable", "is_standard", "is_unique", "name", "updated_at" ], "title": "CustomObjectField", "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Update a custom object field", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "custom-objects.read-write", "custom-objects.read-write.owner" ] } }, "/custom-objects/{custom_object_api_name}/list-views/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/list-custom-object-list-views" }, "operationId": "rippling.rest_api.list_custom_object_list_views", "parameters": [ { "in": "path", "name": "custom_object_api_name", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 100, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "next_link": { "anyOf": [ { "format": "uri", "type": "string" }, { "type": "null" } ] }, "results": { "items": { "$ref": "#/components/schemas/OutputRestApiCustomObjectListView45dd08dc429b" }, "type": "array" } }, "required": [ "next_link", "results" ], "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "List custom object list views", "x-rippling-entitlements": [ "Internal_Testing" ], "x-rippling-required-scopes": [ "custom-objects.read", "custom-objects.read-write", "custom-objects.read-write.owner" ] } }, "/custom-objects/{custom_object_api_name}/list-views/{id}/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/get-custom-object-list-view" }, "operationId": "rippling.rest_api.get_custom_object_list_view", "parameters": [ { "in": "path", "name": "custom_object_api_name", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OutputRestApiCustomObjectListView45dd08dc429b" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Retrieve a custom object list view", "x-rippling-entitlements": [ "Internal_Testing" ], "x-rippling-required-scopes": [ "custom-objects.read", "custom-objects.read-write", "custom-objects.read-write.owner" ] } }, "/custom-objects/{custom_object_api_name}/records/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/list-custom-objects-custom-object-api-name-records" }, "operationId": "rippling.rest_api.list_custom_objects_custom_object_api_name_records", "parameters": [ { "in": "path", "name": "custom_object_api_name", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 100, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "next_link": { "description": "A link to the next page of responses.", "format": "uri", "type": "string" }, "results": { "items": { "$ref": "#/components/schemas/OutputRestApiCustomObjectDataRow8539d9fa9ed5" }, "type": "array" } }, "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "List custom object records", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "custom-object-records.read", "custom-object-records.read-write", "custom-objects.read-write.owner" ] }, "post": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/create-custom-objects-custom-object-api-name-records" }, "operationId": "rippling.rest_api.create_custom_objects_custom_object_api_name_records", "parameters": [ { "in": "path", "name": "custom_object_api_name", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "description": "An object containing field values for the custom object record. A new external_id creates a record; an existing external_id updates that record. Use a stable, source-derived external_id to make retries resolve to the same record.", "properties": { "external_id": { "description": "A caller-provided identifier that creates a record when new and updates the existing record when reused.", "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "201": { "content": { "application/json": { "schema": { "properties": { "data": { "anyOf": [ { "$ref": "#/components/schemas/OutputRestApiCustomObjectDataRow46b111ba0ddb" }, { "additionalProperties": false, "description": "A write receipt returned when the record is not visible to the caller's read permissions.", "properties": { "id": {} }, "required": [ "id" ], "type": "object" } ] } }, "type": "object" } } }, "description": "The record was written successfully." }, "403": { "description": "The caller lacks the required create or update permission.", "x-rippling-source-response": { "description": "The caller lacks the required create or update permission." } } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Create or update a custom object record", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "custom-object-records.read-write", "custom-objects.read-write.owner" ] } }, "/custom-objects/{custom_object_api_name}/records/bulk-delete/": { "post": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/bulk-delete-custom-objects-custom-object-api-name-records" }, "operationId": "rippling.rest_api.bulk_delete_custom_objects_custom_object_api_name_records", "parameters": [ { "in": "path", "name": "custom_object_api_name", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "all_or_nothing": { "description": "If true, the entire operation fails if any record fails. If false, partial success is allowed.", "type": "boolean" }, "rows_to_delete": { "description": "A list of record IDs to delete, e.g. [id_1, id_2].", "items": { "type": "string" }, "type": "array" } }, "type": "object" } } }, "required": false }, "responses": { "204": { "description": "The resources were deleted successfully" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Bulk delete custom object records", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "custom-object-records.read-write", "custom-objects.read-write.owner" ] } }, "/custom-objects/{custom_object_api_name}/records/bulk/": { "patch": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/bulk-update-custom-objects-custom-object-api-name-records" }, "operationId": "rippling.rest_api.bulk_update_custom_objects_custom_object_api_name_records", "parameters": [ { "in": "path", "name": "custom_object_api_name", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "all_or_nothing": { "description": "If true, the entire operation fails if any record fails. If false, partial success is allowed.", "type": "boolean" }, "rows_to_update": { "description": "The list of records to update.", "items": { "additionalProperties": true, "description": "An object containing the ID and field values to update for an existing custom object record.", "properties": { "id": { "description": "The ID of the existing record to update.", "type": "string" } }, "required": [ "id" ], "type": "object" }, "type": "array" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "data": { "items": { "anyOf": [ { "$ref": "#/components/schemas/OutputRestApiCustomObjectDataRow46b111ba0ddb" }, { "additionalProperties": false, "description": "A write receipt returned when the record is not visible to the caller's read permissions.", "properties": { "id": {} }, "required": [ "id" ], "type": "object" } ] }, "type": "array" } }, "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Bulk Update custom object records", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "custom-object-records.read-write", "custom-objects.read-write.owner" ] }, "post": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/bulk-create-custom-objects-custom-object-api-name-records" }, "operationId": "rippling.rest_api.bulk_create_custom_objects_custom_object_api_name_records", "parameters": [ { "in": "path", "name": "custom_object_api_name", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "all_or_nothing": { "description": "If true, the entire operation fails if any record fails. If false, partial success is allowed.", "type": "boolean" }, "rows_to_write": { "description": "The list of records to create.", "items": { "additionalProperties": true, "description": "An object containing field values for the custom object record. A new external_id creates a record; an existing external_id updates that record.", "properties": { "external_id": { "description": "A caller-provided identifier that creates a record when new and updates the existing record when reused.", "type": "string" } }, "type": "object" }, "type": "array" } }, "type": "object" } } }, "required": false }, "responses": { "201": { "content": { "application/json": { "schema": { "properties": { "data": { "items": { "anyOf": [ { "$ref": "#/components/schemas/OutputRestApiCustomObjectDataRow46b111ba0ddb" }, { "additionalProperties": false, "description": "A write receipt returned when the record is not visible to the caller's read permissions.", "properties": { "id": {} }, "required": [ "id" ], "type": "object" } ] }, "type": "array" } }, "type": "object" } } }, "description": "The records were written successfully." }, "403": { "description": "The caller lacks a create or update permission required by the batch.", "x-rippling-source-response": { "description": "The caller lacks a create or update permission required by the batch." } } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Bulk create or update custom object records", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "custom-object-records.read-write", "custom-object.read-write.owner" ] } }, "/custom-objects/{custom_object_api_name}/records/external_id/{external_id}/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/get-custom-objects-custom-object-api-name-records-by-external-id" }, "operationId": "rippling.rest_api.get_custom_objects_custom_object_api_name_records_by_external_id", "parameters": [ { "in": "path", "name": "custom_object_api_name", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "external_id", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OutputRestApiCustomObjectDataRow8539d9fa9ed5" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Retrieve a specific custom object record by its external_id", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "custom-object-records.read", "custom-object-records.read-write", "custom-objects.read-write.owner" ] } }, "/custom-objects/{custom_object_api_name}/records/query/": { "post": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/list-by-query-custom-objects-custom-object-api-name-records" }, "operationId": "rippling.rest_api.list_by_query_custom_objects_custom_object_api_name_records", "parameters": [ { "in": "path", "name": "custom_object_api_name", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "cursor": { "description": "A cursor for pagination to fetch the next page of results.", "type": "string" }, "limit": { "description": "The maximum number of results to return.", "type": "integer" }, "order_by": { "description": "Order results by one readable field API name followed by optional asc (ascending) or desc (descending). Direction defaults to asc; multiple fields and nested paths are not supported. For example: name desc. Overrides search relevance order. Reference fields use the same ordering as the Custom Object grid. A record ID tie-breaker makes the order deterministic; traversal is not a snapshot of concurrently changing records. Omit order_by to retain the existing default order. Reset cursor when criteria change.", "pattern": "^\\s*[A-Za-z_][A-Za-z0-9_]*(?: +(asc|desc))?\\s*$", "type": "string" }, "query": { "description": "An optional RQL expression that filters custom object records. For example: owner_role = \"role-id\" AND status__c IN [\"FINAL\", \"APPROVED\"].", "type": "string" }, "search": { "description": "Search record names or owners. Name search uses token/prefix matching, not arbitrary substring matching. Native exact record ID and external ID matching is also retained. ANDed with query before pagination. Whitespace is trimmed; omitting search or sending a blank string disables it. Some older Custom Objects do not support search and return HTTP 400; omit search to use filters. Owner matching uses a bounded worker search, so broad terms may not include every matching owner. Use an owner_role query filter for an exact owner. Without order_by, native search order applies. Repeat search, query, and order_by unchanged when following a cursor.", "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "cursor": { "type": "string" }, "results": { "items": { "$ref": "#/components/schemas/OutputRestApiCustomObjectDataRow8539d9fa9ed5" }, "type": "array" } }, "type": "object" } } }, "description": "Successful response" }, "400": { "description": "Invalid query, search, order_by, limit, or cursor; unsupported sort input; or search is unavailable for this Custom Object. Correct the input before retrying. When search is unavailable, omit search and use query filters. For sort input, use order_by with one readable field API name and optional asc or desc; multiple ordering fields are unsupported.", "x-rippling-source-response": { "description": "Invalid query, search, order_by, limit, or cursor; unsupported sort input; or search is unavailable for this Custom Object. Correct the input before retrying. When search is unavailable, omit search and use query filters. For sort input, use order_by with one readable field API name and optional asc or desc; multiple ordering fields are unsupported." } }, "403": { "description": "The token lacks an accepted Custom Object record scope, access to this object, or the required record permissions. Request the applicable scope and object access before retrying.", "x-rippling-source-response": { "description": "The token lacks an accepted Custom Object record scope, access to this object, or the required record permissions. Request the applicable scope and object access before retrying." } }, "404": { "description": "The Custom Object does not exist or is inaccessible to this caller. Select an accessible object before retrying.", "x-rippling-source-response": { "description": "The Custom Object does not exist or is inaccessible to this caller. Select an accessible object before retrying." } } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "List custom object records by query", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "custom-object-records.read", "custom-object-records.read-write", "custom-objects.read-write.owner" ] } }, "/custom-objects/{custom_object_api_name}/records/{codr_id}/": { "delete": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/delete-custom-objects-custom-object-api-name-records" }, "operationId": "rippling.rest_api.delete_custom_objects_custom_object_api_name_records", "parameters": [ { "in": "path", "name": "custom_object_api_name", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "codr_id", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "204": { "description": "The resource was deleted successfully" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Delete a custom object record", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "custom-object-records.read-write", "custom-objects.read-write.owner" ] }, "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/get-custom-objects-custom-object-api-name-records" }, "operationId": "rippling.rest_api.get_custom_objects_custom_object_api_name_records", "parameters": [ { "in": "path", "name": "custom_object_api_name", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "codr_id", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OutputRestApiCustomObjectDataRow8539d9fa9ed5" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Retrieve a specific custom object record", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "custom-object-records.read", "custom-object-records.read-write", "custom-objects.read-write.owner" ] }, "patch": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/update-custom-objects-custom-object-api-name-records" }, "operationId": "rippling.rest_api.update_custom_objects_custom_object_api_name_records", "parameters": [ { "in": "path", "name": "custom_object_api_name", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "codr_id", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "description": "An object containing field values to update. Only include the fields you want to modify. Field names and types are defined by the custom object schema.", "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "data": { "anyOf": [ { "$ref": "#/components/schemas/OutputRestApiCustomObjectDataRow46b111ba0ddb" }, { "additionalProperties": false, "description": "A write receipt returned when the record is not visible to the caller's read permissions.", "properties": { "id": {} }, "required": [ "id" ], "type": "object" } ] } }, "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Update a custom object record", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "custom-object-records.read-write", "custom-objects.read-write.owner" ] } }, "/custom-pages/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/list-custom-pages" }, "operationId": "rippling.rest_api.list_custom_pages", "parameters": [ { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "__meta": { "$ref": "#/components/schemas/OutputRestApiRedactedFields9f7657dc2a2f" }, "next_link": { "description": "A link to the next page of responses.", "format": "uri", "type": "string" }, "results": { "items": { "$ref": "#/components/schemas/OutputRestApiCustomPage205fc2dc58c4" }, "type": "array" } }, "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "List CustomPage", "x-rippling-entitlements": [ "Custom_Apps_Platform_API" ], "x-rippling-required-scopes": [ "custom-pages.read" ] }, "post": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/create-custom-pages" }, "operationId": "rippling.rest_api.create_custom_pages", "parameters": [ { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiCustomPageRequest2e7e485fe8d2" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "created_by": { "description": "The ID of the role that created the page", "type": "string" }, "function_id": { "description": "The ID of the Rippling Function that renders this page", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The display name of the custom page", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "updated_by": { "description": "The ID of the role that last modified the page", "type": "string" } }, "title": "CustomPage", "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Create a new CustomPage", "x-rippling-entitlements": [ "Custom_Apps_Platform_API" ], "x-rippling-required-scopes": [ "custom-pages.read-write" ] } }, "/custom-pages/{id}/": { "delete": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/delete-custom-pages" }, "operationId": "rippling.rest_api.delete_custom_pages", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "id", "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "204": { "description": "The resource was deleted successfully" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Delete a CustomPage", "x-rippling-entitlements": [ "Custom_Apps_Platform_API" ], "x-rippling-required-scopes": [ "custom-pages.read-write" ] }, "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/get-custom-pages" }, "operationId": "rippling.rest_api.get_custom_pages", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "id", "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "__meta": { "properties": { "redacted_fields": { "items": { "$ref": "#/components/schemas/OutputRestApiRedactedField21788a25ef22" }, "type": "array" } }, "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "created_by": { "description": "The ID of the role that created the page", "type": "string" }, "function_id": { "description": "The ID of the Rippling Function that renders this page", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The display name of the custom page", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "updated_by": { "description": "The ID of the role that last modified the page", "type": "string" } }, "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Retrieve a specific CustomPage", "x-rippling-entitlements": [ "Custom_Apps_Platform_API" ], "x-rippling-required-scopes": [ "custom-pages.read" ] }, "patch": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/update-custom-pages" }, "operationId": "rippling.rest_api.update_custom_pages", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "id", "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiCustomPageRequest2e7e485fe8d2" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "created_by": { "description": "The ID of the role that created the page", "type": "string" }, "function_id": { "description": "The ID of the Rippling Function that renders this page", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The display name of the custom page", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "updated_by": { "description": "The ID of the role that last modified the page", "type": "string" } }, "title": "CustomPage", "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Update a CustomPage", "x-rippling-entitlements": [ "Custom_Apps_Platform_API" ], "x-rippling-required-scopes": [ "custom-pages.read-write" ] } }, "/custom-settings/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/list-custom-settings" }, "operationId": "rippling.rest_api.list_custom_settings", "parameters": [ { "in": "query", "name": "order_by", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 100, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "__meta": { "$ref": "#/components/schemas/OutputRestApiRedactedFields9f7657dc2a2f" }, "next_link": { "description": "A link to the next page of responses.", "format": "uri", "type": "string" }, "results": { "items": { "$ref": "#/components/schemas/OutputRestApiSetting595200321ea7" }, "type": "array" } }, "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "List Setting", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "custom-settings.read" ] }, "post": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/create-custom-settings" }, "operationId": "rippling.rest_api.create_custom_settings", "parameters": [ { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiSettingRequest17d90ee259ac" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "api_name": { "description": "The unique api name of the setting", "type": "string" }, "boolean_value": { "description": "Boolean value of the setting, if it has boolean data type", "type": "boolean" }, "created_at": { "description": "Record creation date", "type": "string" }, "data_type": { "description": "Data type of the setting", "type": "string" }, "display_name": { "description": "The display name of setting", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "number_value": { "anyOf": [ { "description": "Number value of the setting, if it has number data type", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "secret_value": { "description": "Secret value of the setting, if it has secret data type", "type": "string" }, "string_value": { "description": "String value of the setting, if it has string data type", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Setting", "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Create a new Setting", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "custom-settings.read-write" ] } }, "/custom-settings/{id}/": { "delete": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/delete-custom-settings" }, "operationId": "rippling.rest_api.delete_custom_settings", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "id", "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "204": { "description": "The resource was deleted successfully" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Delete a Setting", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "custom-settings.read-write" ] }, "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/get-custom-settings" }, "operationId": "rippling.rest_api.get_custom_settings", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "id", "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "__meta": { "properties": { "redacted_fields": { "items": { "$ref": "#/components/schemas/OutputRestApiRedactedField21788a25ef22" }, "type": "array" } }, "type": "object" }, "api_name": { "description": "The unique api name of the setting", "type": "string" }, "boolean_value": { "description": "Boolean value of the setting, if it has boolean data type", "type": "boolean" }, "created_at": { "description": "Record creation date", "type": "string" }, "data_type": { "description": "Data type of the setting", "type": "string" }, "display_name": { "description": "The display name of setting", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "number_value": { "anyOf": [ { "description": "Number value of the setting, if it has number data type", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "secret_value": { "description": "Secret value of the setting, if it has secret data type", "type": "string" }, "string_value": { "description": "String value of the setting, if it has string data type", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Retrieve a specific Setting", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "custom-settings.read" ] }, "patch": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/update-custom-settings" }, "operationId": "rippling.rest_api.update_custom_settings", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "id", "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiSettingRequest17d90ee259ac" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "api_name": { "description": "The unique api name of the setting", "type": "string" }, "boolean_value": { "description": "Boolean value of the setting, if it has boolean data type", "type": "boolean" }, "created_at": { "description": "Record creation date", "type": "string" }, "data_type": { "description": "Data type of the setting", "type": "string" }, "display_name": { "description": "The display name of setting", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "number_value": { "anyOf": [ { "description": "Number value of the setting, if it has number data type", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "secret_value": { "description": "Secret value of the setting, if it has secret data type", "type": "string" }, "string_value": { "description": "String value of the setting, if it has string data type", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Setting", "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Update a Setting", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "custom-settings.read-write" ] } }, "/departments/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/list-departments" }, "operationId": "rippling.rest_api.list_departments", "parameters": [ { "in": "query", "name": "expand", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 100, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "__meta": { "$ref": "#/components/schemas/OutputRestApiRedactedFields9f7657dc2a2f" }, "next_link": { "description": "A link to the next page of responses.", "format": "uri", "type": "string" }, "results": { "items": { "$ref": "#/components/schemas/OutputRestApiDepartment03eb5a225da5" }, "type": "array" } }, "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "List departments", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "departments.read" ] }, "post": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/create-departments" }, "operationId": "rippling.rest_api.create_departments", "parameters": [ { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiDepartmentRequest07aab47a5cd2" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "department_hierarchy": { "description": "List of departments in the department hierarchy. Refer department_hierarchy_ids for department hierarchy order.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestDepartment" }, "type": "array" }, "department_hierarchy_id": { "description": "The identifier of departments in the department hierarchy ordered from parent department to child department.", "items": { "type": "string" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the department.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestDepartment", "description": "The parent department.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent department.", "type": "string" }, "reference_code": { "description": "Reference code of the department.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Department", "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Create a new department", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "departments.read-write" ] } }, "/departments/{id}/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/get-departments" }, "operationId": "rippling.rest_api.get_departments", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "id", "type": "string" } }, { "in": "query", "name": "expand", "required": false, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "__meta": { "properties": { "redacted_fields": { "items": { "$ref": "#/components/schemas/OutputRestApiRedactedField21788a25ef22" }, "type": "array" } }, "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "department_hierarchy": { "description": "List of departments in the department hierarchy. Refer department_hierarchy_ids for department hierarchy order.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestDepartment" }, "type": "array" }, "department_hierarchy_id": { "description": "The identifier of departments in the department hierarchy ordered from parent department to child department.", "items": { "type": "string" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the department.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestDepartment", "description": "The parent department.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent department.", "type": "string" }, "reference_code": { "description": "Reference code of the department.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Retrieve a specific department", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "departments.read" ] }, "patch": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/update-departments" }, "operationId": "rippling.rest_api.update_departments", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "id", "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiDepartmentUpdateRequest100ac2202a91" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "department_hierarchy": { "description": "List of departments in the department hierarchy. Refer department_hierarchy_ids for department hierarchy order.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestDepartment" }, "type": "array" }, "department_hierarchy_id": { "description": "The identifier of departments in the department hierarchy ordered from parent department to child department.", "items": { "type": "string" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the department.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestDepartment", "description": "The parent department.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent department.", "type": "string" }, "reference_code": { "description": "Reference code of the department.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Department", "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Update a department", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "departments.read-write" ] } }, "/developer-program-application/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/list-developer-program-application" }, "operationId": "rippling.rest_api.list_developer_program_application", "parameters": [ { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "__meta": { "$ref": "#/components/schemas/OutputRestApiRedactedFields9f7657dc2a2f" }, "next_link": { "description": "A link to the next page of responses.", "format": "uri", "type": "string" }, "results": { "items": { "$ref": "#/components/schemas/OutputRestApiDeveloperProgramApplyDTOd3d31f8b663b" }, "type": "array" } }, "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "List developer program application", "x-rippling-entitlements": [ "Developer_Program" ], "x-rippling-required-scopes": [ "developer-program-application.read" ] }, "post": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/create-developer-program-application" }, "operationId": "rippling.rest_api.create_developer_program_application", "parameters": [ { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiDeveloperProgramApplyDTORequest318382c66db1" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Developer Program application resource for Path B existing-company apply.", "properties": { "build_description": { "description": "What the company plans to build on Rippling", "type": "string" }, "company_id": { "description": "Rippling company ID on the application", "type": "string" }, "email": { "description": "Applicant email on the application", "type": "string" }, "expires_at": { "description": "Time after which ops can no longer approve this pending application", "type": "string" }, "id": { "description": "Stable application ID", "type": "string" }, "role_id": { "description": "Applicant role ID", "type": "string" }, "signup_id": { "description": "Deprecated alias of id. Prefer id.", "type": "string" }, "stages": { "description": "Application checklist stages", "properties": { "access_ready": { "description": "Whether ops approved the application and provisioning is pending", "type": "boolean" }, "application_submitted": { "description": "Whether the application has been submitted", "type": "boolean" }, "email_confirmed": { "description": "Whether the applicant email is confirmed", "type": "boolean" }, "start_building": { "description": "Whether Developer Program access has been provisioned", "type": "boolean" } }, "title": "DeveloperProgramApplicationStagesDTO", "type": "object" }, "status": { "description": "Application status: EMAIL_VERIFICATION_PENDING, SUBMITTED, APPROVED, VERIFIED, REJECTED, or EXPIRED. Existing-company apply writes SUBMITTED and never EMAIL_VERIFICATION_PENDING. VERIFIED means provision finished, not email verified.", "type": "string" }, "submitted_at": { "description": "Time the application was submitted", "type": "string" } }, "required": [ "id" ], "title": "DeveloperProgramApplyDTO", "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Create a new developer program application", "x-rippling-entitlements": [ "Developer_Program" ], "x-rippling-required-scopes": [ "developer-program-application.read-write" ] } }, "/developer-users/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/list-developer-users" }, "operationId": "rippling.rest_api.list_developer_users", "parameters": [ { "in": "query", "name": "filter", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 100, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "__meta": { "$ref": "#/components/schemas/OutputRestApiRedactedFields9f7657dc2a2f" }, "next_link": { "description": "A link to the next page of responses.", "format": "uri", "type": "string" }, "results": { "items": { "$ref": "#/components/schemas/OutputRestApiDeveloperUserDTO2e062bd465c2" }, "type": "array" } }, "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "List App Shop publisher users", "x-rippling-entitlements": [ "Developer_Program" ], "x-rippling-required-scopes": [ "developer-users.read" ] } }, "/device-orders/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/list-device-orders" }, "operationId": "rippling.rest_api.list_device_orders", "parameters": [ { "in": "query", "name": "filter", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "expand", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 100, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "__meta": { "$ref": "#/components/schemas/OutputRestApiRedactedFields9f7657dc2a2f" }, "next_link": { "description": "A link to the next page of responses.", "format": "uri", "type": "string" }, "results": { "items": { "$ref": "#/components/schemas/OutputRestApiDeviceOrder39314fd30d88" }, "type": "array" } }, "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "List device orders", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "device-orders.read" ] } }, "/device-orders/{id}/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/get-device-orders" }, "operationId": "rippling.rest_api.get_device_orders", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "id", "type": "string" } }, { "in": "query", "name": "expand", "required": false, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "__meta": { "properties": { "redacted_fields": { "items": { "$ref": "#/components/schemas/OutputRestApiRedactedField21788a25ef22" }, "type": "array" } }, "type": "object" }, "cancel_requested": { "description": "True when a cancellation has been requested but not yet completed.", "type": "boolean" }, "completed_at": { "description": "When the order reached a terminal state (COMPLETED, FAILED, or CANCELED).", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "order_type": { "description": "The type of hardware order, as reported by the underlying inventory order (for example: New Device Order, Warehouse Return, Warehouse Order, Add Existing Device, Assign Device, Empty Order, or Sell Device).", "type": "string" }, "requested_by_id": { "description": "The ID of the role that requested the order (often an IT admin). Null if system-created.", "type": "string" }, "status": { "description": "The order lifecycle state (InventoryFlowState): CREATED, RUNNING, COMPLETED, FAILED, CANCELING, CANCELED.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "warehouse_provider": { "description": "The warehouse / vendor provider servicing the order (e.g. CDW, INGRAMMICRO, TD_SYNNEX, GROWRK).", "type": "string" }, "worker": { "description": "The worker the order is for.\n\nExpandable field", "properties": { "business_partners": { "description": "Worker's assigned business partners. This field is only populated when explicitly requested via the expand parameter (e.g., ?expand=business_partners). When expanded, returns an empty list ([]) if the worker has no business partners.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiBusinessPartner77b00a069c32" }, "type": "array" }, "business_partners_id": { "description": "Worker's assigned business partners unique identifiers. Returns an empty list ([]) if the worker has no business partners.", "items": { "type": "string" }, "type": "array" }, "citizenship": { "description": "The countries that the worker has citizenship in.", "type": "string" }, "compensation": { "description": "The compensation package for the worker.\n\nExpandable field", "properties": { "annual_compensation": { "description": "The worker's annual compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "annual_salary_equivalent": { "description": "The worker's annual salary equivalent, for insurance purposes. It will be equal to the worker's annual compensation, except for owners that are receiving no cashcompensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "bonus_schedule": { "description": "The worker's bonus schedule.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "hourly_wage": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "id": { "description": "Identifier field", "type": "string" }, "monthly_compensation": { "description": "The worker's monthly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "on_target_commission": { "description": "The worker's on-target commission.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "payment_terms": { "description": "The payment terms for an worker's compensation.", "type": "string" }, "payment_type": { "description": "The payment type for an worker's compensation.", "type": "string" }, "relocation_reimbursement": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "salary_effective_date": { "description": "Salary effective date", "type": "string" }, "signing_bonus": { "description": "The worker's signing bonus.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus": { "description": "The worker's target annual bonus amount.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus_percent": { "anyOf": [ { "description": "The worker's target annual bonus as a percent of annual compensation.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" }, "weekly_compensation": { "description": "The worker's weekly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "worker": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's details.\n\nExpandable field", "type": "object" }, "worker_id": { "description": "The worker's ID.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Compensation", "type": "object" }, "compensation_grade": { "description": "The compensation grade assigned to the worker, if any.", "properties": { "id": { "description": "The compensation grade's unique identifier.", "type": "string" }, "label": { "description": "The compensation grade's label.", "type": "string" } }, "title": "WorkerCompensationGrade", "type": "object" }, "compensation_id": { "description": "The compensation package for the worker.", "type": "string" }, "country": { "description": "The worker's country.", "type": "string" }, "country_fields": { "description": "Country level fields for the worker.", "properties": { "ca": { "description": "Country-wise regional fields for Canada", "properties": { "sin": { "description": "Social Insurance Number (SIN) for Canada employees.", "type": "string" } }, "title": "CanadaFields", "type": "object" }, "nz": { "description": "Country-wise regional fields for New Zealand", "properties": { "ird_number": { "description": "Inland Revenue Department (IRD) number for New Zealand employees.", "type": "string" } }, "title": "NewZealandFields", "type": "object" }, "us": { "description": "Country-wise regional fields for USA", "properties": { "ssn": { "description": "Social Security Number (SSN) for US employees.", "type": "string" } }, "title": "USFields", "type": "object" } }, "title": "CountryFields", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "custom_fields": { "description": "Custom field values defined on the Employee object for this worker\n\nExpandable field", "items": { "additionalProperties": {} }, "type": "array" }, "date_of_birth": { "description": "The worker's date of birth.", "type": "string" }, "department": { "description": "The worker's assigned department.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "department_hierarchy": { "description": "List of departments in the department hierarchy. Refer department_hierarchy_ids for department hierarchy order.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestDepartment" }, "type": "array" }, "department_hierarchy_id": { "description": "The identifier of departments in the department hierarchy ordered from parent department to child department.", "items": { "type": "string" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the department.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestDepartment", "description": "The parent department.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent department.", "type": "string" }, "reference_code": { "description": "Reference code of the department.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Department", "type": "object" }, "department_id": { "description": "The worker's assigned department.", "type": "string" }, "employment_type": { "description": "The worker's employment type.\n\nExpandable field", "properties": { "amount_worked": { "description": "The amount worked for the employment type. * `FULL-TIME`: Full-time is at least 30 hours per week. Full-time workers will typically be eligible for benefits. * `PART-TIME`: Part-time is less than 30 hours per week. These workers may be eligible for benefits, depending on company settings and hours worked. * `TEMPORARY`: These workers are hired on a temporary basis. You can specify how each worker with this employment type will be paid individually.", "type": "string" }, "compensation_time_period": { "description": "The compensation period for the employment type. * `SALARIED`: Employees that are paid a fixed amount per year. * `HOURLY`: Employees that are paid a wage per hour worked.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "label": { "description": "The display label of the employment type.", "type": "string" }, "name": { "description": "The name of the employment type for non-custom employment types.", "type": "string" }, "type": { "description": "The classification of the worker by the company. * `CONTRACTOR`: Contractors are self-employed workers who provide services on a short-term or per-project basis and are not eligible for tax-withholding or benefits. * `EMPLOYEE`: Employees are hired and managed by an employer, work under the employer's direct supervision and control, and are protected by law for wages and employment rights.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "label", "updated_at" ], "title": "CompanyEmploymentType", "type": "object" }, "employment_type_id": { "description": "The worker's employment type.", "type": "string" }, "end_date": { "description": "The end date of the worker.", "type": "string" }, "ethnicity": { "description": "The identified ethnicity of the worker, if specified.", "type": "string" }, "gender": { "description": "The gender of the worker, if specified.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_manager": { "description": "Whether the worker is a manager", "type": "boolean" }, "job_function": { "description": "The worker's job function. When expanded, this field requires `job-functions.read`.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "Displayed name of the job function", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "JobFunction", "type": "object" }, "job_function_id": { "description": "ID of the worker's job function.", "type": "string" }, "legal_entity": { "description": "The worker's associated legal entity.\n\nExpandable field", "properties": { "company": { "description": "The company or organization associated with the legal entity\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "doing_business_as_name": { "description": "The doing business as name for the company.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_entities": { "description": "A list of the company's entities.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestLegalEntity" }, "type": "array" }, "legal_entities_id": { "description": "A list of the company's entities.", "items": { "type": "string" }, "type": "array" }, "legal_name": { "description": "The legal name of the company.", "type": "string" }, "name": { "description": "The name of the company.", "type": "string" }, "parent_legal_entity": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The company's ultimate holding entity.\n\nExpandable field", "type": "object" }, "parent_legal_entity_id": { "description": "The company's ultimate holding entity.", "type": "string" }, "phone": { "description": "The phone number for the company.", "type": "string" }, "physical_address": { "description": "The physical address of the holding entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "primary_email": { "description": "The email address used when registering this company.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "legal_entities", "legal_entities_id", "name", "updated_at" ], "title": "Company", "type": "object" }, "company_id": { "description": "The company or organization associated with the legal entity", "type": "string" }, "country": { "description": "The country the legal entity is based in.", "properties": { "code": { "description": "The code of the country.", "type": "string" } }, "required": [ "code" ], "title": "Country", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "entity_level": { "description": "The legal entity's level in a hierarchy. * `PARENT`: The legal entity is considered the ultimate holding entity. * `SUBSIDIARY`: The legal entity is considered a subsidiary, fully or partially held by another. * `BRANCH`: The legal entity is considered a branch, associated with a parent legal entity.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_name": { "description": "The legal name of the legal entity.", "type": "string" }, "mailing_address": { "description": "The mailing address of the legal entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "management_type": { "description": "The legal entity management type in the case of an employer of record (EOR) or professional employment organization (PEO). * `PEO`: The legal entity is considered a Professional Employment Organization (PEO). * `EOR`: The legal entity is considered an Employer of Record (EOR).", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The parent legal entity.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent legal entity.", "type": "string" }, "physical_address": { "description": "The physical address of the legal entity, if it differs from the mailing address.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "registration_date": { "description": "The registration date of the entity.", "type": "string" }, "tax_identifier": { "description": "The tax identifier for the legal entity.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "LegalEntity", "type": "object" }, "legal_entity_id": { "description": "The worker's associated legal entity.", "type": "string" }, "level": { "description": "The level of the worker.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "description": { "description": "The description of the level.", "type": "string" }, "experience_requirements": { "description": "The experience requirements for the level.", "type": "string" }, "global_level": { "anyOf": [ { "description": "Global level is used to track the seniority of levels. The higher up a level is placed on the page, the more senior and higher-ranked the level. Global level is used in workflows, policies, and reports that use the level attribute (e.g., you can use Level Lookup to set up a workflow that notifies the nearest person in an worker's management chain at or above the specified level).", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the level. Must be unique within the company or organization.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLevel", "description": "The parent level.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent level.", "type": "string" }, "rank": { "anyOf": [ { "description": "The rank of the level within its track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "scope_of_responsibilities": { "description": "The scope of responsibilities for the level.", "type": "string" }, "track": { "description": "The track associated with the level, if it's not a global level.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_default": { "description": "Whether this is the company's default track.", "type": "boolean" }, "name": { "description": "The name of the track. Must be unique within the company or organization.", "type": "string" }, "order": { "anyOf": [ { "description": "The one-based horizontal display order of the track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "start_global_level": { "anyOf": [ { "description": "The highest global level occupied by this track. Empty tracks return null.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Track", "type": "object" }, "track_id": { "description": "The track associated with the level. Required during creation. Include global_level when changing it.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Level", "type": "object" }, "level_id": { "description": "The level of the worker.", "type": "string" }, "location": { "description": "The location that the worker is mapped to for tax purposes. In the case that a worker is remote, the location's type is remote.", "properties": { "type": { "description": "The type of location.", "type": "string" }, "work_location_id": { "description": "The work location, if the worker isn't remote.", "type": "string" } }, "required": [ "type", "work_location_id" ], "title": "WorkerLocation", "type": "object" }, "manager": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's manager.\n\nExpandable field", "type": "object" }, "manager_id": { "description": "The worker's manager.", "type": "string" }, "number": { "anyOf": [ { "description": "The worker's number within the organization.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "original_start_date": { "description": "The worker's earliest start date across their employment history, excluding INIT roles.", "type": "string" }, "overtime_exemption": { "description": "The worker's overtime exemption status.", "type": "string" }, "pay_schedule_id": { "description": "The ID of the pay schedule currently associated with the worker.", "type": "string" }, "personal_email": { "description": "The worker's associated personal email address.", "type": "string" }, "race": { "description": "The identified race of the worker, if specified.", "type": "string" }, "start_date": { "description": "The start date of the worker.", "type": "string" }, "status": { "description": "The worker's status within the organization.", "type": "string" }, "teams": { "description": "The worker's assigned teams.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiTeamcb26bc28f32f" }, "type": "array" }, "teams_id": { "description": "The worker's assigned teams.", "items": { "type": "string" }, "type": "array" }, "termination_details": { "description": "The details of the worker's termination, if applicable.", "properties": { "reason": { "description": "This is a description that will be custom to each Rippling company.", "type": "string" }, "type": { "description": "The termination type indicates whether the termination was voluntary or involuntary.", "type": "string" } }, "title": "TerminationDetails", "type": "object" }, "title": { "description": "The worker's title.", "type": "string" }, "title_effective_date": { "description": "Title effective date", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "user": { "description": "The worker's associated user.\n\nExpandable field", "properties": { "active": { "description": "Whether the user is able to access company resources, typically when they are in actively engaged with the company and not after off-boarding.", "type": "boolean" }, "addresses": { "description": "The user's addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiUserAddressedd59b9ba9a1" }, "type": "array" }, "created_at": { "description": "Record creation date", "type": "string" }, "display_name": { "description": "The display name of the user using either the concatenated preferred given and family name or username depending on availability.", "type": "string" }, "emails": { "description": "The user's email addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiEmail5284c8258dc3" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "locale": { "description": "The User's default location for purposes of localization of currency, date time format, or numerical representations pursuant to RFC5646.", "type": "string" }, "name": { "description": "The user's name.", "properties": { "family_name": { "description": "The legal family name of the user, or last name in most Western languages.", "type": "string" }, "formatted": { "description": "The user's full name.", "type": "string" }, "given_name": { "description": "The given legal name of the user, or first name in most Western languages.", "type": "string" }, "middle_name": { "description": "The middle name(s) of the user.", "type": "string" }, "preferred_family_name": { "description": "The preferred family name, or last name in most Western languages, by the user.", "type": "string" }, "preferred_given_name": { "description": "The preferred given name, or first name in most Western languages, by the user.", "type": "string" } }, "title": "UserName", "type": "object" }, "number": { "description": "The permanent profile number of the user.", "type": "string" }, "phone_numbers": { "description": "The user's phone numbers.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoneNumber12060c61ecf5" }, "type": "array" }, "photos": { "description": "The user's photos.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoto2be7c3ae3f39" }, "type": "array" }, "preferred_language": { "description": "The User's preferred written or spoken language in the same format of the HTTP Accept-Language header, pursuant to Section 5.3.5 of RFC7231.", "type": "string" }, "timezone": { "description": "The User's current time zone in IANA database Olson format", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "username": { "description": "The unique identifier across Rippling used by the User for direct authentication into their associated company. Globally unique.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "User", "type": "object" }, "user_id": { "description": "The worker's associated user.", "type": "string" }, "work_email": { "description": "The worker's associated work email address.", "type": "string" }, "work_schedule": { "additionalProperties": { "$ref": "#/components/schemas/OutputRestApiWorkScheduleDay938f88d94f20" }, "description": "The worker's scheduled working hours for each day of the week.", "type": "object" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Worker", "type": "object" }, "worker_id": { "description": "The ID of the worker the order is for (the recipient). Null if unassigned.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Retrieve a specific device order", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "device-orders.read" ] } }, "/devices/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/list-devices" }, "operationId": "rippling.rest_api.list_devices", "parameters": [ { "in": "query", "name": "filter", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "expand", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 100, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "__meta": { "$ref": "#/components/schemas/OutputRestApiRedactedFields9f7657dc2a2f" }, "next_link": { "description": "A link to the next page of responses.", "format": "uri", "type": "string" }, "results": { "items": { "$ref": "#/components/schemas/OutputRestApiDeviceaf98aca9e7fb" }, "type": "array" } }, "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "List devices", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "devices.read" ] } }, "/devices/{id}/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/get-devices" }, "operationId": "rippling.rest_api.get_devices", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "id", "type": "string" } }, { "in": "query", "name": "expand", "required": false, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "__meta": { "properties": { "redacted_fields": { "items": { "$ref": "#/components/schemas/OutputRestApiRedactedField21788a25ef22" }, "type": "array" } }, "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "enrollment_status": { "description": "The MDM enrollment status: ENROLLED, UNENROLLED, WAITING_FOR_CONNECTION, ERROR, etc.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_encrypted": { "description": "Whether the device's disk is encrypted (FileVault on macOS, BitLocker on Windows).", "type": "boolean" }, "is_managed": { "description": "Whether the device is managed via MDM.", "type": "boolean" }, "last_checkin_at": { "description": "When the Rippling agent last checked in from this device.", "type": "string" }, "last_mdm_sync_at": { "description": "When the device last synced with MDM.", "type": "string" }, "lifecycle_state": { "description": "The device lifecycle state (e.g. ACTIVE, READY, LOCKED, LOST, DECOMMISSIONED).", "type": "string" }, "mdm_provider": { "description": "The MDM provider currently recorded on the device (RIPPLING, JAMFCLOUD, INTUNE, KANDJI, etc.). Null when the device is not currently MDM-managed (typical for unenrolled or recently-reset devices).", "type": "string" }, "model": { "description": "The device hardware model identifier as reported by MDM (e.g. 'MacBookPro18,3', 'iPhone15,2').", "type": "string" }, "os_name": { "description": "The device operating system name.", "type": "string" }, "os_version": { "description": "The device operating system version.", "type": "string" }, "pending_actions": { "description": "Actions currently queued against the device (not yet completed). Expandable.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiDevicePendingActiona50f0a777ce1" }, "type": "array" }, "pending_actions_id": { "description": "The IDs of actions currently queued against the device (not yet completed).", "items": { "type": "string" }, "type": "array" }, "platform": { "description": "The OS platform the device runs: MACOS, WINDOWS, IOS, or IPADOS.", "type": "string" }, "serial_number": { "description": "The device's hardware serial number.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "worker": { "description": "The worker this device is currently assigned to.\n\nExpandable field", "properties": { "business_partners": { "description": "Worker's assigned business partners. This field is only populated when explicitly requested via the expand parameter (e.g., ?expand=business_partners). When expanded, returns an empty list ([]) if the worker has no business partners.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiBusinessPartner77b00a069c32" }, "type": "array" }, "business_partners_id": { "description": "Worker's assigned business partners unique identifiers. Returns an empty list ([]) if the worker has no business partners.", "items": { "type": "string" }, "type": "array" }, "citizenship": { "description": "The countries that the worker has citizenship in.", "type": "string" }, "compensation": { "description": "The compensation package for the worker.\n\nExpandable field", "properties": { "annual_compensation": { "description": "The worker's annual compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "annual_salary_equivalent": { "description": "The worker's annual salary equivalent, for insurance purposes. It will be equal to the worker's annual compensation, except for owners that are receiving no cashcompensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "bonus_schedule": { "description": "The worker's bonus schedule.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "hourly_wage": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "id": { "description": "Identifier field", "type": "string" }, "monthly_compensation": { "description": "The worker's monthly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "on_target_commission": { "description": "The worker's on-target commission.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "payment_terms": { "description": "The payment terms for an worker's compensation.", "type": "string" }, "payment_type": { "description": "The payment type for an worker's compensation.", "type": "string" }, "relocation_reimbursement": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "salary_effective_date": { "description": "Salary effective date", "type": "string" }, "signing_bonus": { "description": "The worker's signing bonus.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus": { "description": "The worker's target annual bonus amount.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus_percent": { "anyOf": [ { "description": "The worker's target annual bonus as a percent of annual compensation.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" }, "weekly_compensation": { "description": "The worker's weekly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "worker": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's details.\n\nExpandable field", "type": "object" }, "worker_id": { "description": "The worker's ID.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Compensation", "type": "object" }, "compensation_grade": { "description": "The compensation grade assigned to the worker, if any.", "properties": { "id": { "description": "The compensation grade's unique identifier.", "type": "string" }, "label": { "description": "The compensation grade's label.", "type": "string" } }, "title": "WorkerCompensationGrade", "type": "object" }, "compensation_id": { "description": "The compensation package for the worker.", "type": "string" }, "country": { "description": "The worker's country.", "type": "string" }, "country_fields": { "description": "Country level fields for the worker.", "properties": { "ca": { "description": "Country-wise regional fields for Canada", "properties": { "sin": { "description": "Social Insurance Number (SIN) for Canada employees.", "type": "string" } }, "title": "CanadaFields", "type": "object" }, "nz": { "description": "Country-wise regional fields for New Zealand", "properties": { "ird_number": { "description": "Inland Revenue Department (IRD) number for New Zealand employees.", "type": "string" } }, "title": "NewZealandFields", "type": "object" }, "us": { "description": "Country-wise regional fields for USA", "properties": { "ssn": { "description": "Social Security Number (SSN) for US employees.", "type": "string" } }, "title": "USFields", "type": "object" } }, "title": "CountryFields", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "custom_fields": { "description": "Custom field values defined on the Employee object for this worker\n\nExpandable field", "items": { "additionalProperties": {} }, "type": "array" }, "date_of_birth": { "description": "The worker's date of birth.", "type": "string" }, "department": { "description": "The worker's assigned department.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "department_hierarchy": { "description": "List of departments in the department hierarchy. Refer department_hierarchy_ids for department hierarchy order.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestDepartment" }, "type": "array" }, "department_hierarchy_id": { "description": "The identifier of departments in the department hierarchy ordered from parent department to child department.", "items": { "type": "string" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the department.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestDepartment", "description": "The parent department.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent department.", "type": "string" }, "reference_code": { "description": "Reference code of the department.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Department", "type": "object" }, "department_id": { "description": "The worker's assigned department.", "type": "string" }, "employment_type": { "description": "The worker's employment type.\n\nExpandable field", "properties": { "amount_worked": { "description": "The amount worked for the employment type. * `FULL-TIME`: Full-time is at least 30 hours per week. Full-time workers will typically be eligible for benefits. * `PART-TIME`: Part-time is less than 30 hours per week. These workers may be eligible for benefits, depending on company settings and hours worked. * `TEMPORARY`: These workers are hired on a temporary basis. You can specify how each worker with this employment type will be paid individually.", "type": "string" }, "compensation_time_period": { "description": "The compensation period for the employment type. * `SALARIED`: Employees that are paid a fixed amount per year. * `HOURLY`: Employees that are paid a wage per hour worked.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "label": { "description": "The display label of the employment type.", "type": "string" }, "name": { "description": "The name of the employment type for non-custom employment types.", "type": "string" }, "type": { "description": "The classification of the worker by the company. * `CONTRACTOR`: Contractors are self-employed workers who provide services on a short-term or per-project basis and are not eligible for tax-withholding or benefits. * `EMPLOYEE`: Employees are hired and managed by an employer, work under the employer's direct supervision and control, and are protected by law for wages and employment rights.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "label", "updated_at" ], "title": "CompanyEmploymentType", "type": "object" }, "employment_type_id": { "description": "The worker's employment type.", "type": "string" }, "end_date": { "description": "The end date of the worker.", "type": "string" }, "ethnicity": { "description": "The identified ethnicity of the worker, if specified.", "type": "string" }, "gender": { "description": "The gender of the worker, if specified.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_manager": { "description": "Whether the worker is a manager", "type": "boolean" }, "job_function": { "description": "The worker's job function. When expanded, this field requires `job-functions.read`.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "Displayed name of the job function", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "JobFunction", "type": "object" }, "job_function_id": { "description": "ID of the worker's job function.", "type": "string" }, "legal_entity": { "description": "The worker's associated legal entity.\n\nExpandable field", "properties": { "company": { "description": "The company or organization associated with the legal entity\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "doing_business_as_name": { "description": "The doing business as name for the company.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_entities": { "description": "A list of the company's entities.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestLegalEntity" }, "type": "array" }, "legal_entities_id": { "description": "A list of the company's entities.", "items": { "type": "string" }, "type": "array" }, "legal_name": { "description": "The legal name of the company.", "type": "string" }, "name": { "description": "The name of the company.", "type": "string" }, "parent_legal_entity": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The company's ultimate holding entity.\n\nExpandable field", "type": "object" }, "parent_legal_entity_id": { "description": "The company's ultimate holding entity.", "type": "string" }, "phone": { "description": "The phone number for the company.", "type": "string" }, "physical_address": { "description": "The physical address of the holding entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "primary_email": { "description": "The email address used when registering this company.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "legal_entities", "legal_entities_id", "name", "updated_at" ], "title": "Company", "type": "object" }, "company_id": { "description": "The company or organization associated with the legal entity", "type": "string" }, "country": { "description": "The country the legal entity is based in.", "properties": { "code": { "description": "The code of the country.", "type": "string" } }, "required": [ "code" ], "title": "Country", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "entity_level": { "description": "The legal entity's level in a hierarchy. * `PARENT`: The legal entity is considered the ultimate holding entity. * `SUBSIDIARY`: The legal entity is considered a subsidiary, fully or partially held by another. * `BRANCH`: The legal entity is considered a branch, associated with a parent legal entity.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_name": { "description": "The legal name of the legal entity.", "type": "string" }, "mailing_address": { "description": "The mailing address of the legal entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "management_type": { "description": "The legal entity management type in the case of an employer of record (EOR) or professional employment organization (PEO). * `PEO`: The legal entity is considered a Professional Employment Organization (PEO). * `EOR`: The legal entity is considered an Employer of Record (EOR).", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The parent legal entity.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent legal entity.", "type": "string" }, "physical_address": { "description": "The physical address of the legal entity, if it differs from the mailing address.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "registration_date": { "description": "The registration date of the entity.", "type": "string" }, "tax_identifier": { "description": "The tax identifier for the legal entity.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "LegalEntity", "type": "object" }, "legal_entity_id": { "description": "The worker's associated legal entity.", "type": "string" }, "level": { "description": "The level of the worker.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "description": { "description": "The description of the level.", "type": "string" }, "experience_requirements": { "description": "The experience requirements for the level.", "type": "string" }, "global_level": { "anyOf": [ { "description": "Global level is used to track the seniority of levels. The higher up a level is placed on the page, the more senior and higher-ranked the level. Global level is used in workflows, policies, and reports that use the level attribute (e.g., you can use Level Lookup to set up a workflow that notifies the nearest person in an worker's management chain at or above the specified level).", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the level. Must be unique within the company or organization.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLevel", "description": "The parent level.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent level.", "type": "string" }, "rank": { "anyOf": [ { "description": "The rank of the level within its track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "scope_of_responsibilities": { "description": "The scope of responsibilities for the level.", "type": "string" }, "track": { "description": "The track associated with the level, if it's not a global level.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_default": { "description": "Whether this is the company's default track.", "type": "boolean" }, "name": { "description": "The name of the track. Must be unique within the company or organization.", "type": "string" }, "order": { "anyOf": [ { "description": "The one-based horizontal display order of the track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "start_global_level": { "anyOf": [ { "description": "The highest global level occupied by this track. Empty tracks return null.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Track", "type": "object" }, "track_id": { "description": "The track associated with the level. Required during creation. Include global_level when changing it.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Level", "type": "object" }, "level_id": { "description": "The level of the worker.", "type": "string" }, "location": { "description": "The location that the worker is mapped to for tax purposes. In the case that a worker is remote, the location's type is remote.", "properties": { "type": { "description": "The type of location.", "type": "string" }, "work_location_id": { "description": "The work location, if the worker isn't remote.", "type": "string" } }, "required": [ "type", "work_location_id" ], "title": "WorkerLocation", "type": "object" }, "manager": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's manager.\n\nExpandable field", "type": "object" }, "manager_id": { "description": "The worker's manager.", "type": "string" }, "number": { "anyOf": [ { "description": "The worker's number within the organization.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "original_start_date": { "description": "The worker's earliest start date across their employment history, excluding INIT roles.", "type": "string" }, "overtime_exemption": { "description": "The worker's overtime exemption status.", "type": "string" }, "pay_schedule_id": { "description": "The ID of the pay schedule currently associated with the worker.", "type": "string" }, "personal_email": { "description": "The worker's associated personal email address.", "type": "string" }, "race": { "description": "The identified race of the worker, if specified.", "type": "string" }, "start_date": { "description": "The start date of the worker.", "type": "string" }, "status": { "description": "The worker's status within the organization.", "type": "string" }, "teams": { "description": "The worker's assigned teams.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiTeamcb26bc28f32f" }, "type": "array" }, "teams_id": { "description": "The worker's assigned teams.", "items": { "type": "string" }, "type": "array" }, "termination_details": { "description": "The details of the worker's termination, if applicable.", "properties": { "reason": { "description": "This is a description that will be custom to each Rippling company.", "type": "string" }, "type": { "description": "The termination type indicates whether the termination was voluntary or involuntary.", "type": "string" } }, "title": "TerminationDetails", "type": "object" }, "title": { "description": "The worker's title.", "type": "string" }, "title_effective_date": { "description": "Title effective date", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "user": { "description": "The worker's associated user.\n\nExpandable field", "properties": { "active": { "description": "Whether the user is able to access company resources, typically when they are in actively engaged with the company and not after off-boarding.", "type": "boolean" }, "addresses": { "description": "The user's addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiUserAddressedd59b9ba9a1" }, "type": "array" }, "created_at": { "description": "Record creation date", "type": "string" }, "display_name": { "description": "The display name of the user using either the concatenated preferred given and family name or username depending on availability.", "type": "string" }, "emails": { "description": "The user's email addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiEmail5284c8258dc3" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "locale": { "description": "The User's default location for purposes of localization of currency, date time format, or numerical representations pursuant to RFC5646.", "type": "string" }, "name": { "description": "The user's name.", "properties": { "family_name": { "description": "The legal family name of the user, or last name in most Western languages.", "type": "string" }, "formatted": { "description": "The user's full name.", "type": "string" }, "given_name": { "description": "The given legal name of the user, or first name in most Western languages.", "type": "string" }, "middle_name": { "description": "The middle name(s) of the user.", "type": "string" }, "preferred_family_name": { "description": "The preferred family name, or last name in most Western languages, by the user.", "type": "string" }, "preferred_given_name": { "description": "The preferred given name, or first name in most Western languages, by the user.", "type": "string" } }, "title": "UserName", "type": "object" }, "number": { "description": "The permanent profile number of the user.", "type": "string" }, "phone_numbers": { "description": "The user's phone numbers.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoneNumber12060c61ecf5" }, "type": "array" }, "photos": { "description": "The user's photos.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoto2be7c3ae3f39" }, "type": "array" }, "preferred_language": { "description": "The User's preferred written or spoken language in the same format of the HTTP Accept-Language header, pursuant to Section 5.3.5 of RFC7231.", "type": "string" }, "timezone": { "description": "The User's current time zone in IANA database Olson format", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "username": { "description": "The unique identifier across Rippling used by the User for direct authentication into their associated company. Globally unique.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "User", "type": "object" }, "user_id": { "description": "The worker's associated user.", "type": "string" }, "work_email": { "description": "The worker's associated work email address.", "type": "string" }, "work_schedule": { "additionalProperties": { "$ref": "#/components/schemas/OutputRestApiWorkScheduleDay938f88d94f20" }, "description": "The worker's scheduled working hours for each day of the week.", "type": "object" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Worker", "type": "object" }, "worker_id": { "description": "The ID of the worker this device is currently assigned to. Null if unassigned.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Retrieve a specific device", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "devices.read" ] } }, "/draft-hires/": { "post": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/create-draft-hires" }, "operationId": "rippling.rest_api.create_draft_hires", "parameters": [ { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiBulkDraftHireRequestb38591d07768" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Response model for bulk draft hire creation.", "properties": { "invalid_items": { "default": [], "description": "List of invalid draft hire requests", "items": { "$ref": "#/components/schemas/OutputRestApiDraftHireResult3d455f047883" }, "type": "array" }, "successful_results": { "description": "Detailed results for each draft hire item", "items": { "$ref": "#/components/schemas/OutputRestApiDraftHireResult3d455f047883" }, "type": "array" } }, "title": "CreateBulkDraftHireResponse", "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Create bulk draft hire", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "draft-hires.read-write" ] } }, "/draft-transitions/": { "post": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/create-draft-transitions" }, "operationId": "rippling.rest_api.create_draft_transitions", "parameters": [ { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiDraftTransitionCreateRequestRequest6cfa872c5e06" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "effective_at": { "description": "Effective timestamp applied to the entire draft transition request.", "type": "string" }, "items": { "description": "Draft transition items to accept for asynchronous processing.", "items": { "$ref": "#/components/schemas/OutputRestApiDraftTransitionItemRequestcef9f09f47d2" }, "type": "array" }, "timezone": { "description": "IANA timezone used to interpret and display the request's effective timestamp.", "type": "string" } }, "required": [ "effective_at", "items", "timezone" ], "title": "DraftTransitionCreateRequest", "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Create a new draft transition", "x-rippling-entitlements": [ "Draft_Transitions_API" ], "x-rippling-required-scopes": [ "draft-transitions.read-write" ] } }, "/draft-transitions/{id}/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/get-draft-transitions" }, "operationId": "rippling.rest_api.get_draft_transitions", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "id", "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "__meta": { "properties": { "redacted_fields": { "items": { "$ref": "#/components/schemas/OutputRestApiRedactedField21788a25ef22" }, "type": "array" } }, "type": "object" }, "effective_at": { "description": "Effective timestamp applied to the entire draft transition request.", "type": "string" }, "items": { "description": "Draft transition items to accept for asynchronous processing.", "items": { "$ref": "#/components/schemas/OutputRestApiDraftTransitionItemRequestcef9f09f47d2" }, "type": "array" }, "timezone": { "description": "IANA timezone used to interpret and display the request's effective timestamp.", "type": "string" } }, "required": [ "effective_at", "items", "timezone" ], "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Retrieve a specific draft transition", "x-rippling-entitlements": [ "Draft_Transitions_API" ], "x-rippling-required-scopes": [ "draft-transitions.read" ] } }, "/earning-types/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/list-earning-types" }, "operationId": "rippling.rest_api.list_earning_types", "parameters": [ { "in": "query", "name": "company_entity_id", "required": false, "schema": { "format": "id", "type": "string" } }, { "in": "query", "name": "country_code", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 100, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "__meta": { "$ref": "#/components/schemas/OutputRestApiRedactedFields9f7657dc2a2f" }, "next_link": { "description": "A link to the next page of responses.", "format": "uri", "type": "string" }, "results": { "items": { "$ref": "#/components/schemas/OutputRestApiEarningType291222bccebf" }, "type": "array" } }, "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "List earning-types", "x-rippling-entitlements": [ "Global_Payroll" ], "x-rippling-required-scopes": [ "earning-types.read" ] } }, "/earnings-inputs/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/list-earnings-inputs" }, "operationId": "rippling.rest_api.list_earnings_inputs", "parameters": [ { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 100, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "__meta": { "$ref": "#/components/schemas/OutputRestApiRedactedFields9f7657dc2a2f" }, "next_link": { "description": "A link to the next page of responses.", "format": "uri", "type": "string" }, "results": { "items": { "$ref": "#/components/schemas/OutputRestApiEarningsInput79a2565291ab" }, "type": "array" } }, "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "List earnings-inputs", "x-rippling-entitlements": [ "Global_Payroll" ], "x-rippling-required-scopes": [ "earnings-inputs.read" ] }, "post": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/create-earnings-inputs" }, "operationId": "rippling.rest_api.create_earnings_inputs", "parameters": [ { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiEarningsInputRequest89b4158946d7" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "\n V2 DTO representing an external earnings input record.\n\n Used by:\n - GET /earnings-inputs/ (list)\n ", "properties": { "amount": { "description": "Earning amount as a string-encoded decimal.", "type": "string" }, "assignment_type": { "description": "How the earning is assigned (e.g. BY_PAY_PERIOD).", "type": "string" }, "company_entity_id": { "description": "Identifier for the legal entity (company entity relationship) this earning is associated with. Use this to correlate earnings with a specific legal entity in a multi-entity company.", "type": "string" }, "earning_code": { "description": "Code identifying the earning type (e.g. regular_salary).", "type": "string" }, "earning_end_date": { "description": "End of the period this earning was earned. Used for regular-rate-of-pay (RROP) attribution. Distinct from pay_period_basis_date, which selects the pay run.", "type": "string" }, "earning_start_date": { "description": "Start of the period this earning was earned. Used for regular-rate-of-pay (RROP) attribution. Distinct from pay_period_basis_date, which selects the pay run.", "type": "string" }, "external_id": { "description": "External reference identifier for this earning.", "type": "string" }, "hours": { "description": "Hours associated with this earning as a string-encoded decimal.", "type": "string" }, "id": { "description": "Unique identifier for the earnings input.", "type": "string" }, "is_overridden": { "description": "Whether this earning's amount was manually overridden instead of using the calculated value. Always false for newly created earnings.", "type": "boolean" }, "pay_period_basis_date": { "description": "The pay period basis date for this earning.", "type": "string" }, "run_id": { "description": "Identifier of the payroll run this earning is assigned to, if any.", "type": "string" }, "status": { "description": "Current status of the earnings input (e.g. UNASSIGNED, ASSIGNED).", "type": "string" }, "time_labels": { "description": "Time tracking labels associated with this earning.", "items": { "type": "string" }, "type": "array" }, "worker_id": { "description": "Identifier of the worker (role ID).", "type": "string" } }, "title": "EarningsInput", "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Create a new earnings-input", "x-rippling-entitlements": [ "Global_Payroll" ], "x-rippling-required-scopes": [ "earnings-inputs.read-write" ] } }, "/earnings-inputs/{id}/": { "delete": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/delete-earnings-inputs" }, "operationId": "rippling.rest_api.delete_earnings_inputs", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "id", "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "204": { "description": "The resource was deleted successfully" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Delete a earnings-input", "x-rippling-entitlements": [ "Global_Payroll" ], "x-rippling-required-scopes": [ "earnings-inputs.read-write" ] } }, "/employee-documents/": { "post": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/create-employee-documents" }, "operationId": "rippling.rest_api.create_employee_documents", "parameters": [ { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiBulkEmployeeDocumentRequestRequest4e815c3ca0c5" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Top-level request body for `POST /employee-documents/`.", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "items": { "description": "List of role/document items to process. No limit on number of items; total documents across all items must not exceed 250.", "items": { "$ref": "#/components/schemas/OutputRestApiEmployeeDocumentItema59fa8768046" }, "type": "array" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "items", "updated_at" ], "title": "BulkEmployeeDocumentRequest", "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Create a new employee document", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "employee-documents.read-write" ] } }, "/employment-types/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/list-employment-types" }, "operationId": "rippling.rest_api.list_employment_types", "parameters": [ { "in": "query", "name": "order_by", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 100, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "__meta": { "$ref": "#/components/schemas/OutputRestApiRedactedFields9f7657dc2a2f" }, "next_link": { "description": "A link to the next page of responses.", "format": "uri", "type": "string" }, "results": { "items": { "$ref": "#/components/schemas/OutputRestApiCompanyEmploymentTypede1bd52b2c44" }, "type": "array" } }, "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "List employment types", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "employment-types.read" ] } }, "/employment-types/{id}/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/get-employment-types" }, "operationId": "rippling.rest_api.get_employment_types", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "id", "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "__meta": { "properties": { "redacted_fields": { "items": { "$ref": "#/components/schemas/OutputRestApiRedactedField21788a25ef22" }, "type": "array" } }, "type": "object" }, "amount_worked": { "description": "The amount worked for the employment type. * `FULL-TIME`: Full-time is at least 30 hours per week. Full-time workers will typically be eligible for benefits. * `PART-TIME`: Part-time is less than 30 hours per week. These workers may be eligible for benefits, depending on company settings and hours worked. * `TEMPORARY`: These workers are hired on a temporary basis. You can specify how each worker with this employment type will be paid individually.", "type": "string" }, "compensation_time_period": { "description": "The compensation period for the employment type. * `SALARIED`: Employees that are paid a fixed amount per year. * `HOURLY`: Employees that are paid a wage per hour worked.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "label": { "description": "The display label of the employment type.", "type": "string" }, "name": { "description": "The name of the employment type for non-custom employment types.", "type": "string" }, "type": { "description": "The classification of the worker by the company. * `CONTRACTOR`: Contractors are self-employed workers who provide services on a short-term or per-project basis and are not eligible for tax-withholding or benefits. * `EMPLOYEE`: Employees are hired and managed by an employer, work under the employer's direct supervision and control, and are protected by law for wages and employment rights.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "label", "updated_at" ], "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Retrieve a specific employment type", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "employment-types.read" ] } }, "/entitlements/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/list-entitlements" }, "operationId": "rippling.rest_api.list_entitlements", "parameters": [ { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "__meta": { "$ref": "#/components/schemas/OutputRestApiRedactedFields9f7657dc2a2f" }, "next_link": { "description": "A link to the next page of responses.", "format": "uri", "type": "string" }, "results": { "items": { "$ref": "#/components/schemas/OutputRestApiEntitlementModelbc356e0b4ed0" }, "type": "array" } }, "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "List entitlements", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "entitlements.read" ] } }, "/files/": { "post": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/create-files" }, "operationId": "rippling.rest_api.create_files", "parameters": [ { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiFileDocumentDTORequest1dc4192aa39c" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Response DTO for ``POST /files/`` and ``GET /files/{id}``.", "properties": { "content_type": { "description": "MIME type supplied by the client at create time", "type": "string" }, "display_name": { "description": "Human-readable label for the file", "type": "string" }, "id": { "description": "Opaque identifier for this file", "type": "string" }, "status": { "description": "Lifecycle status: awaiting_upload | uploaded | active | infected", "type": "string" }, "upload_fields": { "description": "Required form fields to include in the multipart POST to S3 alongside the file binary", "type": "object" }, "upload_url": { "description": "S3 endpoint URL — POST your multipart form here to upload the file. Present only in the create response.", "type": "string" }, "url_data": { "description": "URLs for accessing the uploaded file after a successful upload", "properties": { "preview_url": { "description": "CDN URL for previewing the uploaded file after upload completes", "type": "string" }, "s3_url": { "description": "S3 URL where the file is accessible after upload", "type": "string" } }, "title": "UrlDataDTO", "type": "object" } }, "required": [ "id", "status" ], "title": "FileDocumentDTO", "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Create a new file", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "files.read-write" ] } }, "/files/{id}/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/get-files" }, "operationId": "rippling.rest_api.get_files", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "id", "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "__meta": { "properties": { "redacted_fields": { "items": { "$ref": "#/components/schemas/OutputRestApiRedactedField21788a25ef22" }, "type": "array" } }, "type": "object" }, "content_type": { "description": "MIME type supplied by the client at create time", "type": "string" }, "display_name": { "description": "Human-readable label for the file", "type": "string" }, "id": { "description": "Opaque identifier for this file", "type": "string" }, "status": { "description": "Lifecycle status: awaiting_upload | uploaded | active | infected", "type": "string" }, "upload_fields": { "description": "Required form fields to include in the multipart POST to S3 alongside the file binary", "type": "object" }, "upload_url": { "description": "S3 endpoint URL — POST your multipart form here to upload the file. Present only in the create response.", "type": "string" }, "url_data": { "description": "URLs for accessing the uploaded file after a successful upload", "properties": { "preview_url": { "description": "CDN URL for previewing the uploaded file after upload completes", "type": "string" }, "s3_url": { "description": "S3 URL where the file is accessible after upload", "type": "string" } }, "title": "UrlDataDTO", "type": "object" } }, "required": [ "id", "status" ], "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Retrieve a specific file", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "files.read" ] } }, "/functions/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/list-functions" }, "operationId": "rippling.rest_api.list_functions", "parameters": [ { "in": "query", "name": "order_by", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 100, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "next_link": { "description": "A link to the next page of responses.", "format": "uri", "type": "string" }, "results": { "items": { "$ref": "#/components/schemas/OutputRestApiFunctionc7dbb2131ac7" }, "type": "array" } }, "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "List functions", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "functions.read", "functions.read-write" ] }, "post": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/create-functions" }, "operationId": "rippling.rest_api.create_functions", "parameters": [ { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiFunctionRequestf410e35f75b5" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "api_name": { "description": "The API name of the function", "type": "string" }, "code_draft": { "description": "The current draft of code for the function", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "dependencies": { "description": "The dependencies of the function", "type": "object" }, "description": { "description": "The function description", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_async": { "description": "Whether this function runs asynchronously", "type": "boolean" }, "name": { "description": "The function name", "type": "string" }, "source_upload_instructions": { "description": "Upload instructions returned only when source_upload was requested on create or update.", "properties": { "archive": { "description": "Archive reference for a subsequent deployment after the upload succeeds.", "properties": { "object_key": { "description": "Tenant-scoped object key to use as the archive reference in the explicit deployment JSON.", "type": "string" }, "sha256": { "description": "SHA-256 of the ZIP bytes.", "type": "string" }, "size_bytes": { "anyOf": [ { "description": "Exact ZIP size in bytes, returned as a JSON integer.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "required": [ "object_key", "sha256", "size_bytes" ], "title": "FunctionSourceUploadArchive", "type": "object" }, "expires_at": { "description": "UTC expiration of the upload instructions, in RFC3339/ISO8601 format.", "type": "string" }, "fields": { "additionalProperties": { "type": "string" }, "description": "Include every opaque signed field unchanged in the multipart/form-data POST, plus the ZIP file.", "type": "object" }, "method": { "description": "HTTP method for the client-direct upload.", "type": "string" }, "url": { "description": "Upload the ZIP directly to this URL, not through the Functions API.", "type": "string" } }, "required": [ "archive", "expires_at", "fields", "method", "url" ], "title": "FunctionSourceUploadInstructions", "type": "object" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Function", "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Create a new function", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "functions.read-write" ] } }, "/functions/{function_api_name}/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/get-functions" }, "operationId": "rippling.rest_api.get_functions", "parameters": [ { "in": "path", "name": "function_api_name", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "api_name": { "description": "The API name of the function", "type": "string" }, "code_draft": { "description": "The current draft of code for the function", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "dependencies": { "description": "The dependencies of the function", "type": "object" }, "description": { "description": "The function description", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_async": { "description": "Whether this function runs asynchronously", "type": "boolean" }, "name": { "description": "The function name", "type": "string" }, "source_upload_instructions": { "description": "Upload instructions returned only when source_upload was requested on create or update.", "properties": { "archive": { "description": "Archive reference for a subsequent deployment after the upload succeeds.", "properties": { "object_key": { "description": "Tenant-scoped object key to use as the archive reference in the explicit deployment JSON.", "type": "string" }, "sha256": { "description": "SHA-256 of the ZIP bytes.", "type": "string" }, "size_bytes": { "anyOf": [ { "description": "Exact ZIP size in bytes, returned as a JSON integer.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "required": [ "object_key", "sha256", "size_bytes" ], "title": "FunctionSourceUploadArchive", "type": "object" }, "expires_at": { "description": "UTC expiration of the upload instructions, in RFC3339/ISO8601 format.", "type": "string" }, "fields": { "additionalProperties": { "type": "string" }, "description": "Include every opaque signed field unchanged in the multipart/form-data POST, plus the ZIP file.", "type": "object" }, "method": { "description": "HTTP method for the client-direct upload.", "type": "string" }, "url": { "description": "Upload the ZIP directly to this URL, not through the Functions API.", "type": "string" } }, "required": [ "archive", "expires_at", "fields", "method", "url" ], "title": "FunctionSourceUploadInstructions", "type": "object" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Function", "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Retrieve a specific function", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "functions.read", "functions.read-write" ] }, "patch": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/update-functions" }, "operationId": "rippling.rest_api.update_functions", "parameters": [ { "in": "path", "name": "function_api_name", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiFunctionUpdateRequestacecc4938a56" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "api_name": { "description": "The API name of the function", "type": "string" }, "code_draft": { "description": "The current draft of code for the function", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "dependencies": { "description": "The dependencies of the function", "type": "object" }, "description": { "description": "The function description", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_async": { "description": "Whether this function runs asynchronously", "type": "boolean" }, "name": { "description": "The function name", "type": "string" }, "source_upload_instructions": { "description": "Upload instructions returned only when source_upload was requested on create or update.", "properties": { "archive": { "description": "Archive reference for a subsequent deployment after the upload succeeds.", "properties": { "object_key": { "description": "Tenant-scoped object key to use as the archive reference in the explicit deployment JSON.", "type": "string" }, "sha256": { "description": "SHA-256 of the ZIP bytes.", "type": "string" }, "size_bytes": { "anyOf": [ { "description": "Exact ZIP size in bytes, returned as a JSON integer.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "required": [ "object_key", "sha256", "size_bytes" ], "title": "FunctionSourceUploadArchive", "type": "object" }, "expires_at": { "description": "UTC expiration of the upload instructions, in RFC3339/ISO8601 format.", "type": "string" }, "fields": { "additionalProperties": { "type": "string" }, "description": "Include every opaque signed field unchanged in the multipart/form-data POST, plus the ZIP file.", "type": "object" }, "method": { "description": "HTTP method for the client-direct upload.", "type": "string" }, "url": { "description": "Upload the ZIP directly to this URL, not through the Functions API.", "type": "string" } }, "required": [ "archive", "expires_at", "fields", "method", "url" ], "title": "FunctionSourceUploadInstructions", "type": "object" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Function", "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Update a function", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [] } }, "/functions/{function_api_name}/deployments/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/list-functions-function-api-name-deployments" }, "operationId": "rippling.rest_api.list_functions_function_api_name_deployments", "parameters": [ { "in": "path", "name": "function_api_name", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "results": { "items": { "$ref": "#/components/schemas/OutputRestApiFunctionDeploymentff6a393070e2" }, "type": "array" } }, "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "List function deployments", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "functions.read", "functions.read-write" ] }, "post": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/create-functions-function-api-name-deployments" }, "operationId": "rippling.rest_api.create_functions_function_api_name_deployments", "parameters": [ { "in": "path", "name": "function_api_name", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiFunctionDeploymentRequest4d8a4887fc10" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "allowed_domains": { "description": "Domains that function runs from this deployment are allowed to access", "items": { "type": "string" }, "type": "array" }, "code": { "description": "The code for the deployment", "type": "string" }, "created_at": { "description": "The creation date of the deployment", "type": "string" }, "dependencies": { "description": "The dependencies of the deployment", "type": "object" }, "external_id": { "description": "The external ID of the deployment", "type": "string" }, "function_api_name": { "description": "The API name of the function that this deployment is associated with", "type": "string" }, "function_id": { "description": "The ID of the function that this deployment is associated with", "type": "string" }, "function_version_human_friendly_id": { "anyOf": [ { "description": "The human friendly ID of version that this deployment is associated with", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "function_version_id": { "description": "The ID of the version that this deployment is associated with", "type": "string" }, "id": { "description": "The ID of the deployment", "type": "string" }, "io_contract": { "description": "Input and output JSON Schema contracts for the deployment", "type": "object" }, "options": { "description": "Additional, runtime-specific options for the deployment", "type": "object" }, "runtime": { "description": "The runtime for the deployment", "type": "string" }, "status": { "description": "The status of the deployment", "type": "string" }, "updated_at": { "description": "The last updated date of the deployment", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "FunctionDeployment", "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Create a new function deployment", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "functions.read-write" ] } }, "/functions/{function_api_name}/deployments/{deployment_id}/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/get-functions-function-api-name-deployments" }, "operationId": "rippling.rest_api.get_functions_function_api_name_deployments", "parameters": [ { "in": "path", "name": "function_api_name", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "deployment_id", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "allowed_domains": { "description": "Domains that function runs from this deployment are allowed to access", "items": { "type": "string" }, "type": "array" }, "code": { "description": "The code for the deployment", "type": "string" }, "created_at": { "description": "The creation date of the deployment", "type": "string" }, "dependencies": { "description": "The dependencies of the deployment", "type": "object" }, "external_id": { "description": "The external ID of the deployment", "type": "string" }, "function_api_name": { "description": "The API name of the function that this deployment is associated with", "type": "string" }, "function_id": { "description": "The ID of the function that this deployment is associated with", "type": "string" }, "function_version_human_friendly_id": { "anyOf": [ { "description": "The human friendly ID of version that this deployment is associated with", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "function_version_id": { "description": "The ID of the version that this deployment is associated with", "type": "string" }, "id": { "description": "The ID of the deployment", "type": "string" }, "io_contract": { "description": "Input and output JSON Schema contracts for the deployment", "type": "object" }, "options": { "description": "Additional, runtime-specific options for the deployment", "type": "object" }, "runtime": { "description": "The runtime for the deployment", "type": "string" }, "status": { "description": "The status of the deployment", "type": "string" }, "updated_at": { "description": "The last updated date of the deployment", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "FunctionDeployment", "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Retrieve a specific function deployment", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "functions.read", "functions.read-write" ] } }, "/functions/{function_api_name}/deployments/{deployment_id}/logs/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/list-functions-function-api-name-deployments-deployment-id-logs" }, "operationId": "rippling.rest_api.list_functions_function_api_name_deployments_deployment_id_logs", "parameters": [ { "in": "path", "name": "function_api_name", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "deployment_id", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "results": { "items": { "$ref": "#/components/schemas/OutputRestApiFunctionDeploymentLogffd4b21ac24f" }, "type": "array" } }, "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "List function deployment logs", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "functions.read", "functions.read-write" ] } }, "/functions/{function_api_name}/dev_bundles/": { "post": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/create-functions-function-api-name-dev-bundles" }, "operationId": "rippling.rest_api.create_functions_function_api_name_dev_bundles", "parameters": [ { "in": "path", "name": "function_api_name", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "description": "No request body is required. The dev bundle is created from the function's current draft code and dependencies.", "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "contents": { "description": "The bundle contents as a base64 encoded zip", "type": "string" } }, "title": "FunctionDevBundle", "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Create a new function dev bundle", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "functions.read-write" ] } }, "/functions/{function_api_name}/executions/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/list-functions-function-api-name-executions" }, "operationId": "rippling.rest_api.list_functions_function_api_name_executions", "parameters": [ { "in": "path", "name": "function_api_name", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 100, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "next_link": { "description": "A link to the next page of responses.", "format": "uri", "type": "string" }, "results": { "items": { "$ref": "#/components/schemas/OutputRestApiFunctionExecution8b8a5c5caf35" }, "type": "array" } }, "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "List function executions", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "function-executions.read", "function-executions.read-write", "function-executions.read-write.owner" ] }, "post": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/create-functions-function-api-name-executions" }, "operationId": "rippling.rest_api.create_functions_function_api_name_executions", "parameters": [ { "in": "path", "name": "function_api_name", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiFunctionExecutionRequest802a58bde9f4" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "finished_at": { "description": "The end time of the execution", "type": "string" }, "function_id": { "description": "The ID of the function this execution belongs to", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "inputs": { "description": "The inputs of the execution", "type": "object" }, "outputs": { "description": "The outputs of the execution", "type": "object" }, "started_at": { "description": "The start time of the execution", "type": "string" }, "status": { "description": "The status of the execution", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "function_id", "id", "inputs", "updated_at" ], "title": "FunctionExecution", "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Create a new function execution", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "function-executions.read-write", "function-executions.read-write.owner", "function-executions.write" ] } }, "/functions/{function_api_name}/executions/{execution_id}/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/get-functions-function-api-name-executions" }, "operationId": "rippling.rest_api.get_functions_function_api_name_executions", "parameters": [ { "in": "path", "name": "function_api_name", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "execution_id", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "finished_at": { "description": "The end time of the execution", "type": "string" }, "function_id": { "description": "The ID of the function this execution belongs to", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "inputs": { "description": "The inputs of the execution", "type": "object" }, "outputs": { "description": "The outputs of the execution", "type": "object" }, "started_at": { "description": "The start time of the execution", "type": "string" }, "status": { "description": "The status of the execution", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "function_id", "id", "inputs", "updated_at" ], "title": "FunctionExecution", "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Retrieve a specific function execution", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "function-executions.read", "function-executions.read-write", "function-executions.read-write.owner" ] } }, "/functions/{function_api_name}/executions/{execution_id}/logs/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/list-functions-function-api-name-executions-execution-id-logs" }, "operationId": "rippling.rest_api.list_functions_function_api_name_executions_execution_id_logs", "parameters": [ { "in": "path", "name": "function_api_name", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "execution_id", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "results": { "items": { "$ref": "#/components/schemas/OutputRestApiFunctionExecutionLogde864278783d" }, "type": "array" } }, "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "List function execution logs", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "function-executions.read", "function-executions.read-write", "function-executions.read-write.owner" ] } }, "/headcount-positions/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/list-headcount-positions" }, "operationId": "rippling.rest_api.list_headcount_positions", "parameters": [ { "in": "query", "name": "filter", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "expand", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 100, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "__meta": { "$ref": "#/components/schemas/OutputRestApiRedactedFields9f7657dc2a2f" }, "next_link": { "description": "A link to the next page of responses.", "format": "uri", "type": "string" }, "results": { "items": { "$ref": "#/components/schemas/OutputRestApiHeadcountPosition64649a08045c" }, "type": "array" } }, "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "List headcount positions", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "headcount-positions.read" ] } }, "/headcount-positions/{id}/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/get-headcount-positions" }, "operationId": "rippling.rest_api.get_headcount_positions", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "id", "type": "string" } }, { "in": "query", "name": "expand", "required": false, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "__meta": { "properties": { "redacted_fields": { "items": { "$ref": "#/components/schemas/OutputRestApiRedactedField21788a25ef22" }, "type": "array" } }, "type": "object" }, "actual_compensation": { "description": "Compensation data synched from worker compensation", "properties": { "base_pay": { "description": "Annual base pay for the headcount position", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "bonus": { "description": "Annual bonus for the headcount position", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "commission": { "description": "Annual on target commission for the headcount position", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "tax_and_benefits": { "description": "Annual total taxes and benefits compensation for this headcount position", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "total_cash": { "description": "Annual total cash compensation for the headcount position", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "total_equity": { "description": "Annual total equity compensation for the headcount position", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" } }, "title": "HeadcountCompensationData", "type": "object" }, "backfill_for": { "description": "Worker for whom this headcount position was requested as a backfill\n\nExpandable field", "properties": { "business_partners": { "description": "Worker's assigned business partners. This field is only populated when explicitly requested via the expand parameter (e.g., ?expand=business_partners). When expanded, returns an empty list ([]) if the worker has no business partners.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiBusinessPartner77b00a069c32" }, "type": "array" }, "business_partners_id": { "description": "Worker's assigned business partners unique identifiers. Returns an empty list ([]) if the worker has no business partners.", "items": { "type": "string" }, "type": "array" }, "citizenship": { "description": "The countries that the worker has citizenship in.", "type": "string" }, "compensation": { "description": "The compensation package for the worker.\n\nExpandable field", "properties": { "annual_compensation": { "description": "The worker's annual compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "annual_salary_equivalent": { "description": "The worker's annual salary equivalent, for insurance purposes. It will be equal to the worker's annual compensation, except for owners that are receiving no cashcompensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "bonus_schedule": { "description": "The worker's bonus schedule.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "hourly_wage": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "id": { "description": "Identifier field", "type": "string" }, "monthly_compensation": { "description": "The worker's monthly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "on_target_commission": { "description": "The worker's on-target commission.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "payment_terms": { "description": "The payment terms for an worker's compensation.", "type": "string" }, "payment_type": { "description": "The payment type for an worker's compensation.", "type": "string" }, "relocation_reimbursement": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "salary_effective_date": { "description": "Salary effective date", "type": "string" }, "signing_bonus": { "description": "The worker's signing bonus.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus": { "description": "The worker's target annual bonus amount.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus_percent": { "anyOf": [ { "description": "The worker's target annual bonus as a percent of annual compensation.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" }, "weekly_compensation": { "description": "The worker's weekly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "worker": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's details.\n\nExpandable field", "type": "object" }, "worker_id": { "description": "The worker's ID.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Compensation", "type": "object" }, "compensation_grade": { "description": "The compensation grade assigned to the worker, if any.", "properties": { "id": { "description": "The compensation grade's unique identifier.", "type": "string" }, "label": { "description": "The compensation grade's label.", "type": "string" } }, "title": "WorkerCompensationGrade", "type": "object" }, "compensation_id": { "description": "The compensation package for the worker.", "type": "string" }, "country": { "description": "The worker's country.", "type": "string" }, "country_fields": { "description": "Country level fields for the worker.", "properties": { "ca": { "description": "Country-wise regional fields for Canada", "properties": { "sin": { "description": "Social Insurance Number (SIN) for Canada employees.", "type": "string" } }, "title": "CanadaFields", "type": "object" }, "nz": { "description": "Country-wise regional fields for New Zealand", "properties": { "ird_number": { "description": "Inland Revenue Department (IRD) number for New Zealand employees.", "type": "string" } }, "title": "NewZealandFields", "type": "object" }, "us": { "description": "Country-wise regional fields for USA", "properties": { "ssn": { "description": "Social Security Number (SSN) for US employees.", "type": "string" } }, "title": "USFields", "type": "object" } }, "title": "CountryFields", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "custom_fields": { "description": "Custom field values defined on the Employee object for this worker\n\nExpandable field", "items": { "additionalProperties": {} }, "type": "array" }, "date_of_birth": { "description": "The worker's date of birth.", "type": "string" }, "department": { "description": "The worker's assigned department.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "department_hierarchy": { "description": "List of departments in the department hierarchy. Refer department_hierarchy_ids for department hierarchy order.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestDepartment" }, "type": "array" }, "department_hierarchy_id": { "description": "The identifier of departments in the department hierarchy ordered from parent department to child department.", "items": { "type": "string" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the department.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestDepartment", "description": "The parent department.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent department.", "type": "string" }, "reference_code": { "description": "Reference code of the department.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Department", "type": "object" }, "department_id": { "description": "The worker's assigned department.", "type": "string" }, "employment_type": { "description": "The worker's employment type.\n\nExpandable field", "properties": { "amount_worked": { "description": "The amount worked for the employment type. * `FULL-TIME`: Full-time is at least 30 hours per week. Full-time workers will typically be eligible for benefits. * `PART-TIME`: Part-time is less than 30 hours per week. These workers may be eligible for benefits, depending on company settings and hours worked. * `TEMPORARY`: These workers are hired on a temporary basis. You can specify how each worker with this employment type will be paid individually.", "type": "string" }, "compensation_time_period": { "description": "The compensation period for the employment type. * `SALARIED`: Employees that are paid a fixed amount per year. * `HOURLY`: Employees that are paid a wage per hour worked.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "label": { "description": "The display label of the employment type.", "type": "string" }, "name": { "description": "The name of the employment type for non-custom employment types.", "type": "string" }, "type": { "description": "The classification of the worker by the company. * `CONTRACTOR`: Contractors are self-employed workers who provide services on a short-term or per-project basis and are not eligible for tax-withholding or benefits. * `EMPLOYEE`: Employees are hired and managed by an employer, work under the employer's direct supervision and control, and are protected by law for wages and employment rights.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "label", "updated_at" ], "title": "CompanyEmploymentType", "type": "object" }, "employment_type_id": { "description": "The worker's employment type.", "type": "string" }, "end_date": { "description": "The end date of the worker.", "type": "string" }, "ethnicity": { "description": "The identified ethnicity of the worker, if specified.", "type": "string" }, "gender": { "description": "The gender of the worker, if specified.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_manager": { "description": "Whether the worker is a manager", "type": "boolean" }, "job_function": { "description": "The worker's job function. When expanded, this field requires `job-functions.read`.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "Displayed name of the job function", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "JobFunction", "type": "object" }, "job_function_id": { "description": "ID of the worker's job function.", "type": "string" }, "legal_entity": { "description": "The worker's associated legal entity.\n\nExpandable field", "properties": { "company": { "description": "The company or organization associated with the legal entity\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "doing_business_as_name": { "description": "The doing business as name for the company.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_entities": { "description": "A list of the company's entities.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestLegalEntity" }, "type": "array" }, "legal_entities_id": { "description": "A list of the company's entities.", "items": { "type": "string" }, "type": "array" }, "legal_name": { "description": "The legal name of the company.", "type": "string" }, "name": { "description": "The name of the company.", "type": "string" }, "parent_legal_entity": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The company's ultimate holding entity.\n\nExpandable field", "type": "object" }, "parent_legal_entity_id": { "description": "The company's ultimate holding entity.", "type": "string" }, "phone": { "description": "The phone number for the company.", "type": "string" }, "physical_address": { "description": "The physical address of the holding entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "primary_email": { "description": "The email address used when registering this company.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "legal_entities", "legal_entities_id", "name", "updated_at" ], "title": "Company", "type": "object" }, "company_id": { "description": "The company or organization associated with the legal entity", "type": "string" }, "country": { "description": "The country the legal entity is based in.", "properties": { "code": { "description": "The code of the country.", "type": "string" } }, "required": [ "code" ], "title": "Country", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "entity_level": { "description": "The legal entity's level in a hierarchy. * `PARENT`: The legal entity is considered the ultimate holding entity. * `SUBSIDIARY`: The legal entity is considered a subsidiary, fully or partially held by another. * `BRANCH`: The legal entity is considered a branch, associated with a parent legal entity.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_name": { "description": "The legal name of the legal entity.", "type": "string" }, "mailing_address": { "description": "The mailing address of the legal entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "management_type": { "description": "The legal entity management type in the case of an employer of record (EOR) or professional employment organization (PEO). * `PEO`: The legal entity is considered a Professional Employment Organization (PEO). * `EOR`: The legal entity is considered an Employer of Record (EOR).", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The parent legal entity.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent legal entity.", "type": "string" }, "physical_address": { "description": "The physical address of the legal entity, if it differs from the mailing address.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "registration_date": { "description": "The registration date of the entity.", "type": "string" }, "tax_identifier": { "description": "The tax identifier for the legal entity.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "LegalEntity", "type": "object" }, "legal_entity_id": { "description": "The worker's associated legal entity.", "type": "string" }, "level": { "description": "The level of the worker.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "description": { "description": "The description of the level.", "type": "string" }, "experience_requirements": { "description": "The experience requirements for the level.", "type": "string" }, "global_level": { "anyOf": [ { "description": "Global level is used to track the seniority of levels. The higher up a level is placed on the page, the more senior and higher-ranked the level. Global level is used in workflows, policies, and reports that use the level attribute (e.g., you can use Level Lookup to set up a workflow that notifies the nearest person in an worker's management chain at or above the specified level).", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the level. Must be unique within the company or organization.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLevel", "description": "The parent level.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent level.", "type": "string" }, "rank": { "anyOf": [ { "description": "The rank of the level within its track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "scope_of_responsibilities": { "description": "The scope of responsibilities for the level.", "type": "string" }, "track": { "description": "The track associated with the level, if it's not a global level.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_default": { "description": "Whether this is the company's default track.", "type": "boolean" }, "name": { "description": "The name of the track. Must be unique within the company or organization.", "type": "string" }, "order": { "anyOf": [ { "description": "The one-based horizontal display order of the track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "start_global_level": { "anyOf": [ { "description": "The highest global level occupied by this track. Empty tracks return null.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Track", "type": "object" }, "track_id": { "description": "The track associated with the level. Required during creation. Include global_level when changing it.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Level", "type": "object" }, "level_id": { "description": "The level of the worker.", "type": "string" }, "location": { "description": "The location that the worker is mapped to for tax purposes. In the case that a worker is remote, the location's type is remote.", "properties": { "type": { "description": "The type of location.", "type": "string" }, "work_location_id": { "description": "The work location, if the worker isn't remote.", "type": "string" } }, "required": [ "type", "work_location_id" ], "title": "WorkerLocation", "type": "object" }, "manager": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's manager.\n\nExpandable field", "type": "object" }, "manager_id": { "description": "The worker's manager.", "type": "string" }, "number": { "anyOf": [ { "description": "The worker's number within the organization.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "original_start_date": { "description": "The worker's earliest start date across their employment history, excluding INIT roles.", "type": "string" }, "overtime_exemption": { "description": "The worker's overtime exemption status.", "type": "string" }, "pay_schedule_id": { "description": "The ID of the pay schedule currently associated with the worker.", "type": "string" }, "personal_email": { "description": "The worker's associated personal email address.", "type": "string" }, "race": { "description": "The identified race of the worker, if specified.", "type": "string" }, "start_date": { "description": "The start date of the worker.", "type": "string" }, "status": { "description": "The worker's status within the organization.", "type": "string" }, "teams": { "description": "The worker's assigned teams.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiTeamcb26bc28f32f" }, "type": "array" }, "teams_id": { "description": "The worker's assigned teams.", "items": { "type": "string" }, "type": "array" }, "termination_details": { "description": "The details of the worker's termination, if applicable.", "properties": { "reason": { "description": "This is a description that will be custom to each Rippling company.", "type": "string" }, "type": { "description": "The termination type indicates whether the termination was voluntary or involuntary.", "type": "string" } }, "title": "TerminationDetails", "type": "object" }, "title": { "description": "The worker's title.", "type": "string" }, "title_effective_date": { "description": "Title effective date", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "user": { "description": "The worker's associated user.\n\nExpandable field", "properties": { "active": { "description": "Whether the user is able to access company resources, typically when they are in actively engaged with the company and not after off-boarding.", "type": "boolean" }, "addresses": { "description": "The user's addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiUserAddressedd59b9ba9a1" }, "type": "array" }, "created_at": { "description": "Record creation date", "type": "string" }, "display_name": { "description": "The display name of the user using either the concatenated preferred given and family name or username depending on availability.", "type": "string" }, "emails": { "description": "The user's email addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiEmail5284c8258dc3" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "locale": { "description": "The User's default location for purposes of localization of currency, date time format, or numerical representations pursuant to RFC5646.", "type": "string" }, "name": { "description": "The user's name.", "properties": { "family_name": { "description": "The legal family name of the user, or last name in most Western languages.", "type": "string" }, "formatted": { "description": "The user's full name.", "type": "string" }, "given_name": { "description": "The given legal name of the user, or first name in most Western languages.", "type": "string" }, "middle_name": { "description": "The middle name(s) of the user.", "type": "string" }, "preferred_family_name": { "description": "The preferred family name, or last name in most Western languages, by the user.", "type": "string" }, "preferred_given_name": { "description": "The preferred given name, or first name in most Western languages, by the user.", "type": "string" } }, "title": "UserName", "type": "object" }, "number": { "description": "The permanent profile number of the user.", "type": "string" }, "phone_numbers": { "description": "The user's phone numbers.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoneNumber12060c61ecf5" }, "type": "array" }, "photos": { "description": "The user's photos.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoto2be7c3ae3f39" }, "type": "array" }, "preferred_language": { "description": "The User's preferred written or spoken language in the same format of the HTTP Accept-Language header, pursuant to Section 5.3.5 of RFC7231.", "type": "string" }, "timezone": { "description": "The User's current time zone in IANA database Olson format", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "username": { "description": "The unique identifier across Rippling used by the User for direct authentication into their associated company. Globally unique.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "User", "type": "object" }, "user_id": { "description": "The worker's associated user.", "type": "string" }, "work_email": { "description": "The worker's associated work email address.", "type": "string" }, "work_schedule": { "additionalProperties": { "$ref": "#/components/schemas/OutputRestApiWorkScheduleDay938f88d94f20" }, "description": "The worker's scheduled working hours for each day of the week.", "type": "object" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Worker", "type": "object" }, "backfill_for_id": { "description": "ID of the worker for whom this headcount position was requested as a backfill", "type": "string" }, "comp_band_compensation": { "description": "Compensation data defined through comp band", "properties": { "base_pay": { "description": "Annual base pay for the headcount position", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "bonus": { "description": "Annual bonus for the headcount position", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "commission": { "description": "Annual on target commission for the headcount position", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "tax_and_benefits": { "description": "Annual total taxes and benefits compensation for this headcount position", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "total_cash": { "description": "Annual total cash compensation for the headcount position", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "total_equity": { "description": "Annual total equity compensation for the headcount position", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" } }, "title": "HeadcountCompensationData", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "current_start_date": { "description": "Most recent start date estimate or the actual hire date if already filled", "type": "string" }, "department": { "description": "Department the headcount belongs to\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "department_hierarchy": { "description": "List of departments in the department hierarchy. Refer department_hierarchy_ids for department hierarchy order.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestDepartment" }, "type": "array" }, "department_hierarchy_id": { "description": "The identifier of departments in the department hierarchy ordered from parent department to child department.", "items": { "type": "string" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the department.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestDepartment", "description": "The parent department.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent department.", "type": "string" }, "reference_code": { "description": "Reference code of the department.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Department", "type": "object" }, "department_id": { "description": "ID for the department the headcount belongs to", "type": "string" }, "employment_type": { "description": "Employment type the headcount is assigned to\n\nExpandable field", "properties": { "amount_worked": { "description": "The amount worked for the employment type. * `FULL-TIME`: Full-time is at least 30 hours per week. Full-time workers will typically be eligible for benefits. * `PART-TIME`: Part-time is less than 30 hours per week. These workers may be eligible for benefits, depending on company settings and hours worked. * `TEMPORARY`: These workers are hired on a temporary basis. You can specify how each worker with this employment type will be paid individually.", "type": "string" }, "compensation_time_period": { "description": "The compensation period for the employment type. * `SALARIED`: Employees that are paid a fixed amount per year. * `HOURLY`: Employees that are paid a wage per hour worked.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "label": { "description": "The display label of the employment type.", "type": "string" }, "name": { "description": "The name of the employment type for non-custom employment types.", "type": "string" }, "type": { "description": "The classification of the worker by the company. * `CONTRACTOR`: Contractors are self-employed workers who provide services on a short-term or per-project basis and are not eligible for tax-withholding or benefits. * `EMPLOYEE`: Employees are hired and managed by an employer, work under the employer's direct supervision and control, and are protected by law for wages and employment rights.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "label", "updated_at" ], "title": "CompanyEmploymentType", "type": "object" }, "employment_type_id": { "description": "ID for the employment type the headcount is assigned to", "type": "string" }, "end_date": { "description": "Targeted end date for the headcount", "type": "string" }, "headcount_owner": { "description": "Owner of the headcount\n\nExpandable field", "properties": { "business_partners": { "description": "Worker's assigned business partners. This field is only populated when explicitly requested via the expand parameter (e.g., ?expand=business_partners). When expanded, returns an empty list ([]) if the worker has no business partners.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiBusinessPartner77b00a069c32" }, "type": "array" }, "business_partners_id": { "description": "Worker's assigned business partners unique identifiers. Returns an empty list ([]) if the worker has no business partners.", "items": { "type": "string" }, "type": "array" }, "citizenship": { "description": "The countries that the worker has citizenship in.", "type": "string" }, "compensation": { "description": "The compensation package for the worker.\n\nExpandable field", "properties": { "annual_compensation": { "description": "The worker's annual compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "annual_salary_equivalent": { "description": "The worker's annual salary equivalent, for insurance purposes. It will be equal to the worker's annual compensation, except for owners that are receiving no cashcompensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "bonus_schedule": { "description": "The worker's bonus schedule.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "hourly_wage": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "id": { "description": "Identifier field", "type": "string" }, "monthly_compensation": { "description": "The worker's monthly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "on_target_commission": { "description": "The worker's on-target commission.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "payment_terms": { "description": "The payment terms for an worker's compensation.", "type": "string" }, "payment_type": { "description": "The payment type for an worker's compensation.", "type": "string" }, "relocation_reimbursement": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "salary_effective_date": { "description": "Salary effective date", "type": "string" }, "signing_bonus": { "description": "The worker's signing bonus.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus": { "description": "The worker's target annual bonus amount.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus_percent": { "anyOf": [ { "description": "The worker's target annual bonus as a percent of annual compensation.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" }, "weekly_compensation": { "description": "The worker's weekly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "worker": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's details.\n\nExpandable field", "type": "object" }, "worker_id": { "description": "The worker's ID.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Compensation", "type": "object" }, "compensation_grade": { "description": "The compensation grade assigned to the worker, if any.", "properties": { "id": { "description": "The compensation grade's unique identifier.", "type": "string" }, "label": { "description": "The compensation grade's label.", "type": "string" } }, "title": "WorkerCompensationGrade", "type": "object" }, "compensation_id": { "description": "The compensation package for the worker.", "type": "string" }, "country": { "description": "The worker's country.", "type": "string" }, "country_fields": { "description": "Country level fields for the worker.", "properties": { "ca": { "description": "Country-wise regional fields for Canada", "properties": { "sin": { "description": "Social Insurance Number (SIN) for Canada employees.", "type": "string" } }, "title": "CanadaFields", "type": "object" }, "nz": { "description": "Country-wise regional fields for New Zealand", "properties": { "ird_number": { "description": "Inland Revenue Department (IRD) number for New Zealand employees.", "type": "string" } }, "title": "NewZealandFields", "type": "object" }, "us": { "description": "Country-wise regional fields for USA", "properties": { "ssn": { "description": "Social Security Number (SSN) for US employees.", "type": "string" } }, "title": "USFields", "type": "object" } }, "title": "CountryFields", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "custom_fields": { "description": "Custom field values defined on the Employee object for this worker\n\nExpandable field", "items": { "additionalProperties": {} }, "type": "array" }, "date_of_birth": { "description": "The worker's date of birth.", "type": "string" }, "department": { "description": "The worker's assigned department.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "department_hierarchy": { "description": "List of departments in the department hierarchy. Refer department_hierarchy_ids for department hierarchy order.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestDepartment" }, "type": "array" }, "department_hierarchy_id": { "description": "The identifier of departments in the department hierarchy ordered from parent department to child department.", "items": { "type": "string" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the department.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestDepartment", "description": "The parent department.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent department.", "type": "string" }, "reference_code": { "description": "Reference code of the department.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Department", "type": "object" }, "department_id": { "description": "The worker's assigned department.", "type": "string" }, "employment_type": { "description": "The worker's employment type.\n\nExpandable field", "properties": { "amount_worked": { "description": "The amount worked for the employment type. * `FULL-TIME`: Full-time is at least 30 hours per week. Full-time workers will typically be eligible for benefits. * `PART-TIME`: Part-time is less than 30 hours per week. These workers may be eligible for benefits, depending on company settings and hours worked. * `TEMPORARY`: These workers are hired on a temporary basis. You can specify how each worker with this employment type will be paid individually.", "type": "string" }, "compensation_time_period": { "description": "The compensation period for the employment type. * `SALARIED`: Employees that are paid a fixed amount per year. * `HOURLY`: Employees that are paid a wage per hour worked.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "label": { "description": "The display label of the employment type.", "type": "string" }, "name": { "description": "The name of the employment type for non-custom employment types.", "type": "string" }, "type": { "description": "The classification of the worker by the company. * `CONTRACTOR`: Contractors are self-employed workers who provide services on a short-term or per-project basis and are not eligible for tax-withholding or benefits. * `EMPLOYEE`: Employees are hired and managed by an employer, work under the employer's direct supervision and control, and are protected by law for wages and employment rights.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "label", "updated_at" ], "title": "CompanyEmploymentType", "type": "object" }, "employment_type_id": { "description": "The worker's employment type.", "type": "string" }, "end_date": { "description": "The end date of the worker.", "type": "string" }, "ethnicity": { "description": "The identified ethnicity of the worker, if specified.", "type": "string" }, "gender": { "description": "The gender of the worker, if specified.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_manager": { "description": "Whether the worker is a manager", "type": "boolean" }, "job_function": { "description": "The worker's job function. When expanded, this field requires `job-functions.read`.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "Displayed name of the job function", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "JobFunction", "type": "object" }, "job_function_id": { "description": "ID of the worker's job function.", "type": "string" }, "legal_entity": { "description": "The worker's associated legal entity.\n\nExpandable field", "properties": { "company": { "description": "The company or organization associated with the legal entity\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "doing_business_as_name": { "description": "The doing business as name for the company.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_entities": { "description": "A list of the company's entities.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestLegalEntity" }, "type": "array" }, "legal_entities_id": { "description": "A list of the company's entities.", "items": { "type": "string" }, "type": "array" }, "legal_name": { "description": "The legal name of the company.", "type": "string" }, "name": { "description": "The name of the company.", "type": "string" }, "parent_legal_entity": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The company's ultimate holding entity.\n\nExpandable field", "type": "object" }, "parent_legal_entity_id": { "description": "The company's ultimate holding entity.", "type": "string" }, "phone": { "description": "The phone number for the company.", "type": "string" }, "physical_address": { "description": "The physical address of the holding entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "primary_email": { "description": "The email address used when registering this company.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "legal_entities", "legal_entities_id", "name", "updated_at" ], "title": "Company", "type": "object" }, "company_id": { "description": "The company or organization associated with the legal entity", "type": "string" }, "country": { "description": "The country the legal entity is based in.", "properties": { "code": { "description": "The code of the country.", "type": "string" } }, "required": [ "code" ], "title": "Country", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "entity_level": { "description": "The legal entity's level in a hierarchy. * `PARENT`: The legal entity is considered the ultimate holding entity. * `SUBSIDIARY`: The legal entity is considered a subsidiary, fully or partially held by another. * `BRANCH`: The legal entity is considered a branch, associated with a parent legal entity.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_name": { "description": "The legal name of the legal entity.", "type": "string" }, "mailing_address": { "description": "The mailing address of the legal entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "management_type": { "description": "The legal entity management type in the case of an employer of record (EOR) or professional employment organization (PEO). * `PEO`: The legal entity is considered a Professional Employment Organization (PEO). * `EOR`: The legal entity is considered an Employer of Record (EOR).", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The parent legal entity.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent legal entity.", "type": "string" }, "physical_address": { "description": "The physical address of the legal entity, if it differs from the mailing address.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "registration_date": { "description": "The registration date of the entity.", "type": "string" }, "tax_identifier": { "description": "The tax identifier for the legal entity.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "LegalEntity", "type": "object" }, "legal_entity_id": { "description": "The worker's associated legal entity.", "type": "string" }, "level": { "description": "The level of the worker.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "description": { "description": "The description of the level.", "type": "string" }, "experience_requirements": { "description": "The experience requirements for the level.", "type": "string" }, "global_level": { "anyOf": [ { "description": "Global level is used to track the seniority of levels. The higher up a level is placed on the page, the more senior and higher-ranked the level. Global level is used in workflows, policies, and reports that use the level attribute (e.g., you can use Level Lookup to set up a workflow that notifies the nearest person in an worker's management chain at or above the specified level).", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the level. Must be unique within the company or organization.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLevel", "description": "The parent level.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent level.", "type": "string" }, "rank": { "anyOf": [ { "description": "The rank of the level within its track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "scope_of_responsibilities": { "description": "The scope of responsibilities for the level.", "type": "string" }, "track": { "description": "The track associated with the level, if it's not a global level.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_default": { "description": "Whether this is the company's default track.", "type": "boolean" }, "name": { "description": "The name of the track. Must be unique within the company or organization.", "type": "string" }, "order": { "anyOf": [ { "description": "The one-based horizontal display order of the track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "start_global_level": { "anyOf": [ { "description": "The highest global level occupied by this track. Empty tracks return null.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Track", "type": "object" }, "track_id": { "description": "The track associated with the level. Required during creation. Include global_level when changing it.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Level", "type": "object" }, "level_id": { "description": "The level of the worker.", "type": "string" }, "location": { "description": "The location that the worker is mapped to for tax purposes. In the case that a worker is remote, the location's type is remote.", "properties": { "type": { "description": "The type of location.", "type": "string" }, "work_location_id": { "description": "The work location, if the worker isn't remote.", "type": "string" } }, "required": [ "type", "work_location_id" ], "title": "WorkerLocation", "type": "object" }, "manager": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's manager.\n\nExpandable field", "type": "object" }, "manager_id": { "description": "The worker's manager.", "type": "string" }, "number": { "anyOf": [ { "description": "The worker's number within the organization.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "original_start_date": { "description": "The worker's earliest start date across their employment history, excluding INIT roles.", "type": "string" }, "overtime_exemption": { "description": "The worker's overtime exemption status.", "type": "string" }, "pay_schedule_id": { "description": "The ID of the pay schedule currently associated with the worker.", "type": "string" }, "personal_email": { "description": "The worker's associated personal email address.", "type": "string" }, "race": { "description": "The identified race of the worker, if specified.", "type": "string" }, "start_date": { "description": "The start date of the worker.", "type": "string" }, "status": { "description": "The worker's status within the organization.", "type": "string" }, "teams": { "description": "The worker's assigned teams.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiTeamcb26bc28f32f" }, "type": "array" }, "teams_id": { "description": "The worker's assigned teams.", "items": { "type": "string" }, "type": "array" }, "termination_details": { "description": "The details of the worker's termination, if applicable.", "properties": { "reason": { "description": "This is a description that will be custom to each Rippling company.", "type": "string" }, "type": { "description": "The termination type indicates whether the termination was voluntary or involuntary.", "type": "string" } }, "title": "TerminationDetails", "type": "object" }, "title": { "description": "The worker's title.", "type": "string" }, "title_effective_date": { "description": "Title effective date", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "user": { "description": "The worker's associated user.\n\nExpandable field", "properties": { "active": { "description": "Whether the user is able to access company resources, typically when they are in actively engaged with the company and not after off-boarding.", "type": "boolean" }, "addresses": { "description": "The user's addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiUserAddressedd59b9ba9a1" }, "type": "array" }, "created_at": { "description": "Record creation date", "type": "string" }, "display_name": { "description": "The display name of the user using either the concatenated preferred given and family name or username depending on availability.", "type": "string" }, "emails": { "description": "The user's email addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiEmail5284c8258dc3" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "locale": { "description": "The User's default location for purposes of localization of currency, date time format, or numerical representations pursuant to RFC5646.", "type": "string" }, "name": { "description": "The user's name.", "properties": { "family_name": { "description": "The legal family name of the user, or last name in most Western languages.", "type": "string" }, "formatted": { "description": "The user's full name.", "type": "string" }, "given_name": { "description": "The given legal name of the user, or first name in most Western languages.", "type": "string" }, "middle_name": { "description": "The middle name(s) of the user.", "type": "string" }, "preferred_family_name": { "description": "The preferred family name, or last name in most Western languages, by the user.", "type": "string" }, "preferred_given_name": { "description": "The preferred given name, or first name in most Western languages, by the user.", "type": "string" } }, "title": "UserName", "type": "object" }, "number": { "description": "The permanent profile number of the user.", "type": "string" }, "phone_numbers": { "description": "The user's phone numbers.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoneNumber12060c61ecf5" }, "type": "array" }, "photos": { "description": "The user's photos.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoto2be7c3ae3f39" }, "type": "array" }, "preferred_language": { "description": "The User's preferred written or spoken language in the same format of the HTTP Accept-Language header, pursuant to Section 5.3.5 of RFC7231.", "type": "string" }, "timezone": { "description": "The User's current time zone in IANA database Olson format", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "username": { "description": "The unique identifier across Rippling used by the User for direct authentication into their associated company. Globally unique.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "User", "type": "object" }, "user_id": { "description": "The worker's associated user.", "type": "string" }, "work_email": { "description": "The worker's associated work email address.", "type": "string" }, "work_schedule": { "additionalProperties": { "$ref": "#/components/schemas/OutputRestApiWorkScheduleDay938f88d94f20" }, "description": "The worker's scheduled working hours for each day of the week.", "type": "object" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Worker", "type": "object" }, "headcount_owner_id": { "description": "ID for the headcount owner", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "in_budget": { "description": "Whether the headcount position is in budget", "type": "boolean" }, "job_function": { "description": "Job function assigned to this headcount\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "Displayed name of the job function", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "JobFunction", "type": "object" }, "job_function_id": { "description": "ID for the job function the headcount is assigned to", "type": "string" }, "job_requisition": { "description": "Job requisition the headcount is associated with\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "Job requisition name", "type": "string" }, "status": { "description": "Job requisition status", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "status", "updated_at" ], "title": "JobRequisition", "type": "object" }, "job_requisition_id": { "description": "ID for the job requisition the headcount is associated with", "type": "string" }, "level": { "description": "Level the headcount is assigned to\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "description": { "description": "The description of the level.", "type": "string" }, "experience_requirements": { "description": "The experience requirements for the level.", "type": "string" }, "global_level": { "anyOf": [ { "description": "Global level is used to track the seniority of levels. The higher up a level is placed on the page, the more senior and higher-ranked the level. Global level is used in workflows, policies, and reports that use the level attribute (e.g., you can use Level Lookup to set up a workflow that notifies the nearest person in an worker's management chain at or above the specified level).", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the level. Must be unique within the company or organization.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLevel", "description": "The parent level.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent level.", "type": "string" }, "rank": { "anyOf": [ { "description": "The rank of the level within its track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "scope_of_responsibilities": { "description": "The scope of responsibilities for the level.", "type": "string" }, "track": { "description": "The track associated with the level, if it's not a global level.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_default": { "description": "Whether this is the company's default track.", "type": "boolean" }, "name": { "description": "The name of the track. Must be unique within the company or organization.", "type": "string" }, "order": { "anyOf": [ { "description": "The one-based horizontal display order of the track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "start_global_level": { "anyOf": [ { "description": "The highest global level occupied by this track. Empty tracks return null.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Track", "type": "object" }, "track_id": { "description": "The track associated with the level. Required during creation. Include global_level when changing it.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Level", "type": "object" }, "level_id": { "description": "ID for the level the headcount is assigned to", "type": "string" }, "location_factor": { "description": "Location factor assigned to this headcount\n\nExpandable field", "properties": { "adjustment_factor": { "anyOf": [ { "description": "Compensation adjustment percentage", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "country": { "description": "Country information set to the country code", "properties": { "code": { "description": "The code of the country.", "type": "string" } }, "required": [ "code" ], "title": "Country", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "display_name": { "description": "Human-readable name for the location factor", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "labour_bucket": { "description": "The labor market category (e.g., \"Engineering\", \"Marketing\", \"Sales\")", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "LocationFactor", "type": "object" }, "location_factor_id": { "description": "ID for the location factor the headcount is assigned to", "type": "string" }, "notes": { "description": "Headcount notes", "type": "string" }, "position_id": { "description": "Position name for the headcount, for ex PID100037", "type": "string" }, "position_sub_type": { "description": "More granular classification of headcount position type. `NEW` New headcount created, typically paired with the OPEN_HEADCOUNT type. `BACKFILL` Replacement headcount for someone who left the company. `FORECASTED_ATTRITION` Headcount that does not count toward the budget, also known as provisional position in the application, `HIRING_STAGE` Person is going through the hiring process, paired with the FUTURE_START type. `OFFER_STAGE` Offer has been extended to a candidate, awaiting their decision. Paired with the FUTURE_START type. `OFFER_ACCEPTED` Candidate has accepted the offer but has not yet started. Paired with the FUTURE_START type. `PLAN_CHANGE` Headcount status changed due to business decision. Paired with CLOSED type. `TERMINATED` Role was filled, but the employee was separated from the company. Paired with CLOSED type. `TRANSFERRED` Employee moved internally to another role. Paired with CLOSED type.", "type": "string" }, "position_type": { "description": "Type of headcount position. `OPEN_HEADCOUNT` A headcount position that's not yet filled. `FUTURE_START` Headcount where a candidate is going through the hiring process, or an offer has been accepted, but the person has not yet started. `ACTIVE` Headcount where a candidate has been hired and started. `CLOSED` Headcount that's no longer available to fill.", "type": "string" }, "priority": { "description": "Priority assigned to this headcount\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "Display name of the headcount priority", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "HeadcountPriority", "type": "object" }, "priority_id": { "description": "ID for the headcount priority", "type": "string" }, "recruiter": { "description": "Recruiter working on filling the position\n\nExpandable field", "properties": { "business_partners": { "description": "Worker's assigned business partners. This field is only populated when explicitly requested via the expand parameter (e.g., ?expand=business_partners). When expanded, returns an empty list ([]) if the worker has no business partners.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiBusinessPartner77b00a069c32" }, "type": "array" }, "business_partners_id": { "description": "Worker's assigned business partners unique identifiers. Returns an empty list ([]) if the worker has no business partners.", "items": { "type": "string" }, "type": "array" }, "citizenship": { "description": "The countries that the worker has citizenship in.", "type": "string" }, "compensation": { "description": "The compensation package for the worker.\n\nExpandable field", "properties": { "annual_compensation": { "description": "The worker's annual compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "annual_salary_equivalent": { "description": "The worker's annual salary equivalent, for insurance purposes. It will be equal to the worker's annual compensation, except for owners that are receiving no cashcompensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "bonus_schedule": { "description": "The worker's bonus schedule.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "hourly_wage": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "id": { "description": "Identifier field", "type": "string" }, "monthly_compensation": { "description": "The worker's monthly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "on_target_commission": { "description": "The worker's on-target commission.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "payment_terms": { "description": "The payment terms for an worker's compensation.", "type": "string" }, "payment_type": { "description": "The payment type for an worker's compensation.", "type": "string" }, "relocation_reimbursement": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "salary_effective_date": { "description": "Salary effective date", "type": "string" }, "signing_bonus": { "description": "The worker's signing bonus.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus": { "description": "The worker's target annual bonus amount.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus_percent": { "anyOf": [ { "description": "The worker's target annual bonus as a percent of annual compensation.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" }, "weekly_compensation": { "description": "The worker's weekly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "worker": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's details.\n\nExpandable field", "type": "object" }, "worker_id": { "description": "The worker's ID.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Compensation", "type": "object" }, "compensation_grade": { "description": "The compensation grade assigned to the worker, if any.", "properties": { "id": { "description": "The compensation grade's unique identifier.", "type": "string" }, "label": { "description": "The compensation grade's label.", "type": "string" } }, "title": "WorkerCompensationGrade", "type": "object" }, "compensation_id": { "description": "The compensation package for the worker.", "type": "string" }, "country": { "description": "The worker's country.", "type": "string" }, "country_fields": { "description": "Country level fields for the worker.", "properties": { "ca": { "description": "Country-wise regional fields for Canada", "properties": { "sin": { "description": "Social Insurance Number (SIN) for Canada employees.", "type": "string" } }, "title": "CanadaFields", "type": "object" }, "nz": { "description": "Country-wise regional fields for New Zealand", "properties": { "ird_number": { "description": "Inland Revenue Department (IRD) number for New Zealand employees.", "type": "string" } }, "title": "NewZealandFields", "type": "object" }, "us": { "description": "Country-wise regional fields for USA", "properties": { "ssn": { "description": "Social Security Number (SSN) for US employees.", "type": "string" } }, "title": "USFields", "type": "object" } }, "title": "CountryFields", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "custom_fields": { "description": "Custom field values defined on the Employee object for this worker\n\nExpandable field", "items": { "additionalProperties": {} }, "type": "array" }, "date_of_birth": { "description": "The worker's date of birth.", "type": "string" }, "department": { "description": "The worker's assigned department.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "department_hierarchy": { "description": "List of departments in the department hierarchy. Refer department_hierarchy_ids for department hierarchy order.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestDepartment" }, "type": "array" }, "department_hierarchy_id": { "description": "The identifier of departments in the department hierarchy ordered from parent department to child department.", "items": { "type": "string" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the department.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestDepartment", "description": "The parent department.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent department.", "type": "string" }, "reference_code": { "description": "Reference code of the department.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Department", "type": "object" }, "department_id": { "description": "The worker's assigned department.", "type": "string" }, "employment_type": { "description": "The worker's employment type.\n\nExpandable field", "properties": { "amount_worked": { "description": "The amount worked for the employment type. * `FULL-TIME`: Full-time is at least 30 hours per week. Full-time workers will typically be eligible for benefits. * `PART-TIME`: Part-time is less than 30 hours per week. These workers may be eligible for benefits, depending on company settings and hours worked. * `TEMPORARY`: These workers are hired on a temporary basis. You can specify how each worker with this employment type will be paid individually.", "type": "string" }, "compensation_time_period": { "description": "The compensation period for the employment type. * `SALARIED`: Employees that are paid a fixed amount per year. * `HOURLY`: Employees that are paid a wage per hour worked.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "label": { "description": "The display label of the employment type.", "type": "string" }, "name": { "description": "The name of the employment type for non-custom employment types.", "type": "string" }, "type": { "description": "The classification of the worker by the company. * `CONTRACTOR`: Contractors are self-employed workers who provide services on a short-term or per-project basis and are not eligible for tax-withholding or benefits. * `EMPLOYEE`: Employees are hired and managed by an employer, work under the employer's direct supervision and control, and are protected by law for wages and employment rights.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "label", "updated_at" ], "title": "CompanyEmploymentType", "type": "object" }, "employment_type_id": { "description": "The worker's employment type.", "type": "string" }, "end_date": { "description": "The end date of the worker.", "type": "string" }, "ethnicity": { "description": "The identified ethnicity of the worker, if specified.", "type": "string" }, "gender": { "description": "The gender of the worker, if specified.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_manager": { "description": "Whether the worker is a manager", "type": "boolean" }, "job_function": { "description": "The worker's job function. When expanded, this field requires `job-functions.read`.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "Displayed name of the job function", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "JobFunction", "type": "object" }, "job_function_id": { "description": "ID of the worker's job function.", "type": "string" }, "legal_entity": { "description": "The worker's associated legal entity.\n\nExpandable field", "properties": { "company": { "description": "The company or organization associated with the legal entity\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "doing_business_as_name": { "description": "The doing business as name for the company.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_entities": { "description": "A list of the company's entities.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestLegalEntity" }, "type": "array" }, "legal_entities_id": { "description": "A list of the company's entities.", "items": { "type": "string" }, "type": "array" }, "legal_name": { "description": "The legal name of the company.", "type": "string" }, "name": { "description": "The name of the company.", "type": "string" }, "parent_legal_entity": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The company's ultimate holding entity.\n\nExpandable field", "type": "object" }, "parent_legal_entity_id": { "description": "The company's ultimate holding entity.", "type": "string" }, "phone": { "description": "The phone number for the company.", "type": "string" }, "physical_address": { "description": "The physical address of the holding entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "primary_email": { "description": "The email address used when registering this company.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "legal_entities", "legal_entities_id", "name", "updated_at" ], "title": "Company", "type": "object" }, "company_id": { "description": "The company or organization associated with the legal entity", "type": "string" }, "country": { "description": "The country the legal entity is based in.", "properties": { "code": { "description": "The code of the country.", "type": "string" } }, "required": [ "code" ], "title": "Country", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "entity_level": { "description": "The legal entity's level in a hierarchy. * `PARENT`: The legal entity is considered the ultimate holding entity. * `SUBSIDIARY`: The legal entity is considered a subsidiary, fully or partially held by another. * `BRANCH`: The legal entity is considered a branch, associated with a parent legal entity.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_name": { "description": "The legal name of the legal entity.", "type": "string" }, "mailing_address": { "description": "The mailing address of the legal entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "management_type": { "description": "The legal entity management type in the case of an employer of record (EOR) or professional employment organization (PEO). * `PEO`: The legal entity is considered a Professional Employment Organization (PEO). * `EOR`: The legal entity is considered an Employer of Record (EOR).", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The parent legal entity.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent legal entity.", "type": "string" }, "physical_address": { "description": "The physical address of the legal entity, if it differs from the mailing address.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "registration_date": { "description": "The registration date of the entity.", "type": "string" }, "tax_identifier": { "description": "The tax identifier for the legal entity.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "LegalEntity", "type": "object" }, "legal_entity_id": { "description": "The worker's associated legal entity.", "type": "string" }, "level": { "description": "The level of the worker.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "description": { "description": "The description of the level.", "type": "string" }, "experience_requirements": { "description": "The experience requirements for the level.", "type": "string" }, "global_level": { "anyOf": [ { "description": "Global level is used to track the seniority of levels. The higher up a level is placed on the page, the more senior and higher-ranked the level. Global level is used in workflows, policies, and reports that use the level attribute (e.g., you can use Level Lookup to set up a workflow that notifies the nearest person in an worker's management chain at or above the specified level).", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the level. Must be unique within the company or organization.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLevel", "description": "The parent level.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent level.", "type": "string" }, "rank": { "anyOf": [ { "description": "The rank of the level within its track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "scope_of_responsibilities": { "description": "The scope of responsibilities for the level.", "type": "string" }, "track": { "description": "The track associated with the level, if it's not a global level.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_default": { "description": "Whether this is the company's default track.", "type": "boolean" }, "name": { "description": "The name of the track. Must be unique within the company or organization.", "type": "string" }, "order": { "anyOf": [ { "description": "The one-based horizontal display order of the track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "start_global_level": { "anyOf": [ { "description": "The highest global level occupied by this track. Empty tracks return null.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Track", "type": "object" }, "track_id": { "description": "The track associated with the level. Required during creation. Include global_level when changing it.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Level", "type": "object" }, "level_id": { "description": "The level of the worker.", "type": "string" }, "location": { "description": "The location that the worker is mapped to for tax purposes. In the case that a worker is remote, the location's type is remote.", "properties": { "type": { "description": "The type of location.", "type": "string" }, "work_location_id": { "description": "The work location, if the worker isn't remote.", "type": "string" } }, "required": [ "type", "work_location_id" ], "title": "WorkerLocation", "type": "object" }, "manager": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's manager.\n\nExpandable field", "type": "object" }, "manager_id": { "description": "The worker's manager.", "type": "string" }, "number": { "anyOf": [ { "description": "The worker's number within the organization.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "original_start_date": { "description": "The worker's earliest start date across their employment history, excluding INIT roles.", "type": "string" }, "overtime_exemption": { "description": "The worker's overtime exemption status.", "type": "string" }, "pay_schedule_id": { "description": "The ID of the pay schedule currently associated with the worker.", "type": "string" }, "personal_email": { "description": "The worker's associated personal email address.", "type": "string" }, "race": { "description": "The identified race of the worker, if specified.", "type": "string" }, "start_date": { "description": "The start date of the worker.", "type": "string" }, "status": { "description": "The worker's status within the organization.", "type": "string" }, "teams": { "description": "The worker's assigned teams.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiTeamcb26bc28f32f" }, "type": "array" }, "teams_id": { "description": "The worker's assigned teams.", "items": { "type": "string" }, "type": "array" }, "termination_details": { "description": "The details of the worker's termination, if applicable.", "properties": { "reason": { "description": "This is a description that will be custom to each Rippling company.", "type": "string" }, "type": { "description": "The termination type indicates whether the termination was voluntary or involuntary.", "type": "string" } }, "title": "TerminationDetails", "type": "object" }, "title": { "description": "The worker's title.", "type": "string" }, "title_effective_date": { "description": "Title effective date", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "user": { "description": "The worker's associated user.\n\nExpandable field", "properties": { "active": { "description": "Whether the user is able to access company resources, typically when they are in actively engaged with the company and not after off-boarding.", "type": "boolean" }, "addresses": { "description": "The user's addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiUserAddressedd59b9ba9a1" }, "type": "array" }, "created_at": { "description": "Record creation date", "type": "string" }, "display_name": { "description": "The display name of the user using either the concatenated preferred given and family name or username depending on availability.", "type": "string" }, "emails": { "description": "The user's email addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiEmail5284c8258dc3" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "locale": { "description": "The User's default location for purposes of localization of currency, date time format, or numerical representations pursuant to RFC5646.", "type": "string" }, "name": { "description": "The user's name.", "properties": { "family_name": { "description": "The legal family name of the user, or last name in most Western languages.", "type": "string" }, "formatted": { "description": "The user's full name.", "type": "string" }, "given_name": { "description": "The given legal name of the user, or first name in most Western languages.", "type": "string" }, "middle_name": { "description": "The middle name(s) of the user.", "type": "string" }, "preferred_family_name": { "description": "The preferred family name, or last name in most Western languages, by the user.", "type": "string" }, "preferred_given_name": { "description": "The preferred given name, or first name in most Western languages, by the user.", "type": "string" } }, "title": "UserName", "type": "object" }, "number": { "description": "The permanent profile number of the user.", "type": "string" }, "phone_numbers": { "description": "The user's phone numbers.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoneNumber12060c61ecf5" }, "type": "array" }, "photos": { "description": "The user's photos.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoto2be7c3ae3f39" }, "type": "array" }, "preferred_language": { "description": "The User's preferred written or spoken language in the same format of the HTTP Accept-Language header, pursuant to Section 5.3.5 of RFC7231.", "type": "string" }, "timezone": { "description": "The User's current time zone in IANA database Olson format", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "username": { "description": "The unique identifier across Rippling used by the User for direct authentication into their associated company. Globally unique.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "User", "type": "object" }, "user_id": { "description": "The worker's associated user.", "type": "string" }, "work_email": { "description": "The worker's associated work email address.", "type": "string" }, "work_schedule": { "additionalProperties": { "$ref": "#/components/schemas/OutputRestApiWorkScheduleDay938f88d94f20" }, "description": "The worker's scheduled working hours for each day of the week.", "type": "object" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Worker", "type": "object" }, "recruiter_id": { "description": "ID for the recruiter working on filling the position", "type": "string" }, "target_start_date": { "description": "The estimated start date when the position was first created", "type": "string" }, "teams": { "description": "Teams the headcount belongs to\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiTeamcb26bc28f32f" }, "type": "array" }, "teams_id": { "description": "IDs for the teams the headcount belongs to", "items": { "type": "string" }, "type": "array" }, "title": { "description": "Job title for the position. For a vacant headcount position, this can be defined on creation. Once the position is occupied, it’s synched from the associated worker’s job title.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "work_location": { "description": "Work location the headcount is assigned to\n\nExpandable field", "properties": { "address": { "description": "The address for the work location.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the work location.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "address", "created_at", "id", "name", "updated_at" ], "title": "WorkLocation", "type": "object" }, "work_location_id": { "description": "ID for the work location the headcount is assigned to", "type": "string" }, "worker": { "description": "Worker hired into the headcount\n\nExpandable field", "properties": { "business_partners": { "description": "Worker's assigned business partners. This field is only populated when explicitly requested via the expand parameter (e.g., ?expand=business_partners). When expanded, returns an empty list ([]) if the worker has no business partners.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiBusinessPartner77b00a069c32" }, "type": "array" }, "business_partners_id": { "description": "Worker's assigned business partners unique identifiers. Returns an empty list ([]) if the worker has no business partners.", "items": { "type": "string" }, "type": "array" }, "citizenship": { "description": "The countries that the worker has citizenship in.", "type": "string" }, "compensation": { "description": "The compensation package for the worker.\n\nExpandable field", "properties": { "annual_compensation": { "description": "The worker's annual compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "annual_salary_equivalent": { "description": "The worker's annual salary equivalent, for insurance purposes. It will be equal to the worker's annual compensation, except for owners that are receiving no cashcompensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "bonus_schedule": { "description": "The worker's bonus schedule.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "hourly_wage": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "id": { "description": "Identifier field", "type": "string" }, "monthly_compensation": { "description": "The worker's monthly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "on_target_commission": { "description": "The worker's on-target commission.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "payment_terms": { "description": "The payment terms for an worker's compensation.", "type": "string" }, "payment_type": { "description": "The payment type for an worker's compensation.", "type": "string" }, "relocation_reimbursement": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "salary_effective_date": { "description": "Salary effective date", "type": "string" }, "signing_bonus": { "description": "The worker's signing bonus.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus": { "description": "The worker's target annual bonus amount.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus_percent": { "anyOf": [ { "description": "The worker's target annual bonus as a percent of annual compensation.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" }, "weekly_compensation": { "description": "The worker's weekly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "worker": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's details.\n\nExpandable field", "type": "object" }, "worker_id": { "description": "The worker's ID.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Compensation", "type": "object" }, "compensation_grade": { "description": "The compensation grade assigned to the worker, if any.", "properties": { "id": { "description": "The compensation grade's unique identifier.", "type": "string" }, "label": { "description": "The compensation grade's label.", "type": "string" } }, "title": "WorkerCompensationGrade", "type": "object" }, "compensation_id": { "description": "The compensation package for the worker.", "type": "string" }, "country": { "description": "The worker's country.", "type": "string" }, "country_fields": { "description": "Country level fields for the worker.", "properties": { "ca": { "description": "Country-wise regional fields for Canada", "properties": { "sin": { "description": "Social Insurance Number (SIN) for Canada employees.", "type": "string" } }, "title": "CanadaFields", "type": "object" }, "nz": { "description": "Country-wise regional fields for New Zealand", "properties": { "ird_number": { "description": "Inland Revenue Department (IRD) number for New Zealand employees.", "type": "string" } }, "title": "NewZealandFields", "type": "object" }, "us": { "description": "Country-wise regional fields for USA", "properties": { "ssn": { "description": "Social Security Number (SSN) for US employees.", "type": "string" } }, "title": "USFields", "type": "object" } }, "title": "CountryFields", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "custom_fields": { "description": "Custom field values defined on the Employee object for this worker\n\nExpandable field", "items": { "additionalProperties": {} }, "type": "array" }, "date_of_birth": { "description": "The worker's date of birth.", "type": "string" }, "department": { "description": "The worker's assigned department.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "department_hierarchy": { "description": "List of departments in the department hierarchy. Refer department_hierarchy_ids for department hierarchy order.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestDepartment" }, "type": "array" }, "department_hierarchy_id": { "description": "The identifier of departments in the department hierarchy ordered from parent department to child department.", "items": { "type": "string" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the department.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestDepartment", "description": "The parent department.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent department.", "type": "string" }, "reference_code": { "description": "Reference code of the department.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Department", "type": "object" }, "department_id": { "description": "The worker's assigned department.", "type": "string" }, "employment_type": { "description": "The worker's employment type.\n\nExpandable field", "properties": { "amount_worked": { "description": "The amount worked for the employment type. * `FULL-TIME`: Full-time is at least 30 hours per week. Full-time workers will typically be eligible for benefits. * `PART-TIME`: Part-time is less than 30 hours per week. These workers may be eligible for benefits, depending on company settings and hours worked. * `TEMPORARY`: These workers are hired on a temporary basis. You can specify how each worker with this employment type will be paid individually.", "type": "string" }, "compensation_time_period": { "description": "The compensation period for the employment type. * `SALARIED`: Employees that are paid a fixed amount per year. * `HOURLY`: Employees that are paid a wage per hour worked.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "label": { "description": "The display label of the employment type.", "type": "string" }, "name": { "description": "The name of the employment type for non-custom employment types.", "type": "string" }, "type": { "description": "The classification of the worker by the company. * `CONTRACTOR`: Contractors are self-employed workers who provide services on a short-term or per-project basis and are not eligible for tax-withholding or benefits. * `EMPLOYEE`: Employees are hired and managed by an employer, work under the employer's direct supervision and control, and are protected by law for wages and employment rights.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "label", "updated_at" ], "title": "CompanyEmploymentType", "type": "object" }, "employment_type_id": { "description": "The worker's employment type.", "type": "string" }, "end_date": { "description": "The end date of the worker.", "type": "string" }, "ethnicity": { "description": "The identified ethnicity of the worker, if specified.", "type": "string" }, "gender": { "description": "The gender of the worker, if specified.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_manager": { "description": "Whether the worker is a manager", "type": "boolean" }, "job_function": { "description": "The worker's job function. When expanded, this field requires `job-functions.read`.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "Displayed name of the job function", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "JobFunction", "type": "object" }, "job_function_id": { "description": "ID of the worker's job function.", "type": "string" }, "legal_entity": { "description": "The worker's associated legal entity.\n\nExpandable field", "properties": { "company": { "description": "The company or organization associated with the legal entity\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "doing_business_as_name": { "description": "The doing business as name for the company.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_entities": { "description": "A list of the company's entities.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestLegalEntity" }, "type": "array" }, "legal_entities_id": { "description": "A list of the company's entities.", "items": { "type": "string" }, "type": "array" }, "legal_name": { "description": "The legal name of the company.", "type": "string" }, "name": { "description": "The name of the company.", "type": "string" }, "parent_legal_entity": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The company's ultimate holding entity.\n\nExpandable field", "type": "object" }, "parent_legal_entity_id": { "description": "The company's ultimate holding entity.", "type": "string" }, "phone": { "description": "The phone number for the company.", "type": "string" }, "physical_address": { "description": "The physical address of the holding entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "primary_email": { "description": "The email address used when registering this company.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "legal_entities", "legal_entities_id", "name", "updated_at" ], "title": "Company", "type": "object" }, "company_id": { "description": "The company or organization associated with the legal entity", "type": "string" }, "country": { "description": "The country the legal entity is based in.", "properties": { "code": { "description": "The code of the country.", "type": "string" } }, "required": [ "code" ], "title": "Country", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "entity_level": { "description": "The legal entity's level in a hierarchy. * `PARENT`: The legal entity is considered the ultimate holding entity. * `SUBSIDIARY`: The legal entity is considered a subsidiary, fully or partially held by another. * `BRANCH`: The legal entity is considered a branch, associated with a parent legal entity.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_name": { "description": "The legal name of the legal entity.", "type": "string" }, "mailing_address": { "description": "The mailing address of the legal entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "management_type": { "description": "The legal entity management type in the case of an employer of record (EOR) or professional employment organization (PEO). * `PEO`: The legal entity is considered a Professional Employment Organization (PEO). * `EOR`: The legal entity is considered an Employer of Record (EOR).", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The parent legal entity.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent legal entity.", "type": "string" }, "physical_address": { "description": "The physical address of the legal entity, if it differs from the mailing address.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "registration_date": { "description": "The registration date of the entity.", "type": "string" }, "tax_identifier": { "description": "The tax identifier for the legal entity.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "LegalEntity", "type": "object" }, "legal_entity_id": { "description": "The worker's associated legal entity.", "type": "string" }, "level": { "description": "The level of the worker.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "description": { "description": "The description of the level.", "type": "string" }, "experience_requirements": { "description": "The experience requirements for the level.", "type": "string" }, "global_level": { "anyOf": [ { "description": "Global level is used to track the seniority of levels. The higher up a level is placed on the page, the more senior and higher-ranked the level. Global level is used in workflows, policies, and reports that use the level attribute (e.g., you can use Level Lookup to set up a workflow that notifies the nearest person in an worker's management chain at or above the specified level).", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the level. Must be unique within the company or organization.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLevel", "description": "The parent level.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent level.", "type": "string" }, "rank": { "anyOf": [ { "description": "The rank of the level within its track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "scope_of_responsibilities": { "description": "The scope of responsibilities for the level.", "type": "string" }, "track": { "description": "The track associated with the level, if it's not a global level.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_default": { "description": "Whether this is the company's default track.", "type": "boolean" }, "name": { "description": "The name of the track. Must be unique within the company or organization.", "type": "string" }, "order": { "anyOf": [ { "description": "The one-based horizontal display order of the track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "start_global_level": { "anyOf": [ { "description": "The highest global level occupied by this track. Empty tracks return null.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Track", "type": "object" }, "track_id": { "description": "The track associated with the level. Required during creation. Include global_level when changing it.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Level", "type": "object" }, "level_id": { "description": "The level of the worker.", "type": "string" }, "location": { "description": "The location that the worker is mapped to for tax purposes. In the case that a worker is remote, the location's type is remote.", "properties": { "type": { "description": "The type of location.", "type": "string" }, "work_location_id": { "description": "The work location, if the worker isn't remote.", "type": "string" } }, "required": [ "type", "work_location_id" ], "title": "WorkerLocation", "type": "object" }, "manager": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's manager.\n\nExpandable field", "type": "object" }, "manager_id": { "description": "The worker's manager.", "type": "string" }, "number": { "anyOf": [ { "description": "The worker's number within the organization.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "original_start_date": { "description": "The worker's earliest start date across their employment history, excluding INIT roles.", "type": "string" }, "overtime_exemption": { "description": "The worker's overtime exemption status.", "type": "string" }, "pay_schedule_id": { "description": "The ID of the pay schedule currently associated with the worker.", "type": "string" }, "personal_email": { "description": "The worker's associated personal email address.", "type": "string" }, "race": { "description": "The identified race of the worker, if specified.", "type": "string" }, "start_date": { "description": "The start date of the worker.", "type": "string" }, "status": { "description": "The worker's status within the organization.", "type": "string" }, "teams": { "description": "The worker's assigned teams.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiTeamcb26bc28f32f" }, "type": "array" }, "teams_id": { "description": "The worker's assigned teams.", "items": { "type": "string" }, "type": "array" }, "termination_details": { "description": "The details of the worker's termination, if applicable.", "properties": { "reason": { "description": "This is a description that will be custom to each Rippling company.", "type": "string" }, "type": { "description": "The termination type indicates whether the termination was voluntary or involuntary.", "type": "string" } }, "title": "TerminationDetails", "type": "object" }, "title": { "description": "The worker's title.", "type": "string" }, "title_effective_date": { "description": "Title effective date", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "user": { "description": "The worker's associated user.\n\nExpandable field", "properties": { "active": { "description": "Whether the user is able to access company resources, typically when they are in actively engaged with the company and not after off-boarding.", "type": "boolean" }, "addresses": { "description": "The user's addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiUserAddressedd59b9ba9a1" }, "type": "array" }, "created_at": { "description": "Record creation date", "type": "string" }, "display_name": { "description": "The display name of the user using either the concatenated preferred given and family name or username depending on availability.", "type": "string" }, "emails": { "description": "The user's email addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiEmail5284c8258dc3" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "locale": { "description": "The User's default location for purposes of localization of currency, date time format, or numerical representations pursuant to RFC5646.", "type": "string" }, "name": { "description": "The user's name.", "properties": { "family_name": { "description": "The legal family name of the user, or last name in most Western languages.", "type": "string" }, "formatted": { "description": "The user's full name.", "type": "string" }, "given_name": { "description": "The given legal name of the user, or first name in most Western languages.", "type": "string" }, "middle_name": { "description": "The middle name(s) of the user.", "type": "string" }, "preferred_family_name": { "description": "The preferred family name, or last name in most Western languages, by the user.", "type": "string" }, "preferred_given_name": { "description": "The preferred given name, or first name in most Western languages, by the user.", "type": "string" } }, "title": "UserName", "type": "object" }, "number": { "description": "The permanent profile number of the user.", "type": "string" }, "phone_numbers": { "description": "The user's phone numbers.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoneNumber12060c61ecf5" }, "type": "array" }, "photos": { "description": "The user's photos.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoto2be7c3ae3f39" }, "type": "array" }, "preferred_language": { "description": "The User's preferred written or spoken language in the same format of the HTTP Accept-Language header, pursuant to Section 5.3.5 of RFC7231.", "type": "string" }, "timezone": { "description": "The User's current time zone in IANA database Olson format", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "username": { "description": "The unique identifier across Rippling used by the User for direct authentication into their associated company. Globally unique.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "User", "type": "object" }, "user_id": { "description": "The worker's associated user.", "type": "string" }, "work_email": { "description": "The worker's associated work email address.", "type": "string" }, "work_schedule": { "additionalProperties": { "$ref": "#/components/schemas/OutputRestApiWorkScheduleDay938f88d94f20" }, "description": "The worker's scheduled working hours for each day of the week.", "type": "object" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Worker", "type": "object" }, "worker_id": { "description": "ID for the worker hired into the headcount", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Retrieve a specific headcount position", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "headcount-positions.read" ] } }, "/headcount-priorities/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/list-headcount-priorities" }, "operationId": "rippling.rest_api.list_headcount_priorities", "parameters": [ { "in": "query", "name": "order_by", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 100, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "__meta": { "$ref": "#/components/schemas/OutputRestApiRedactedFields9f7657dc2a2f" }, "next_link": { "description": "A link to the next page of responses.", "format": "uri", "type": "string" }, "results": { "items": { "$ref": "#/components/schemas/OutputRestApiHeadcountPriority8e286a534c4f" }, "type": "array" } }, "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "List headcount priorities", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "headcount-priorities.read" ] } }, "/headcount-priorities/{id}/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/get-headcount-priorities" }, "operationId": "rippling.rest_api.get_headcount_priorities", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "id", "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "__meta": { "properties": { "redacted_fields": { "items": { "$ref": "#/components/schemas/OutputRestApiRedactedField21788a25ef22" }, "type": "array" } }, "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "Display name of the headcount priority", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Retrieve a specific headcount priority", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "headcount-priorities.read" ] } }, "/hire-requirements/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/get-hire-requirements" }, "operationId": "rippling.rest_api.get_hire_requirements", "parameters": [ { "in": "query", "name": "country_code", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "hire_type", "required": true, "schema": { "enum": [ "direct_hire" ], "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OutputRestApiHireRequirementsResponse9d2e8d2e72a5" } } }, "description": "Successful response" }, "400": { "description": "Unsupported country or hire type for the first milestone.", "x-rippling-source-response": { "description": "Unsupported country or hire type for the first milestone." } } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Get hire requirements", "x-rippling-entitlements": [ "Hires_API" ], "x-rippling-required-scopes": [ "hire-requirements.read" ] } }, "/hires/": { "post": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/create-hires" }, "operationId": "rippling.rest_api.create_hires", "parameters": [ { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiCreateHiresRequestebce6fbc5b1f" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/OutputRestApiCreateHiresResponse4353de9e8bc9" }, { "$ref": "#/components/schemas/OutputRestApiCreateHiresResponse4353de9e8bc9" } ] } } }, "description": "Envelope processed but no role was created." }, "201": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/OutputRestApiCreateHiresResponse4353de9e8bc9" }, { "$ref": "#/components/schemas/OutputRestApiCreateHiresResponse4353de9e8bc9" } ] } } }, "description": "At least one hire role was created or continued." }, "400": { "description": "Malformed envelope, missing idempotency key, or unsupported context.", "x-rippling-source-response": { "description": "Malformed envelope, missing idempotency key, or unsupported context." } }, "409": { "description": "Idempotency conflict or in-progress replay.", "x-rippling-source-response": { "description": "Idempotency conflict or in-progress replay." } } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Create hire", "x-rippling-entitlements": [ "Hires_API" ], "x-rippling-required-scopes": [ "hires.read-write" ] } }, "/job-assignments/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/list-job-assignments" }, "operationId": "rippling.rest_api.list_job_assignments", "parameters": [ { "in": "query", "name": "filter", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "expand", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 100, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "__meta": { "$ref": "#/components/schemas/OutputRestApiRedactedFields9f7657dc2a2f" }, "next_link": { "description": "A link to the next page of responses.", "format": "uri", "type": "string" }, "results": { "items": { "$ref": "#/components/schemas/OutputRestApiJobAssignment92ce85414dcb" }, "type": "array" } }, "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "List job assignments", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "job-assignments.read" ] }, "post": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/create-job-assignments" }, "operationId": "rippling.rest_api.create_job_assignments", "parameters": [ { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiJobAssignmentRequest8114b3771e85" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "base_pay_rate": { "anyOf": [ { "description": "Base compensation rate of worker", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "job_code": { "description": "Job that is assigned to worker\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "custom_location": { "description": "The custom location of the job code. This location will be used for tax calculation purposes if using US Payroll when an employee is working at this job code.", "properties": { "address": { "description": "The address of the custom location.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" } }, "required": [ "address" ], "title": "CustomLocation", "type": "object" }, "department": { "description": "The department associated with the job code.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "department_hierarchy": { "description": "List of departments in the department hierarchy. Refer department_hierarchy_ids for department hierarchy order.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestDepartment" }, "type": "array" }, "department_hierarchy_id": { "description": "The identifier of departments in the department hierarchy ordered from parent department to child department.", "items": { "type": "string" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the department.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestDepartment", "description": "The parent department.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent department.", "type": "string" }, "reference_code": { "description": "Reference code of the department.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Department", "type": "object" }, "department_id": { "description": "The department associated with the job code.", "type": "string" }, "external_id": { "description": "The unique identifier of the job code in an outside system.", "type": "string" }, "group_id": { "description": "The ID of the job roster group.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_archived": { "description": "Whether this job code is archived. Set to true via PATCH to archive. Archiving is irreversible via this API.", "type": "boolean" }, "job_dimension": { "description": "The job dimension this job code belongs to.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "external_id": { "description": "The unique identifier of the job dimension in a third party system", "type": "string" }, "group_id": { "description": "The ID of the dimension roster group.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "includes_custom_location": { "description": "Whether the job dimension includes codes related to a custom location. Only one dimension can have this set to true.", "type": "boolean" }, "name": { "description": "The name of the job dimension", "type": "string" }, "org_attribute_associations": { "description": "Organizational attributes associated with the job dimension. Only 'PAY_RATE' can be set or modified using POST or PATCH requests.", "items": {}, "type": "array" }, "roster_type": { "description": "The roster type of the dimension. PER_DIMENSION means that there is a group on the dimension level and employees within that group have access to all job codes in the dimension. PER_JOB_CODE means that each job code has its own group.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "JobDimension", "type": "object" }, "job_dimension_id": { "description": "The ID of the job dimension this job code belongs to.", "type": "string" }, "name": { "description": "The name of the job dimension.", "type": "string" }, "pay_rate": { "anyOf": [ { "description": "The pay rate for this job code. Only applicable if the associated job dimension includes the 'PAY_RATE' organizational attribute.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "pay_rate_exceptions": { "description": "Pay rate overrides for the job based on exception dimension values.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiJobPayRateExceptionaf426aa0ac14" }, "type": "array" }, "pay_rate_exceptions_id": { "description": "Pay rate overrides id for the job based on exception dimension values.", "items": { "type": "string" }, "type": "array" }, "updated_at": { "description": "Record update date", "type": "string" }, "work_location": { "description": "The work location associated with the job code.\n\nExpandable field", "properties": { "address": { "description": "The address for the work location.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the work location.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "address", "created_at", "id", "name", "updated_at" ], "title": "WorkLocation", "type": "object" }, "work_location_id": { "description": "The work location associated with the job code.", "type": "string" } }, "required": [ "created_at", "id", "job_dimension_id", "name", "updated_at" ], "title": "JobCode", "type": "object" }, "job_code_id": { "description": "Identifier of job that is assigned to worker", "type": "string" }, "job_pay_rate": { "anyOf": [ { "description": "The pay rate for job assigned to worker. This can be different from the job's standard pay rate and can be overriden for a worker.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "job_pay_rate_exceptions": { "description": "Pay rate exceptions applicable for the worker based on certain exception dimension values.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiJobPayRateException2b2788a4d92c" }, "type": "array" }, "job_pay_rate_exceptions_id": { "description": "Identifier of pay rate exceptions applicable for the worker based on certain exception dimension values.", "items": { "type": "string" }, "type": "array" }, "updated_at": { "description": "Record update date", "type": "string" }, "worker": { "description": "Worker to whom job is assigned.\n\nExpandable field", "properties": { "business_partners": { "description": "Worker's assigned business partners. This field is only populated when explicitly requested via the expand parameter (e.g., ?expand=business_partners). When expanded, returns an empty list ([]) if the worker has no business partners.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiBusinessPartner77b00a069c32" }, "type": "array" }, "business_partners_id": { "description": "Worker's assigned business partners unique identifiers. Returns an empty list ([]) if the worker has no business partners.", "items": { "type": "string" }, "type": "array" }, "citizenship": { "description": "The countries that the worker has citizenship in.", "type": "string" }, "compensation": { "description": "The compensation package for the worker.\n\nExpandable field", "properties": { "annual_compensation": { "description": "The worker's annual compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "annual_salary_equivalent": { "description": "The worker's annual salary equivalent, for insurance purposes. It will be equal to the worker's annual compensation, except for owners that are receiving no cashcompensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "bonus_schedule": { "description": "The worker's bonus schedule.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "hourly_wage": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "id": { "description": "Identifier field", "type": "string" }, "monthly_compensation": { "description": "The worker's monthly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "on_target_commission": { "description": "The worker's on-target commission.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "payment_terms": { "description": "The payment terms for an worker's compensation.", "type": "string" }, "payment_type": { "description": "The payment type for an worker's compensation.", "type": "string" }, "relocation_reimbursement": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "salary_effective_date": { "description": "Salary effective date", "type": "string" }, "signing_bonus": { "description": "The worker's signing bonus.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus": { "description": "The worker's target annual bonus amount.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus_percent": { "anyOf": [ { "description": "The worker's target annual bonus as a percent of annual compensation.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" }, "weekly_compensation": { "description": "The worker's weekly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "worker": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's details.\n\nExpandable field", "type": "object" }, "worker_id": { "description": "The worker's ID.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Compensation", "type": "object" }, "compensation_grade": { "description": "The compensation grade assigned to the worker, if any.", "properties": { "id": { "description": "The compensation grade's unique identifier.", "type": "string" }, "label": { "description": "The compensation grade's label.", "type": "string" } }, "title": "WorkerCompensationGrade", "type": "object" }, "compensation_id": { "description": "The compensation package for the worker.", "type": "string" }, "country": { "description": "The worker's country.", "type": "string" }, "country_fields": { "description": "Country level fields for the worker.", "properties": { "ca": { "description": "Country-wise regional fields for Canada", "properties": { "sin": { "description": "Social Insurance Number (SIN) for Canada employees.", "type": "string" } }, "title": "CanadaFields", "type": "object" }, "nz": { "description": "Country-wise regional fields for New Zealand", "properties": { "ird_number": { "description": "Inland Revenue Department (IRD) number for New Zealand employees.", "type": "string" } }, "title": "NewZealandFields", "type": "object" }, "us": { "description": "Country-wise regional fields for USA", "properties": { "ssn": { "description": "Social Security Number (SSN) for US employees.", "type": "string" } }, "title": "USFields", "type": "object" } }, "title": "CountryFields", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "custom_fields": { "description": "Custom field values defined on the Employee object for this worker\n\nExpandable field", "items": { "additionalProperties": {} }, "type": "array" }, "date_of_birth": { "description": "The worker's date of birth.", "type": "string" }, "department": { "description": "The worker's assigned department.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "department_hierarchy": { "description": "List of departments in the department hierarchy. Refer department_hierarchy_ids for department hierarchy order.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestDepartment" }, "type": "array" }, "department_hierarchy_id": { "description": "The identifier of departments in the department hierarchy ordered from parent department to child department.", "items": { "type": "string" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the department.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestDepartment", "description": "The parent department.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent department.", "type": "string" }, "reference_code": { "description": "Reference code of the department.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Department", "type": "object" }, "department_id": { "description": "The worker's assigned department.", "type": "string" }, "employment_type": { "description": "The worker's employment type.\n\nExpandable field", "properties": { "amount_worked": { "description": "The amount worked for the employment type. * `FULL-TIME`: Full-time is at least 30 hours per week. Full-time workers will typically be eligible for benefits. * `PART-TIME`: Part-time is less than 30 hours per week. These workers may be eligible for benefits, depending on company settings and hours worked. * `TEMPORARY`: These workers are hired on a temporary basis. You can specify how each worker with this employment type will be paid individually.", "type": "string" }, "compensation_time_period": { "description": "The compensation period for the employment type. * `SALARIED`: Employees that are paid a fixed amount per year. * `HOURLY`: Employees that are paid a wage per hour worked.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "label": { "description": "The display label of the employment type.", "type": "string" }, "name": { "description": "The name of the employment type for non-custom employment types.", "type": "string" }, "type": { "description": "The classification of the worker by the company. * `CONTRACTOR`: Contractors are self-employed workers who provide services on a short-term or per-project basis and are not eligible for tax-withholding or benefits. * `EMPLOYEE`: Employees are hired and managed by an employer, work under the employer's direct supervision and control, and are protected by law for wages and employment rights.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "label", "updated_at" ], "title": "CompanyEmploymentType", "type": "object" }, "employment_type_id": { "description": "The worker's employment type.", "type": "string" }, "end_date": { "description": "The end date of the worker.", "type": "string" }, "ethnicity": { "description": "The identified ethnicity of the worker, if specified.", "type": "string" }, "gender": { "description": "The gender of the worker, if specified.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_manager": { "description": "Whether the worker is a manager", "type": "boolean" }, "job_function": { "description": "The worker's job function. When expanded, this field requires `job-functions.read`.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "Displayed name of the job function", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "JobFunction", "type": "object" }, "job_function_id": { "description": "ID of the worker's job function.", "type": "string" }, "legal_entity": { "description": "The worker's associated legal entity.\n\nExpandable field", "properties": { "company": { "description": "The company or organization associated with the legal entity\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "doing_business_as_name": { "description": "The doing business as name for the company.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_entities": { "description": "A list of the company's entities.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestLegalEntity" }, "type": "array" }, "legal_entities_id": { "description": "A list of the company's entities.", "items": { "type": "string" }, "type": "array" }, "legal_name": { "description": "The legal name of the company.", "type": "string" }, "name": { "description": "The name of the company.", "type": "string" }, "parent_legal_entity": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The company's ultimate holding entity.\n\nExpandable field", "type": "object" }, "parent_legal_entity_id": { "description": "The company's ultimate holding entity.", "type": "string" }, "phone": { "description": "The phone number for the company.", "type": "string" }, "physical_address": { "description": "The physical address of the holding entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "primary_email": { "description": "The email address used when registering this company.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "legal_entities", "legal_entities_id", "name", "updated_at" ], "title": "Company", "type": "object" }, "company_id": { "description": "The company or organization associated with the legal entity", "type": "string" }, "country": { "description": "The country the legal entity is based in.", "properties": { "code": { "description": "The code of the country.", "type": "string" } }, "required": [ "code" ], "title": "Country", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "entity_level": { "description": "The legal entity's level in a hierarchy. * `PARENT`: The legal entity is considered the ultimate holding entity. * `SUBSIDIARY`: The legal entity is considered a subsidiary, fully or partially held by another. * `BRANCH`: The legal entity is considered a branch, associated with a parent legal entity.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_name": { "description": "The legal name of the legal entity.", "type": "string" }, "mailing_address": { "description": "The mailing address of the legal entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "management_type": { "description": "The legal entity management type in the case of an employer of record (EOR) or professional employment organization (PEO). * `PEO`: The legal entity is considered a Professional Employment Organization (PEO). * `EOR`: The legal entity is considered an Employer of Record (EOR).", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The parent legal entity.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent legal entity.", "type": "string" }, "physical_address": { "description": "The physical address of the legal entity, if it differs from the mailing address.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "registration_date": { "description": "The registration date of the entity.", "type": "string" }, "tax_identifier": { "description": "The tax identifier for the legal entity.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "LegalEntity", "type": "object" }, "legal_entity_id": { "description": "The worker's associated legal entity.", "type": "string" }, "level": { "description": "The level of the worker.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "description": { "description": "The description of the level.", "type": "string" }, "experience_requirements": { "description": "The experience requirements for the level.", "type": "string" }, "global_level": { "anyOf": [ { "description": "Global level is used to track the seniority of levels. The higher up a level is placed on the page, the more senior and higher-ranked the level. Global level is used in workflows, policies, and reports that use the level attribute (e.g., you can use Level Lookup to set up a workflow that notifies the nearest person in an worker's management chain at or above the specified level).", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the level. Must be unique within the company or organization.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLevel", "description": "The parent level.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent level.", "type": "string" }, "rank": { "anyOf": [ { "description": "The rank of the level within its track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "scope_of_responsibilities": { "description": "The scope of responsibilities for the level.", "type": "string" }, "track": { "description": "The track associated with the level, if it's not a global level.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_default": { "description": "Whether this is the company's default track.", "type": "boolean" }, "name": { "description": "The name of the track. Must be unique within the company or organization.", "type": "string" }, "order": { "anyOf": [ { "description": "The one-based horizontal display order of the track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "start_global_level": { "anyOf": [ { "description": "The highest global level occupied by this track. Empty tracks return null.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Track", "type": "object" }, "track_id": { "description": "The track associated with the level. Required during creation. Include global_level when changing it.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Level", "type": "object" }, "level_id": { "description": "The level of the worker.", "type": "string" }, "location": { "description": "The location that the worker is mapped to for tax purposes. In the case that a worker is remote, the location's type is remote.", "properties": { "type": { "description": "The type of location.", "type": "string" }, "work_location_id": { "description": "The work location, if the worker isn't remote.", "type": "string" } }, "required": [ "type", "work_location_id" ], "title": "WorkerLocation", "type": "object" }, "manager": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's manager.\n\nExpandable field", "type": "object" }, "manager_id": { "description": "The worker's manager.", "type": "string" }, "number": { "anyOf": [ { "description": "The worker's number within the organization.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "original_start_date": { "description": "The worker's earliest start date across their employment history, excluding INIT roles.", "type": "string" }, "overtime_exemption": { "description": "The worker's overtime exemption status.", "type": "string" }, "pay_schedule_id": { "description": "The ID of the pay schedule currently associated with the worker.", "type": "string" }, "personal_email": { "description": "The worker's associated personal email address.", "type": "string" }, "race": { "description": "The identified race of the worker, if specified.", "type": "string" }, "start_date": { "description": "The start date of the worker.", "type": "string" }, "status": { "description": "The worker's status within the organization.", "type": "string" }, "teams": { "description": "The worker's assigned teams.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiTeamcb26bc28f32f" }, "type": "array" }, "teams_id": { "description": "The worker's assigned teams.", "items": { "type": "string" }, "type": "array" }, "termination_details": { "description": "The details of the worker's termination, if applicable.", "properties": { "reason": { "description": "This is a description that will be custom to each Rippling company.", "type": "string" }, "type": { "description": "The termination type indicates whether the termination was voluntary or involuntary.", "type": "string" } }, "title": "TerminationDetails", "type": "object" }, "title": { "description": "The worker's title.", "type": "string" }, "title_effective_date": { "description": "Title effective date", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "user": { "description": "The worker's associated user.\n\nExpandable field", "properties": { "active": { "description": "Whether the user is able to access company resources, typically when they are in actively engaged with the company and not after off-boarding.", "type": "boolean" }, "addresses": { "description": "The user's addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiUserAddressedd59b9ba9a1" }, "type": "array" }, "created_at": { "description": "Record creation date", "type": "string" }, "display_name": { "description": "The display name of the user using either the concatenated preferred given and family name or username depending on availability.", "type": "string" }, "emails": { "description": "The user's email addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiEmail5284c8258dc3" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "locale": { "description": "The User's default location for purposes of localization of currency, date time format, or numerical representations pursuant to RFC5646.", "type": "string" }, "name": { "description": "The user's name.", "properties": { "family_name": { "description": "The legal family name of the user, or last name in most Western languages.", "type": "string" }, "formatted": { "description": "The user's full name.", "type": "string" }, "given_name": { "description": "The given legal name of the user, or first name in most Western languages.", "type": "string" }, "middle_name": { "description": "The middle name(s) of the user.", "type": "string" }, "preferred_family_name": { "description": "The preferred family name, or last name in most Western languages, by the user.", "type": "string" }, "preferred_given_name": { "description": "The preferred given name, or first name in most Western languages, by the user.", "type": "string" } }, "title": "UserName", "type": "object" }, "number": { "description": "The permanent profile number of the user.", "type": "string" }, "phone_numbers": { "description": "The user's phone numbers.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoneNumber12060c61ecf5" }, "type": "array" }, "photos": { "description": "The user's photos.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoto2be7c3ae3f39" }, "type": "array" }, "preferred_language": { "description": "The User's preferred written or spoken language in the same format of the HTTP Accept-Language header, pursuant to Section 5.3.5 of RFC7231.", "type": "string" }, "timezone": { "description": "The User's current time zone in IANA database Olson format", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "username": { "description": "The unique identifier across Rippling used by the User for direct authentication into their associated company. Globally unique.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "User", "type": "object" }, "user_id": { "description": "The worker's associated user.", "type": "string" }, "work_email": { "description": "The worker's associated work email address.", "type": "string" }, "work_schedule": { "additionalProperties": { "$ref": "#/components/schemas/OutputRestApiWorkScheduleDay938f88d94f20" }, "description": "The worker's scheduled working hours for each day of the week.", "type": "object" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Worker", "type": "object" }, "worker_id": { "description": "Identifier of worker to whom job is assigned.", "type": "string" } }, "required": [ "created_at", "id", "job_code_id", "updated_at", "worker_id" ], "title": "JobAssignment", "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Create a new job assignment", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "job-assignments.read-write" ] } }, "/job-assignments/{id}/": { "delete": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/delete-job-assignments" }, "operationId": "rippling.rest_api.delete_job_assignments", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "id", "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "change_reason": { "description": "Reason recorded on the scheduled unassignment.", "type": "string" }, "effective_from": { "description": "Date and time the unassignment becomes effective (ISO 8601 format, e.g., 2025-11-07T17:00:00.000+00:00). When provided, schedules a future unassignment instead of deleting the job assignment immediately.", "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "204": { "description": "The resource was deleted successfully" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Delete a job assignment", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "job-assignments.read-write" ] }, "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/get-job-assignments" }, "operationId": "rippling.rest_api.get_job_assignments", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "id", "type": "string" } }, { "in": "query", "name": "expand", "required": false, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "__meta": { "properties": { "redacted_fields": { "items": { "$ref": "#/components/schemas/OutputRestApiRedactedField21788a25ef22" }, "type": "array" } }, "type": "object" }, "base_pay_rate": { "anyOf": [ { "description": "Base compensation rate of worker", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "job_code": { "description": "Job that is assigned to worker\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "custom_location": { "description": "The custom location of the job code. This location will be used for tax calculation purposes if using US Payroll when an employee is working at this job code.", "properties": { "address": { "description": "The address of the custom location.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" } }, "required": [ "address" ], "title": "CustomLocation", "type": "object" }, "department": { "description": "The department associated with the job code.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "department_hierarchy": { "description": "List of departments in the department hierarchy. Refer department_hierarchy_ids for department hierarchy order.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestDepartment" }, "type": "array" }, "department_hierarchy_id": { "description": "The identifier of departments in the department hierarchy ordered from parent department to child department.", "items": { "type": "string" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the department.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestDepartment", "description": "The parent department.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent department.", "type": "string" }, "reference_code": { "description": "Reference code of the department.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Department", "type": "object" }, "department_id": { "description": "The department associated with the job code.", "type": "string" }, "external_id": { "description": "The unique identifier of the job code in an outside system.", "type": "string" }, "group_id": { "description": "The ID of the job roster group.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_archived": { "description": "Whether this job code is archived. Set to true via PATCH to archive. Archiving is irreversible via this API.", "type": "boolean" }, "job_dimension": { "description": "The job dimension this job code belongs to.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "external_id": { "description": "The unique identifier of the job dimension in a third party system", "type": "string" }, "group_id": { "description": "The ID of the dimension roster group.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "includes_custom_location": { "description": "Whether the job dimension includes codes related to a custom location. Only one dimension can have this set to true.", "type": "boolean" }, "name": { "description": "The name of the job dimension", "type": "string" }, "org_attribute_associations": { "description": "Organizational attributes associated with the job dimension. Only 'PAY_RATE' can be set or modified using POST or PATCH requests.", "items": {}, "type": "array" }, "roster_type": { "description": "The roster type of the dimension. PER_DIMENSION means that there is a group on the dimension level and employees within that group have access to all job codes in the dimension. PER_JOB_CODE means that each job code has its own group.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "JobDimension", "type": "object" }, "job_dimension_id": { "description": "The ID of the job dimension this job code belongs to.", "type": "string" }, "name": { "description": "The name of the job dimension.", "type": "string" }, "pay_rate": { "anyOf": [ { "description": "The pay rate for this job code. Only applicable if the associated job dimension includes the 'PAY_RATE' organizational attribute.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "pay_rate_exceptions": { "description": "Pay rate overrides for the job based on exception dimension values.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiJobPayRateExceptionaf426aa0ac14" }, "type": "array" }, "pay_rate_exceptions_id": { "description": "Pay rate overrides id for the job based on exception dimension values.", "items": { "type": "string" }, "type": "array" }, "updated_at": { "description": "Record update date", "type": "string" }, "work_location": { "description": "The work location associated with the job code.\n\nExpandable field", "properties": { "address": { "description": "The address for the work location.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the work location.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "address", "created_at", "id", "name", "updated_at" ], "title": "WorkLocation", "type": "object" }, "work_location_id": { "description": "The work location associated with the job code.", "type": "string" } }, "required": [ "created_at", "id", "job_dimension_id", "name", "updated_at" ], "title": "JobCode", "type": "object" }, "job_code_id": { "description": "Identifier of job that is assigned to worker", "type": "string" }, "job_pay_rate": { "anyOf": [ { "description": "The pay rate for job assigned to worker. This can be different from the job's standard pay rate and can be overriden for a worker.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "job_pay_rate_exceptions": { "description": "Pay rate exceptions applicable for the worker based on certain exception dimension values.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiJobPayRateException2b2788a4d92c" }, "type": "array" }, "job_pay_rate_exceptions_id": { "description": "Identifier of pay rate exceptions applicable for the worker based on certain exception dimension values.", "items": { "type": "string" }, "type": "array" }, "updated_at": { "description": "Record update date", "type": "string" }, "worker": { "description": "Worker to whom job is assigned.\n\nExpandable field", "properties": { "business_partners": { "description": "Worker's assigned business partners. This field is only populated when explicitly requested via the expand parameter (e.g., ?expand=business_partners). When expanded, returns an empty list ([]) if the worker has no business partners.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiBusinessPartner77b00a069c32" }, "type": "array" }, "business_partners_id": { "description": "Worker's assigned business partners unique identifiers. Returns an empty list ([]) if the worker has no business partners.", "items": { "type": "string" }, "type": "array" }, "citizenship": { "description": "The countries that the worker has citizenship in.", "type": "string" }, "compensation": { "description": "The compensation package for the worker.\n\nExpandable field", "properties": { "annual_compensation": { "description": "The worker's annual compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "annual_salary_equivalent": { "description": "The worker's annual salary equivalent, for insurance purposes. It will be equal to the worker's annual compensation, except for owners that are receiving no cashcompensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "bonus_schedule": { "description": "The worker's bonus schedule.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "hourly_wage": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "id": { "description": "Identifier field", "type": "string" }, "monthly_compensation": { "description": "The worker's monthly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "on_target_commission": { "description": "The worker's on-target commission.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "payment_terms": { "description": "The payment terms for an worker's compensation.", "type": "string" }, "payment_type": { "description": "The payment type for an worker's compensation.", "type": "string" }, "relocation_reimbursement": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "salary_effective_date": { "description": "Salary effective date", "type": "string" }, "signing_bonus": { "description": "The worker's signing bonus.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus": { "description": "The worker's target annual bonus amount.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus_percent": { "anyOf": [ { "description": "The worker's target annual bonus as a percent of annual compensation.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" }, "weekly_compensation": { "description": "The worker's weekly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "worker": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's details.\n\nExpandable field", "type": "object" }, "worker_id": { "description": "The worker's ID.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Compensation", "type": "object" }, "compensation_grade": { "description": "The compensation grade assigned to the worker, if any.", "properties": { "id": { "description": "The compensation grade's unique identifier.", "type": "string" }, "label": { "description": "The compensation grade's label.", "type": "string" } }, "title": "WorkerCompensationGrade", "type": "object" }, "compensation_id": { "description": "The compensation package for the worker.", "type": "string" }, "country": { "description": "The worker's country.", "type": "string" }, "country_fields": { "description": "Country level fields for the worker.", "properties": { "ca": { "description": "Country-wise regional fields for Canada", "properties": { "sin": { "description": "Social Insurance Number (SIN) for Canada employees.", "type": "string" } }, "title": "CanadaFields", "type": "object" }, "nz": { "description": "Country-wise regional fields for New Zealand", "properties": { "ird_number": { "description": "Inland Revenue Department (IRD) number for New Zealand employees.", "type": "string" } }, "title": "NewZealandFields", "type": "object" }, "us": { "description": "Country-wise regional fields for USA", "properties": { "ssn": { "description": "Social Security Number (SSN) for US employees.", "type": "string" } }, "title": "USFields", "type": "object" } }, "title": "CountryFields", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "custom_fields": { "description": "Custom field values defined on the Employee object for this worker\n\nExpandable field", "items": { "additionalProperties": {} }, "type": "array" }, "date_of_birth": { "description": "The worker's date of birth.", "type": "string" }, "department": { "description": "The worker's assigned department.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "department_hierarchy": { "description": "List of departments in the department hierarchy. Refer department_hierarchy_ids for department hierarchy order.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestDepartment" }, "type": "array" }, "department_hierarchy_id": { "description": "The identifier of departments in the department hierarchy ordered from parent department to child department.", "items": { "type": "string" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the department.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestDepartment", "description": "The parent department.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent department.", "type": "string" }, "reference_code": { "description": "Reference code of the department.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Department", "type": "object" }, "department_id": { "description": "The worker's assigned department.", "type": "string" }, "employment_type": { "description": "The worker's employment type.\n\nExpandable field", "properties": { "amount_worked": { "description": "The amount worked for the employment type. * `FULL-TIME`: Full-time is at least 30 hours per week. Full-time workers will typically be eligible for benefits. * `PART-TIME`: Part-time is less than 30 hours per week. These workers may be eligible for benefits, depending on company settings and hours worked. * `TEMPORARY`: These workers are hired on a temporary basis. You can specify how each worker with this employment type will be paid individually.", "type": "string" }, "compensation_time_period": { "description": "The compensation period for the employment type. * `SALARIED`: Employees that are paid a fixed amount per year. * `HOURLY`: Employees that are paid a wage per hour worked.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "label": { "description": "The display label of the employment type.", "type": "string" }, "name": { "description": "The name of the employment type for non-custom employment types.", "type": "string" }, "type": { "description": "The classification of the worker by the company. * `CONTRACTOR`: Contractors are self-employed workers who provide services on a short-term or per-project basis and are not eligible for tax-withholding or benefits. * `EMPLOYEE`: Employees are hired and managed by an employer, work under the employer's direct supervision and control, and are protected by law for wages and employment rights.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "label", "updated_at" ], "title": "CompanyEmploymentType", "type": "object" }, "employment_type_id": { "description": "The worker's employment type.", "type": "string" }, "end_date": { "description": "The end date of the worker.", "type": "string" }, "ethnicity": { "description": "The identified ethnicity of the worker, if specified.", "type": "string" }, "gender": { "description": "The gender of the worker, if specified.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_manager": { "description": "Whether the worker is a manager", "type": "boolean" }, "job_function": { "description": "The worker's job function. When expanded, this field requires `job-functions.read`.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "Displayed name of the job function", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "JobFunction", "type": "object" }, "job_function_id": { "description": "ID of the worker's job function.", "type": "string" }, "legal_entity": { "description": "The worker's associated legal entity.\n\nExpandable field", "properties": { "company": { "description": "The company or organization associated with the legal entity\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "doing_business_as_name": { "description": "The doing business as name for the company.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_entities": { "description": "A list of the company's entities.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestLegalEntity" }, "type": "array" }, "legal_entities_id": { "description": "A list of the company's entities.", "items": { "type": "string" }, "type": "array" }, "legal_name": { "description": "The legal name of the company.", "type": "string" }, "name": { "description": "The name of the company.", "type": "string" }, "parent_legal_entity": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The company's ultimate holding entity.\n\nExpandable field", "type": "object" }, "parent_legal_entity_id": { "description": "The company's ultimate holding entity.", "type": "string" }, "phone": { "description": "The phone number for the company.", "type": "string" }, "physical_address": { "description": "The physical address of the holding entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "primary_email": { "description": "The email address used when registering this company.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "legal_entities", "legal_entities_id", "name", "updated_at" ], "title": "Company", "type": "object" }, "company_id": { "description": "The company or organization associated with the legal entity", "type": "string" }, "country": { "description": "The country the legal entity is based in.", "properties": { "code": { "description": "The code of the country.", "type": "string" } }, "required": [ "code" ], "title": "Country", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "entity_level": { "description": "The legal entity's level in a hierarchy. * `PARENT`: The legal entity is considered the ultimate holding entity. * `SUBSIDIARY`: The legal entity is considered a subsidiary, fully or partially held by another. * `BRANCH`: The legal entity is considered a branch, associated with a parent legal entity.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_name": { "description": "The legal name of the legal entity.", "type": "string" }, "mailing_address": { "description": "The mailing address of the legal entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "management_type": { "description": "The legal entity management type in the case of an employer of record (EOR) or professional employment organization (PEO). * `PEO`: The legal entity is considered a Professional Employment Organization (PEO). * `EOR`: The legal entity is considered an Employer of Record (EOR).", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The parent legal entity.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent legal entity.", "type": "string" }, "physical_address": { "description": "The physical address of the legal entity, if it differs from the mailing address.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "registration_date": { "description": "The registration date of the entity.", "type": "string" }, "tax_identifier": { "description": "The tax identifier for the legal entity.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "LegalEntity", "type": "object" }, "legal_entity_id": { "description": "The worker's associated legal entity.", "type": "string" }, "level": { "description": "The level of the worker.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "description": { "description": "The description of the level.", "type": "string" }, "experience_requirements": { "description": "The experience requirements for the level.", "type": "string" }, "global_level": { "anyOf": [ { "description": "Global level is used to track the seniority of levels. The higher up a level is placed on the page, the more senior and higher-ranked the level. Global level is used in workflows, policies, and reports that use the level attribute (e.g., you can use Level Lookup to set up a workflow that notifies the nearest person in an worker's management chain at or above the specified level).", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the level. Must be unique within the company or organization.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLevel", "description": "The parent level.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent level.", "type": "string" }, "rank": { "anyOf": [ { "description": "The rank of the level within its track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "scope_of_responsibilities": { "description": "The scope of responsibilities for the level.", "type": "string" }, "track": { "description": "The track associated with the level, if it's not a global level.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_default": { "description": "Whether this is the company's default track.", "type": "boolean" }, "name": { "description": "The name of the track. Must be unique within the company or organization.", "type": "string" }, "order": { "anyOf": [ { "description": "The one-based horizontal display order of the track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "start_global_level": { "anyOf": [ { "description": "The highest global level occupied by this track. Empty tracks return null.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Track", "type": "object" }, "track_id": { "description": "The track associated with the level. Required during creation. Include global_level when changing it.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Level", "type": "object" }, "level_id": { "description": "The level of the worker.", "type": "string" }, "location": { "description": "The location that the worker is mapped to for tax purposes. In the case that a worker is remote, the location's type is remote.", "properties": { "type": { "description": "The type of location.", "type": "string" }, "work_location_id": { "description": "The work location, if the worker isn't remote.", "type": "string" } }, "required": [ "type", "work_location_id" ], "title": "WorkerLocation", "type": "object" }, "manager": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's manager.\n\nExpandable field", "type": "object" }, "manager_id": { "description": "The worker's manager.", "type": "string" }, "number": { "anyOf": [ { "description": "The worker's number within the organization.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "original_start_date": { "description": "The worker's earliest start date across their employment history, excluding INIT roles.", "type": "string" }, "overtime_exemption": { "description": "The worker's overtime exemption status.", "type": "string" }, "pay_schedule_id": { "description": "The ID of the pay schedule currently associated with the worker.", "type": "string" }, "personal_email": { "description": "The worker's associated personal email address.", "type": "string" }, "race": { "description": "The identified race of the worker, if specified.", "type": "string" }, "start_date": { "description": "The start date of the worker.", "type": "string" }, "status": { "description": "The worker's status within the organization.", "type": "string" }, "teams": { "description": "The worker's assigned teams.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiTeamcb26bc28f32f" }, "type": "array" }, "teams_id": { "description": "The worker's assigned teams.", "items": { "type": "string" }, "type": "array" }, "termination_details": { "description": "The details of the worker's termination, if applicable.", "properties": { "reason": { "description": "This is a description that will be custom to each Rippling company.", "type": "string" }, "type": { "description": "The termination type indicates whether the termination was voluntary or involuntary.", "type": "string" } }, "title": "TerminationDetails", "type": "object" }, "title": { "description": "The worker's title.", "type": "string" }, "title_effective_date": { "description": "Title effective date", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "user": { "description": "The worker's associated user.\n\nExpandable field", "properties": { "active": { "description": "Whether the user is able to access company resources, typically when they are in actively engaged with the company and not after off-boarding.", "type": "boolean" }, "addresses": { "description": "The user's addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiUserAddressedd59b9ba9a1" }, "type": "array" }, "created_at": { "description": "Record creation date", "type": "string" }, "display_name": { "description": "The display name of the user using either the concatenated preferred given and family name or username depending on availability.", "type": "string" }, "emails": { "description": "The user's email addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiEmail5284c8258dc3" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "locale": { "description": "The User's default location for purposes of localization of currency, date time format, or numerical representations pursuant to RFC5646.", "type": "string" }, "name": { "description": "The user's name.", "properties": { "family_name": { "description": "The legal family name of the user, or last name in most Western languages.", "type": "string" }, "formatted": { "description": "The user's full name.", "type": "string" }, "given_name": { "description": "The given legal name of the user, or first name in most Western languages.", "type": "string" }, "middle_name": { "description": "The middle name(s) of the user.", "type": "string" }, "preferred_family_name": { "description": "The preferred family name, or last name in most Western languages, by the user.", "type": "string" }, "preferred_given_name": { "description": "The preferred given name, or first name in most Western languages, by the user.", "type": "string" } }, "title": "UserName", "type": "object" }, "number": { "description": "The permanent profile number of the user.", "type": "string" }, "phone_numbers": { "description": "The user's phone numbers.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoneNumber12060c61ecf5" }, "type": "array" }, "photos": { "description": "The user's photos.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoto2be7c3ae3f39" }, "type": "array" }, "preferred_language": { "description": "The User's preferred written or spoken language in the same format of the HTTP Accept-Language header, pursuant to Section 5.3.5 of RFC7231.", "type": "string" }, "timezone": { "description": "The User's current time zone in IANA database Olson format", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "username": { "description": "The unique identifier across Rippling used by the User for direct authentication into their associated company. Globally unique.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "User", "type": "object" }, "user_id": { "description": "The worker's associated user.", "type": "string" }, "work_email": { "description": "The worker's associated work email address.", "type": "string" }, "work_schedule": { "additionalProperties": { "$ref": "#/components/schemas/OutputRestApiWorkScheduleDay938f88d94f20" }, "description": "The worker's scheduled working hours for each day of the week.", "type": "object" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Worker", "type": "object" }, "worker_id": { "description": "Identifier of worker to whom job is assigned.", "type": "string" } }, "required": [ "created_at", "id", "job_code_id", "updated_at", "worker_id" ], "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Retrieve a specific job assignment", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "job-assignments.read" ] }, "patch": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/update-job-assignments" }, "operationId": "rippling.rest_api.update_job_assignments", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "id", "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiJobAssignmentUpdateRequest0239da31ea4b" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "base_pay_rate": { "anyOf": [ { "description": "Base compensation rate of worker", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "job_code": { "description": "Job that is assigned to worker\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "custom_location": { "description": "The custom location of the job code. This location will be used for tax calculation purposes if using US Payroll when an employee is working at this job code.", "properties": { "address": { "description": "The address of the custom location.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" } }, "required": [ "address" ], "title": "CustomLocation", "type": "object" }, "department": { "description": "The department associated with the job code.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "department_hierarchy": { "description": "List of departments in the department hierarchy. Refer department_hierarchy_ids for department hierarchy order.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestDepartment" }, "type": "array" }, "department_hierarchy_id": { "description": "The identifier of departments in the department hierarchy ordered from parent department to child department.", "items": { "type": "string" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the department.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestDepartment", "description": "The parent department.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent department.", "type": "string" }, "reference_code": { "description": "Reference code of the department.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Department", "type": "object" }, "department_id": { "description": "The department associated with the job code.", "type": "string" }, "external_id": { "description": "The unique identifier of the job code in an outside system.", "type": "string" }, "group_id": { "description": "The ID of the job roster group.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_archived": { "description": "Whether this job code is archived. Set to true via PATCH to archive. Archiving is irreversible via this API.", "type": "boolean" }, "job_dimension": { "description": "The job dimension this job code belongs to.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "external_id": { "description": "The unique identifier of the job dimension in a third party system", "type": "string" }, "group_id": { "description": "The ID of the dimension roster group.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "includes_custom_location": { "description": "Whether the job dimension includes codes related to a custom location. Only one dimension can have this set to true.", "type": "boolean" }, "name": { "description": "The name of the job dimension", "type": "string" }, "org_attribute_associations": { "description": "Organizational attributes associated with the job dimension. Only 'PAY_RATE' can be set or modified using POST or PATCH requests.", "items": {}, "type": "array" }, "roster_type": { "description": "The roster type of the dimension. PER_DIMENSION means that there is a group on the dimension level and employees within that group have access to all job codes in the dimension. PER_JOB_CODE means that each job code has its own group.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "JobDimension", "type": "object" }, "job_dimension_id": { "description": "The ID of the job dimension this job code belongs to.", "type": "string" }, "name": { "description": "The name of the job dimension.", "type": "string" }, "pay_rate": { "anyOf": [ { "description": "The pay rate for this job code. Only applicable if the associated job dimension includes the 'PAY_RATE' organizational attribute.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "pay_rate_exceptions": { "description": "Pay rate overrides for the job based on exception dimension values.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiJobPayRateExceptionaf426aa0ac14" }, "type": "array" }, "pay_rate_exceptions_id": { "description": "Pay rate overrides id for the job based on exception dimension values.", "items": { "type": "string" }, "type": "array" }, "updated_at": { "description": "Record update date", "type": "string" }, "work_location": { "description": "The work location associated with the job code.\n\nExpandable field", "properties": { "address": { "description": "The address for the work location.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the work location.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "address", "created_at", "id", "name", "updated_at" ], "title": "WorkLocation", "type": "object" }, "work_location_id": { "description": "The work location associated with the job code.", "type": "string" } }, "required": [ "created_at", "id", "job_dimension_id", "name", "updated_at" ], "title": "JobCode", "type": "object" }, "job_code_id": { "description": "Identifier of job that is assigned to worker", "type": "string" }, "job_pay_rate": { "anyOf": [ { "description": "The pay rate for job assigned to worker. This can be different from the job's standard pay rate and can be overriden for a worker.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "job_pay_rate_exceptions": { "description": "Pay rate exceptions applicable for the worker based on certain exception dimension values.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiJobPayRateException2b2788a4d92c" }, "type": "array" }, "job_pay_rate_exceptions_id": { "description": "Identifier of pay rate exceptions applicable for the worker based on certain exception dimension values.", "items": { "type": "string" }, "type": "array" }, "updated_at": { "description": "Record update date", "type": "string" }, "worker": { "description": "Worker to whom job is assigned.\n\nExpandable field", "properties": { "business_partners": { "description": "Worker's assigned business partners. This field is only populated when explicitly requested via the expand parameter (e.g., ?expand=business_partners). When expanded, returns an empty list ([]) if the worker has no business partners.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiBusinessPartner77b00a069c32" }, "type": "array" }, "business_partners_id": { "description": "Worker's assigned business partners unique identifiers. Returns an empty list ([]) if the worker has no business partners.", "items": { "type": "string" }, "type": "array" }, "citizenship": { "description": "The countries that the worker has citizenship in.", "type": "string" }, "compensation": { "description": "The compensation package for the worker.\n\nExpandable field", "properties": { "annual_compensation": { "description": "The worker's annual compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "annual_salary_equivalent": { "description": "The worker's annual salary equivalent, for insurance purposes. It will be equal to the worker's annual compensation, except for owners that are receiving no cashcompensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "bonus_schedule": { "description": "The worker's bonus schedule.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "hourly_wage": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "id": { "description": "Identifier field", "type": "string" }, "monthly_compensation": { "description": "The worker's monthly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "on_target_commission": { "description": "The worker's on-target commission.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "payment_terms": { "description": "The payment terms for an worker's compensation.", "type": "string" }, "payment_type": { "description": "The payment type for an worker's compensation.", "type": "string" }, "relocation_reimbursement": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "salary_effective_date": { "description": "Salary effective date", "type": "string" }, "signing_bonus": { "description": "The worker's signing bonus.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus": { "description": "The worker's target annual bonus amount.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus_percent": { "anyOf": [ { "description": "The worker's target annual bonus as a percent of annual compensation.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" }, "weekly_compensation": { "description": "The worker's weekly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "worker": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's details.\n\nExpandable field", "type": "object" }, "worker_id": { "description": "The worker's ID.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Compensation", "type": "object" }, "compensation_grade": { "description": "The compensation grade assigned to the worker, if any.", "properties": { "id": { "description": "The compensation grade's unique identifier.", "type": "string" }, "label": { "description": "The compensation grade's label.", "type": "string" } }, "title": "WorkerCompensationGrade", "type": "object" }, "compensation_id": { "description": "The compensation package for the worker.", "type": "string" }, "country": { "description": "The worker's country.", "type": "string" }, "country_fields": { "description": "Country level fields for the worker.", "properties": { "ca": { "description": "Country-wise regional fields for Canada", "properties": { "sin": { "description": "Social Insurance Number (SIN) for Canada employees.", "type": "string" } }, "title": "CanadaFields", "type": "object" }, "nz": { "description": "Country-wise regional fields for New Zealand", "properties": { "ird_number": { "description": "Inland Revenue Department (IRD) number for New Zealand employees.", "type": "string" } }, "title": "NewZealandFields", "type": "object" }, "us": { "description": "Country-wise regional fields for USA", "properties": { "ssn": { "description": "Social Security Number (SSN) for US employees.", "type": "string" } }, "title": "USFields", "type": "object" } }, "title": "CountryFields", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "custom_fields": { "description": "Custom field values defined on the Employee object for this worker\n\nExpandable field", "items": { "additionalProperties": {} }, "type": "array" }, "date_of_birth": { "description": "The worker's date of birth.", "type": "string" }, "department": { "description": "The worker's assigned department.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "department_hierarchy": { "description": "List of departments in the department hierarchy. Refer department_hierarchy_ids for department hierarchy order.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestDepartment" }, "type": "array" }, "department_hierarchy_id": { "description": "The identifier of departments in the department hierarchy ordered from parent department to child department.", "items": { "type": "string" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the department.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestDepartment", "description": "The parent department.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent department.", "type": "string" }, "reference_code": { "description": "Reference code of the department.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Department", "type": "object" }, "department_id": { "description": "The worker's assigned department.", "type": "string" }, "employment_type": { "description": "The worker's employment type.\n\nExpandable field", "properties": { "amount_worked": { "description": "The amount worked for the employment type. * `FULL-TIME`: Full-time is at least 30 hours per week. Full-time workers will typically be eligible for benefits. * `PART-TIME`: Part-time is less than 30 hours per week. These workers may be eligible for benefits, depending on company settings and hours worked. * `TEMPORARY`: These workers are hired on a temporary basis. You can specify how each worker with this employment type will be paid individually.", "type": "string" }, "compensation_time_period": { "description": "The compensation period for the employment type. * `SALARIED`: Employees that are paid a fixed amount per year. * `HOURLY`: Employees that are paid a wage per hour worked.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "label": { "description": "The display label of the employment type.", "type": "string" }, "name": { "description": "The name of the employment type for non-custom employment types.", "type": "string" }, "type": { "description": "The classification of the worker by the company. * `CONTRACTOR`: Contractors are self-employed workers who provide services on a short-term or per-project basis and are not eligible for tax-withholding or benefits. * `EMPLOYEE`: Employees are hired and managed by an employer, work under the employer's direct supervision and control, and are protected by law for wages and employment rights.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "label", "updated_at" ], "title": "CompanyEmploymentType", "type": "object" }, "employment_type_id": { "description": "The worker's employment type.", "type": "string" }, "end_date": { "description": "The end date of the worker.", "type": "string" }, "ethnicity": { "description": "The identified ethnicity of the worker, if specified.", "type": "string" }, "gender": { "description": "The gender of the worker, if specified.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_manager": { "description": "Whether the worker is a manager", "type": "boolean" }, "job_function": { "description": "The worker's job function. When expanded, this field requires `job-functions.read`.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "Displayed name of the job function", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "JobFunction", "type": "object" }, "job_function_id": { "description": "ID of the worker's job function.", "type": "string" }, "legal_entity": { "description": "The worker's associated legal entity.\n\nExpandable field", "properties": { "company": { "description": "The company or organization associated with the legal entity\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "doing_business_as_name": { "description": "The doing business as name for the company.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_entities": { "description": "A list of the company's entities.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestLegalEntity" }, "type": "array" }, "legal_entities_id": { "description": "A list of the company's entities.", "items": { "type": "string" }, "type": "array" }, "legal_name": { "description": "The legal name of the company.", "type": "string" }, "name": { "description": "The name of the company.", "type": "string" }, "parent_legal_entity": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The company's ultimate holding entity.\n\nExpandable field", "type": "object" }, "parent_legal_entity_id": { "description": "The company's ultimate holding entity.", "type": "string" }, "phone": { "description": "The phone number for the company.", "type": "string" }, "physical_address": { "description": "The physical address of the holding entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "primary_email": { "description": "The email address used when registering this company.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "legal_entities", "legal_entities_id", "name", "updated_at" ], "title": "Company", "type": "object" }, "company_id": { "description": "The company or organization associated with the legal entity", "type": "string" }, "country": { "description": "The country the legal entity is based in.", "properties": { "code": { "description": "The code of the country.", "type": "string" } }, "required": [ "code" ], "title": "Country", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "entity_level": { "description": "The legal entity's level in a hierarchy. * `PARENT`: The legal entity is considered the ultimate holding entity. * `SUBSIDIARY`: The legal entity is considered a subsidiary, fully or partially held by another. * `BRANCH`: The legal entity is considered a branch, associated with a parent legal entity.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_name": { "description": "The legal name of the legal entity.", "type": "string" }, "mailing_address": { "description": "The mailing address of the legal entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "management_type": { "description": "The legal entity management type in the case of an employer of record (EOR) or professional employment organization (PEO). * `PEO`: The legal entity is considered a Professional Employment Organization (PEO). * `EOR`: The legal entity is considered an Employer of Record (EOR).", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The parent legal entity.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent legal entity.", "type": "string" }, "physical_address": { "description": "The physical address of the legal entity, if it differs from the mailing address.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "registration_date": { "description": "The registration date of the entity.", "type": "string" }, "tax_identifier": { "description": "The tax identifier for the legal entity.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "LegalEntity", "type": "object" }, "legal_entity_id": { "description": "The worker's associated legal entity.", "type": "string" }, "level": { "description": "The level of the worker.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "description": { "description": "The description of the level.", "type": "string" }, "experience_requirements": { "description": "The experience requirements for the level.", "type": "string" }, "global_level": { "anyOf": [ { "description": "Global level is used to track the seniority of levels. The higher up a level is placed on the page, the more senior and higher-ranked the level. Global level is used in workflows, policies, and reports that use the level attribute (e.g., you can use Level Lookup to set up a workflow that notifies the nearest person in an worker's management chain at or above the specified level).", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the level. Must be unique within the company or organization.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLevel", "description": "The parent level.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent level.", "type": "string" }, "rank": { "anyOf": [ { "description": "The rank of the level within its track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "scope_of_responsibilities": { "description": "The scope of responsibilities for the level.", "type": "string" }, "track": { "description": "The track associated with the level, if it's not a global level.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_default": { "description": "Whether this is the company's default track.", "type": "boolean" }, "name": { "description": "The name of the track. Must be unique within the company or organization.", "type": "string" }, "order": { "anyOf": [ { "description": "The one-based horizontal display order of the track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "start_global_level": { "anyOf": [ { "description": "The highest global level occupied by this track. Empty tracks return null.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Track", "type": "object" }, "track_id": { "description": "The track associated with the level. Required during creation. Include global_level when changing it.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Level", "type": "object" }, "level_id": { "description": "The level of the worker.", "type": "string" }, "location": { "description": "The location that the worker is mapped to for tax purposes. In the case that a worker is remote, the location's type is remote.", "properties": { "type": { "description": "The type of location.", "type": "string" }, "work_location_id": { "description": "The work location, if the worker isn't remote.", "type": "string" } }, "required": [ "type", "work_location_id" ], "title": "WorkerLocation", "type": "object" }, "manager": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's manager.\n\nExpandable field", "type": "object" }, "manager_id": { "description": "The worker's manager.", "type": "string" }, "number": { "anyOf": [ { "description": "The worker's number within the organization.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "original_start_date": { "description": "The worker's earliest start date across their employment history, excluding INIT roles.", "type": "string" }, "overtime_exemption": { "description": "The worker's overtime exemption status.", "type": "string" }, "pay_schedule_id": { "description": "The ID of the pay schedule currently associated with the worker.", "type": "string" }, "personal_email": { "description": "The worker's associated personal email address.", "type": "string" }, "race": { "description": "The identified race of the worker, if specified.", "type": "string" }, "start_date": { "description": "The start date of the worker.", "type": "string" }, "status": { "description": "The worker's status within the organization.", "type": "string" }, "teams": { "description": "The worker's assigned teams.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiTeamcb26bc28f32f" }, "type": "array" }, "teams_id": { "description": "The worker's assigned teams.", "items": { "type": "string" }, "type": "array" }, "termination_details": { "description": "The details of the worker's termination, if applicable.", "properties": { "reason": { "description": "This is a description that will be custom to each Rippling company.", "type": "string" }, "type": { "description": "The termination type indicates whether the termination was voluntary or involuntary.", "type": "string" } }, "title": "TerminationDetails", "type": "object" }, "title": { "description": "The worker's title.", "type": "string" }, "title_effective_date": { "description": "Title effective date", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "user": { "description": "The worker's associated user.\n\nExpandable field", "properties": { "active": { "description": "Whether the user is able to access company resources, typically when they are in actively engaged with the company and not after off-boarding.", "type": "boolean" }, "addresses": { "description": "The user's addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiUserAddressedd59b9ba9a1" }, "type": "array" }, "created_at": { "description": "Record creation date", "type": "string" }, "display_name": { "description": "The display name of the user using either the concatenated preferred given and family name or username depending on availability.", "type": "string" }, "emails": { "description": "The user's email addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiEmail5284c8258dc3" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "locale": { "description": "The User's default location for purposes of localization of currency, date time format, or numerical representations pursuant to RFC5646.", "type": "string" }, "name": { "description": "The user's name.", "properties": { "family_name": { "description": "The legal family name of the user, or last name in most Western languages.", "type": "string" }, "formatted": { "description": "The user's full name.", "type": "string" }, "given_name": { "description": "The given legal name of the user, or first name in most Western languages.", "type": "string" }, "middle_name": { "description": "The middle name(s) of the user.", "type": "string" }, "preferred_family_name": { "description": "The preferred family name, or last name in most Western languages, by the user.", "type": "string" }, "preferred_given_name": { "description": "The preferred given name, or first name in most Western languages, by the user.", "type": "string" } }, "title": "UserName", "type": "object" }, "number": { "description": "The permanent profile number of the user.", "type": "string" }, "phone_numbers": { "description": "The user's phone numbers.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoneNumber12060c61ecf5" }, "type": "array" }, "photos": { "description": "The user's photos.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoto2be7c3ae3f39" }, "type": "array" }, "preferred_language": { "description": "The User's preferred written or spoken language in the same format of the HTTP Accept-Language header, pursuant to Section 5.3.5 of RFC7231.", "type": "string" }, "timezone": { "description": "The User's current time zone in IANA database Olson format", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "username": { "description": "The unique identifier across Rippling used by the User for direct authentication into their associated company. Globally unique.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "User", "type": "object" }, "user_id": { "description": "The worker's associated user.", "type": "string" }, "work_email": { "description": "The worker's associated work email address.", "type": "string" }, "work_schedule": { "additionalProperties": { "$ref": "#/components/schemas/OutputRestApiWorkScheduleDay938f88d94f20" }, "description": "The worker's scheduled working hours for each day of the week.", "type": "object" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Worker", "type": "object" }, "worker_id": { "description": "Identifier of worker to whom job is assigned.", "type": "string" } }, "required": [ "created_at", "id", "job_code_id", "updated_at", "worker_id" ], "title": "JobAssignment", "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Update a job assignment", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "job-assignments.read-write" ] } }, "/job-assignments/{job_assignment_id}/change-log/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/list-job-assignments-job-assignment-id-change-log" }, "operationId": "rippling.rest_api.list_job_assignments_job_assignment_id_change_log", "parameters": [ { "in": "path", "name": "job_assignment_id", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "expand", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 100, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "__meta": { "$ref": "#/components/schemas/OutputRestApiRedactedFields9f7657dc2a2f" }, "next_link": { "description": "A link to the next page of responses.", "format": "uri", "type": "string" }, "results": { "items": { "$ref": "#/components/schemas/OutputRestApiAttributeChangeDetails97f04b441f25" }, "type": "array" } }, "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "List attribute change logs", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "job-assignments.read" ] } }, "/job-codes/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/list-job-codes" }, "operationId": "rippling.rest_api.list_job_codes", "parameters": [ { "in": "query", "name": "filter", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "expand", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 100, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "__meta": { "$ref": "#/components/schemas/OutputRestApiRedactedFields9f7657dc2a2f" }, "next_link": { "description": "A link to the next page of responses.", "format": "uri", "type": "string" }, "results": { "items": { "$ref": "#/components/schemas/OutputRestApiJobCodeeda25ec6c9a8" }, "type": "array" } }, "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "List job codes", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "job-codes.read" ] }, "post": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/create-job-codes" }, "operationId": "rippling.rest_api.create_job_codes", "parameters": [ { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiJobCodeRequest773211238d35" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "custom_location": { "description": "The custom location of the job code. This location will be used for tax calculation purposes if using US Payroll when an employee is working at this job code.", "properties": { "address": { "description": "The address of the custom location.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" } }, "required": [ "address" ], "title": "CustomLocation", "type": "object" }, "department": { "description": "The department associated with the job code.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "department_hierarchy": { "description": "List of departments in the department hierarchy. Refer department_hierarchy_ids for department hierarchy order.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestDepartment" }, "type": "array" }, "department_hierarchy_id": { "description": "The identifier of departments in the department hierarchy ordered from parent department to child department.", "items": { "type": "string" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the department.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestDepartment", "description": "The parent department.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent department.", "type": "string" }, "reference_code": { "description": "Reference code of the department.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Department", "type": "object" }, "department_id": { "description": "The department associated with the job code.", "type": "string" }, "external_id": { "description": "The unique identifier of the job code in an outside system.", "type": "string" }, "group_id": { "description": "The ID of the job roster group.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_archived": { "description": "Whether this job code is archived. Set to true via PATCH to archive. Archiving is irreversible via this API.", "type": "boolean" }, "job_dimension": { "description": "The job dimension this job code belongs to.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "external_id": { "description": "The unique identifier of the job dimension in a third party system", "type": "string" }, "group_id": { "description": "The ID of the dimension roster group.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "includes_custom_location": { "description": "Whether the job dimension includes codes related to a custom location. Only one dimension can have this set to true.", "type": "boolean" }, "name": { "description": "The name of the job dimension", "type": "string" }, "org_attribute_associations": { "description": "Organizational attributes associated with the job dimension. Only 'PAY_RATE' can be set or modified using POST or PATCH requests.", "items": {}, "type": "array" }, "roster_type": { "description": "The roster type of the dimension. PER_DIMENSION means that there is a group on the dimension level and employees within that group have access to all job codes in the dimension. PER_JOB_CODE means that each job code has its own group.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "JobDimension", "type": "object" }, "job_dimension_id": { "description": "The ID of the job dimension this job code belongs to.", "type": "string" }, "name": { "description": "The name of the job dimension.", "type": "string" }, "pay_rate": { "anyOf": [ { "description": "The pay rate for this job code. Only applicable if the associated job dimension includes the 'PAY_RATE' organizational attribute.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "pay_rate_exceptions": { "description": "Pay rate overrides for the job based on exception dimension values.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiJobPayRateExceptionaf426aa0ac14" }, "type": "array" }, "pay_rate_exceptions_id": { "description": "Pay rate overrides id for the job based on exception dimension values.", "items": { "type": "string" }, "type": "array" }, "updated_at": { "description": "Record update date", "type": "string" }, "work_location": { "description": "The work location associated with the job code.\n\nExpandable field", "properties": { "address": { "description": "The address for the work location.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the work location.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "address", "created_at", "id", "name", "updated_at" ], "title": "WorkLocation", "type": "object" }, "work_location_id": { "description": "The work location associated with the job code.", "type": "string" } }, "required": [ "created_at", "id", "job_dimension_id", "name", "updated_at" ], "title": "JobCode", "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Create a new job code", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "job-codes.read-write" ] } }, "/job-codes/{id}/": { "delete": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/delete-job-codes" }, "operationId": "rippling.rest_api.delete_job_codes", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "id", "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "204": { "description": "The resource was deleted successfully" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Delete a job code", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "job-codes.read-write" ] }, "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/get-job-codes" }, "operationId": "rippling.rest_api.get_job_codes", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "id", "type": "string" } }, { "in": "query", "name": "expand", "required": false, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "__meta": { "properties": { "redacted_fields": { "items": { "$ref": "#/components/schemas/OutputRestApiRedactedField21788a25ef22" }, "type": "array" } }, "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "custom_location": { "description": "The custom location of the job code. This location will be used for tax calculation purposes if using US Payroll when an employee is working at this job code.", "properties": { "address": { "description": "The address of the custom location.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" } }, "required": [ "address" ], "title": "CustomLocation", "type": "object" }, "department": { "description": "The department associated with the job code.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "department_hierarchy": { "description": "List of departments in the department hierarchy. Refer department_hierarchy_ids for department hierarchy order.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestDepartment" }, "type": "array" }, "department_hierarchy_id": { "description": "The identifier of departments in the department hierarchy ordered from parent department to child department.", "items": { "type": "string" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the department.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestDepartment", "description": "The parent department.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent department.", "type": "string" }, "reference_code": { "description": "Reference code of the department.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Department", "type": "object" }, "department_id": { "description": "The department associated with the job code.", "type": "string" }, "external_id": { "description": "The unique identifier of the job code in an outside system.", "type": "string" }, "group_id": { "description": "The ID of the job roster group.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_archived": { "description": "Whether this job code is archived. Set to true via PATCH to archive. Archiving is irreversible via this API.", "type": "boolean" }, "job_dimension": { "description": "The job dimension this job code belongs to.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "external_id": { "description": "The unique identifier of the job dimension in a third party system", "type": "string" }, "group_id": { "description": "The ID of the dimension roster group.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "includes_custom_location": { "description": "Whether the job dimension includes codes related to a custom location. Only one dimension can have this set to true.", "type": "boolean" }, "name": { "description": "The name of the job dimension", "type": "string" }, "org_attribute_associations": { "description": "Organizational attributes associated with the job dimension. Only 'PAY_RATE' can be set or modified using POST or PATCH requests.", "items": {}, "type": "array" }, "roster_type": { "description": "The roster type of the dimension. PER_DIMENSION means that there is a group on the dimension level and employees within that group have access to all job codes in the dimension. PER_JOB_CODE means that each job code has its own group.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "JobDimension", "type": "object" }, "job_dimension_id": { "description": "The ID of the job dimension this job code belongs to.", "type": "string" }, "name": { "description": "The name of the job dimension.", "type": "string" }, "pay_rate": { "anyOf": [ { "description": "The pay rate for this job code. Only applicable if the associated job dimension includes the 'PAY_RATE' organizational attribute.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "pay_rate_exceptions": { "description": "Pay rate overrides for the job based on exception dimension values.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiJobPayRateExceptionaf426aa0ac14" }, "type": "array" }, "pay_rate_exceptions_id": { "description": "Pay rate overrides id for the job based on exception dimension values.", "items": { "type": "string" }, "type": "array" }, "updated_at": { "description": "Record update date", "type": "string" }, "work_location": { "description": "The work location associated with the job code.\n\nExpandable field", "properties": { "address": { "description": "The address for the work location.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the work location.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "address", "created_at", "id", "name", "updated_at" ], "title": "WorkLocation", "type": "object" }, "work_location_id": { "description": "The work location associated with the job code.", "type": "string" } }, "required": [ "created_at", "id", "job_dimension_id", "name", "updated_at" ], "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Retrieve a specific job code", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "job-codes.read" ] }, "patch": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/update-job-codes" }, "operationId": "rippling.rest_api.update_job_codes", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "id", "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiJobCodeUpdateRequest71bb1a016083" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "custom_location": { "description": "The custom location of the job code. This location will be used for tax calculation purposes if using US Payroll when an employee is working at this job code.", "properties": { "address": { "description": "The address of the custom location.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" } }, "required": [ "address" ], "title": "CustomLocation", "type": "object" }, "department": { "description": "The department associated with the job code.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "department_hierarchy": { "description": "List of departments in the department hierarchy. Refer department_hierarchy_ids for department hierarchy order.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestDepartment" }, "type": "array" }, "department_hierarchy_id": { "description": "The identifier of departments in the department hierarchy ordered from parent department to child department.", "items": { "type": "string" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the department.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestDepartment", "description": "The parent department.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent department.", "type": "string" }, "reference_code": { "description": "Reference code of the department.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Department", "type": "object" }, "department_id": { "description": "The department associated with the job code.", "type": "string" }, "external_id": { "description": "The unique identifier of the job code in an outside system.", "type": "string" }, "group_id": { "description": "The ID of the job roster group.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_archived": { "description": "Whether this job code is archived. Set to true via PATCH to archive. Archiving is irreversible via this API.", "type": "boolean" }, "job_dimension": { "description": "The job dimension this job code belongs to.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "external_id": { "description": "The unique identifier of the job dimension in a third party system", "type": "string" }, "group_id": { "description": "The ID of the dimension roster group.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "includes_custom_location": { "description": "Whether the job dimension includes codes related to a custom location. Only one dimension can have this set to true.", "type": "boolean" }, "name": { "description": "The name of the job dimension", "type": "string" }, "org_attribute_associations": { "description": "Organizational attributes associated with the job dimension. Only 'PAY_RATE' can be set or modified using POST or PATCH requests.", "items": {}, "type": "array" }, "roster_type": { "description": "The roster type of the dimension. PER_DIMENSION means that there is a group on the dimension level and employees within that group have access to all job codes in the dimension. PER_JOB_CODE means that each job code has its own group.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "JobDimension", "type": "object" }, "job_dimension_id": { "description": "The ID of the job dimension this job code belongs to.", "type": "string" }, "name": { "description": "The name of the job dimension.", "type": "string" }, "pay_rate": { "anyOf": [ { "description": "The pay rate for this job code. Only applicable if the associated job dimension includes the 'PAY_RATE' organizational attribute.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "pay_rate_exceptions": { "description": "Pay rate overrides for the job based on exception dimension values.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiJobPayRateExceptionaf426aa0ac14" }, "type": "array" }, "pay_rate_exceptions_id": { "description": "Pay rate overrides id for the job based on exception dimension values.", "items": { "type": "string" }, "type": "array" }, "updated_at": { "description": "Record update date", "type": "string" }, "work_location": { "description": "The work location associated with the job code.\n\nExpandable field", "properties": { "address": { "description": "The address for the work location.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the work location.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "address", "created_at", "id", "name", "updated_at" ], "title": "WorkLocation", "type": "object" }, "work_location_id": { "description": "The work location associated with the job code.", "type": "string" } }, "required": [ "created_at", "id", "job_dimension_id", "name", "updated_at" ], "title": "JobCode", "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Update a job code", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "job-codes.read-write" ] } }, "/job-codes/{job_code_id}/change-log/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/list-job-codes-job-code-id-change-log" }, "operationId": "rippling.rest_api.list_job_codes_job_code_id_change_log", "parameters": [ { "in": "path", "name": "job_code_id", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "expand", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 100, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "__meta": { "$ref": "#/components/schemas/OutputRestApiRedactedFields9f7657dc2a2f" }, "next_link": { "description": "A link to the next page of responses.", "format": "uri", "type": "string" }, "results": { "items": { "$ref": "#/components/schemas/OutputRestApiAttributeChangeDetails97f04b441f25" }, "type": "array" } }, "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "List attribute change logs", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "job-codes.read" ] } }, "/job-dimensions/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/list-job-dimensions" }, "operationId": "rippling.rest_api.list_job_dimensions", "parameters": [ { "in": "query", "name": "filter", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 100, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "__meta": { "$ref": "#/components/schemas/OutputRestApiRedactedFields9f7657dc2a2f" }, "next_link": { "description": "A link to the next page of responses.", "format": "uri", "type": "string" }, "results": { "items": { "$ref": "#/components/schemas/OutputRestApiJobDimensionce590ca55611" }, "type": "array" } }, "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "List job dimensions", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "job-dimensions.read" ] }, "post": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/create-job-dimensions" }, "operationId": "rippling.rest_api.create_job_dimensions", "parameters": [ { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiJobDimensionRequesta969d663d1c6" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "external_id": { "description": "The unique identifier of the job dimension in a third party system", "type": "string" }, "group_id": { "description": "The ID of the dimension roster group.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "includes_custom_location": { "description": "Whether the job dimension includes codes related to a custom location. Only one dimension can have this set to true.", "type": "boolean" }, "name": { "description": "The name of the job dimension", "type": "string" }, "org_attribute_associations": { "description": "Organizational attributes associated with the job dimension. Only 'PAY_RATE' can be set or modified using POST or PATCH requests.", "items": {}, "type": "array" }, "roster_type": { "description": "The roster type of the dimension. PER_DIMENSION means that there is a group on the dimension level and employees within that group have access to all job codes in the dimension. PER_JOB_CODE means that each job code has its own group.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "JobDimension", "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Create a new job dimension", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "job-dimensions.read-write" ] } }, "/job-dimensions/{id}/": { "delete": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/delete-job-dimensions" }, "operationId": "rippling.rest_api.delete_job_dimensions", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "id", "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "204": { "description": "The resource was deleted successfully" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Delete a job dimension", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "job-dimensions.read-write" ] }, "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/get-job-dimensions" }, "operationId": "rippling.rest_api.get_job_dimensions", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "id", "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "__meta": { "properties": { "redacted_fields": { "items": { "$ref": "#/components/schemas/OutputRestApiRedactedField21788a25ef22" }, "type": "array" } }, "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "external_id": { "description": "The unique identifier of the job dimension in a third party system", "type": "string" }, "group_id": { "description": "The ID of the dimension roster group.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "includes_custom_location": { "description": "Whether the job dimension includes codes related to a custom location. Only one dimension can have this set to true.", "type": "boolean" }, "name": { "description": "The name of the job dimension", "type": "string" }, "org_attribute_associations": { "description": "Organizational attributes associated with the job dimension. Only 'PAY_RATE' can be set or modified using POST or PATCH requests.", "items": {}, "type": "array" }, "roster_type": { "description": "The roster type of the dimension. PER_DIMENSION means that there is a group on the dimension level and employees within that group have access to all job codes in the dimension. PER_JOB_CODE means that each job code has its own group.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Retrieve a specific job dimension", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "job-dimensions.read" ] }, "patch": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/update-job-dimensions" }, "operationId": "rippling.rest_api.update_job_dimensions", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "id", "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiJobDimensionUpdateRequest86b6773b160a" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "external_id": { "description": "The unique identifier of the job dimension in a third party system", "type": "string" }, "group_id": { "description": "The ID of the dimension roster group.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "includes_custom_location": { "description": "Whether the job dimension includes codes related to a custom location. Only one dimension can have this set to true.", "type": "boolean" }, "name": { "description": "The name of the job dimension", "type": "string" }, "org_attribute_associations": { "description": "Organizational attributes associated with the job dimension. Only 'PAY_RATE' can be set or modified using POST or PATCH requests.", "items": {}, "type": "array" }, "roster_type": { "description": "The roster type of the dimension. PER_DIMENSION means that there is a group on the dimension level and employees within that group have access to all job codes in the dimension. PER_JOB_CODE means that each job code has its own group.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "JobDimension", "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Update a job dimension", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "job-dimensions.read-write" ] } }, "/job-functions/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/list-job-functions" }, "operationId": "rippling.rest_api.list_job_functions", "parameters": [ { "in": "query", "name": "order_by", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 100, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "__meta": { "$ref": "#/components/schemas/OutputRestApiRedactedFields9f7657dc2a2f" }, "next_link": { "description": "A link to the next page of responses.", "format": "uri", "type": "string" }, "results": { "items": { "$ref": "#/components/schemas/OutputRestApiJobFunctionf96c2901b7d8" }, "type": "array" } }, "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "List job functions", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "job-functions.read" ] } }, "/job-functions/{id}/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/get-job-functions" }, "operationId": "rippling.rest_api.get_job_functions", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "id", "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "__meta": { "properties": { "redacted_fields": { "items": { "$ref": "#/components/schemas/OutputRestApiRedactedField21788a25ef22" }, "type": "array" } }, "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "Displayed name of the job function", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Retrieve a specific job function", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "job-functions.read" ] } }, "/job-pay-rate-exceptions/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/list-job-pay-rate-exceptions" }, "operationId": "rippling.rest_api.list_job_pay_rate_exceptions", "parameters": [ { "in": "query", "name": "filter", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "expand", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 100, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "__meta": { "$ref": "#/components/schemas/OutputRestApiRedactedFields9f7657dc2a2f" }, "next_link": { "description": "A link to the next page of responses.", "format": "uri", "type": "string" }, "results": { "items": { "$ref": "#/components/schemas/OutputRestApiJobPayRateException2b2788a4d92c" }, "type": "array" } }, "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "List job pay rate exceptions", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "job-pay-rate-exceptions.read" ] } }, "/job-pay-rate-exceptions/{id}/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/get-job-pay-rate-exceptions" }, "operationId": "rippling.rest_api.get_job_pay_rate_exceptions", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "id", "type": "string" } }, { "in": "query", "name": "expand", "required": false, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "__meta": { "properties": { "redacted_fields": { "items": { "$ref": "#/components/schemas/OutputRestApiRedactedField21788a25ef22" }, "type": "array" } }, "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "exception_dimension_id": { "description": "Identifier of dimension object on which exception is configured. This objects details can be queried from exception_dimension_type's resource", "type": "string" }, "exception_dimension_type": { "description": "Type of dimension on which exception is configured", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "job_code": { "description": "Job for which exception is configured.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "custom_location": { "description": "The custom location of the job code. This location will be used for tax calculation purposes if using US Payroll when an employee is working at this job code.", "properties": { "address": { "description": "The address of the custom location.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" } }, "required": [ "address" ], "title": "CustomLocation", "type": "object" }, "department": { "description": "The department associated with the job code.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "department_hierarchy": { "description": "List of departments in the department hierarchy. Refer department_hierarchy_ids for department hierarchy order.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestDepartment" }, "type": "array" }, "department_hierarchy_id": { "description": "The identifier of departments in the department hierarchy ordered from parent department to child department.", "items": { "type": "string" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the department.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestDepartment", "description": "The parent department.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent department.", "type": "string" }, "reference_code": { "description": "Reference code of the department.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Department", "type": "object" }, "department_id": { "description": "The department associated with the job code.", "type": "string" }, "external_id": { "description": "The unique identifier of the job code in an outside system.", "type": "string" }, "group_id": { "description": "The ID of the job roster group.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_archived": { "description": "Whether this job code is archived. Set to true via PATCH to archive. Archiving is irreversible via this API.", "type": "boolean" }, "job_dimension": { "description": "The job dimension this job code belongs to.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "external_id": { "description": "The unique identifier of the job dimension in a third party system", "type": "string" }, "group_id": { "description": "The ID of the dimension roster group.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "includes_custom_location": { "description": "Whether the job dimension includes codes related to a custom location. Only one dimension can have this set to true.", "type": "boolean" }, "name": { "description": "The name of the job dimension", "type": "string" }, "org_attribute_associations": { "description": "Organizational attributes associated with the job dimension. Only 'PAY_RATE' can be set or modified using POST or PATCH requests.", "items": {}, "type": "array" }, "roster_type": { "description": "The roster type of the dimension. PER_DIMENSION means that there is a group on the dimension level and employees within that group have access to all job codes in the dimension. PER_JOB_CODE means that each job code has its own group.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "JobDimension", "type": "object" }, "job_dimension_id": { "description": "The ID of the job dimension this job code belongs to.", "type": "string" }, "name": { "description": "The name of the job dimension.", "type": "string" }, "pay_rate": { "anyOf": [ { "description": "The pay rate for this job code. Only applicable if the associated job dimension includes the 'PAY_RATE' organizational attribute.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "pay_rate_exceptions": { "description": "Pay rate overrides for the job based on exception dimension values.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestJobPayRateException" }, "type": "array" }, "pay_rate_exceptions_id": { "description": "Pay rate overrides id for the job based on exception dimension values.", "items": { "type": "string" }, "type": "array" }, "updated_at": { "description": "Record update date", "type": "string" }, "work_location": { "description": "The work location associated with the job code.\n\nExpandable field", "properties": { "address": { "description": "The address for the work location.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the work location.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "address", "created_at", "id", "name", "updated_at" ], "title": "WorkLocation", "type": "object" }, "work_location_id": { "description": "The work location associated with the job code.", "type": "string" } }, "required": [ "created_at", "id", "job_dimension_id", "name", "updated_at" ], "title": "JobCode", "type": "object" }, "job_code_id": { "description": "Identifier of Job for which exception is configured.", "type": "string" }, "pay_rate": { "anyOf": [ { "description": "The pay rate for exception on job_code_id and exception_dimension_id combination", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "exception_dimension_id", "id", "job_code_id", "pay_rate", "updated_at" ], "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Retrieve a specific job pay rate exception", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "job-pay-rate-exceptions.read" ] } }, "/job-pay-rate-exceptions/{job_pay_rate_exception_id}/change-log/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/list-job-pay-rate-exceptions-job-pay-rate-exception-id-change-log" }, "operationId": "rippling.rest_api.list_job_pay_rate_exceptions_job_pay_rate_exception_id_change_log", "parameters": [ { "in": "path", "name": "job_pay_rate_exception_id", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "expand", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 100, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "__meta": { "$ref": "#/components/schemas/OutputRestApiRedactedFields9f7657dc2a2f" }, "next_link": { "description": "A link to the next page of responses.", "format": "uri", "type": "string" }, "results": { "items": { "$ref": "#/components/schemas/OutputRestApiAttributeChangeDetails97f04b441f25" }, "type": "array" } }, "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "List attribute change logs", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "job-pay-rate-exceptions.read" ] } }, "/job-requisitions-write/": { "post": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/create-job-requisitions-write" }, "operationId": "rippling.rest_api.create_job_requisitions_write", "parameters": [ { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiJobRequisitionBaseResourceDTORequestaf52fba558d9" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "\n DTO for creating JobRequisitions via the Platform API.\n Maps to the existing ATS JobRequisitionDTO for use with create_from_DTO service.\n ", "properties": { "confidential": { "description": "Whether this requisition is confidential", "type": "boolean" }, "confidential_whitelist": { "description": "List of role IDs allowed to view confidential requisition", "items": { "type": "string" }, "type": "array" }, "coordinator_id": { "description": "Coordinator role ID", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "default_private_invites": { "description": "Whether to default to private invites", "type": "boolean" }, "departments": { "description": "List of department IDs", "items": { "type": "string" }, "type": "array" }, "description": { "description": "Job description", "type": "string" }, "employment_type_id": { "description": "Company employment type ID", "type": "string" }, "hiring_manager_id": { "description": "Hiring manager role ID", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_evergreen": { "description": "Whether this is an evergreen requisition", "type": "boolean" }, "levels": { "description": "List of level IDs", "items": { "type": "string" }, "type": "array" }, "name": { "description": "Title/name of the job requisition", "type": "string" }, "pipeline_plan_id": { "description": "Pipeline plan ID to use for this requisition", "type": "string" }, "recruiter_id": { "description": "Primary recruiter role ID", "type": "string" }, "requisition_id": { "description": "Customer-defined requisition ID. Auto-generated if not provided.", "type": "string" }, "salary_currency": { "description": "Salary currency code", "type": "string" }, "salary_per_unit": { "anyOf": [ { "description": "Salary amount per unit", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "salary_per_unit_high": { "anyOf": [ { "description": "Salary range upper bound", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "salary_per_unit_low": { "anyOf": [ { "description": "Salary range lower bound", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "salary_type": { "description": "Salary type", "type": "string" }, "salary_unit": { "description": "Salary unit (HOUR, DAY, WEEK, MONTH, YEAR, PAY_PERIOD)", "type": "string" }, "secondary_recruiters": { "description": "List of secondary recruiter role IDs", "items": { "type": "string" }, "type": "array" }, "sourcer_id": { "description": "Sourcer role ID", "type": "string" }, "status": { "description": "Job requisition status (e.g., DRAFT, OPEN, CLOSED)", "type": "string" }, "target_close": { "description": "Target close date", "type": "string" }, "target_employee_start_date": { "description": "Target employee start date", "type": "string" }, "teams": { "description": "List of team IDs", "items": { "type": "string" }, "type": "array" }, "title": { "description": "Internal employee title", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "work_locations": { "description": "List of work location IDs", "items": { "type": "string" }, "type": "array" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "JobRequisitionBaseResourceDTO", "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Create a new job requisition", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "job-requisitions-write.read-write" ] } }, "/job-requisitions/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/list-job-requisitions" }, "operationId": "rippling.rest_api.list_job_requisitions", "parameters": [ { "in": "query", "name": "order_by", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 100, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "__meta": { "$ref": "#/components/schemas/OutputRestApiRedactedFields9f7657dc2a2f" }, "next_link": { "description": "A link to the next page of responses.", "format": "uri", "type": "string" }, "results": { "items": { "$ref": "#/components/schemas/OutputRestApiJobRequisition324d78fa0203" }, "type": "array" } }, "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "List job requisitions", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "job-requisitions.read" ] } }, "/kiosk-badges/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/list-kiosk-badges" }, "operationId": "rippling.rest_api.list_kiosk_badges", "parameters": [ { "in": "query", "name": "filter", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "expand", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 100, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "__meta": { "$ref": "#/components/schemas/OutputRestApiRedactedFields9f7657dc2a2f" }, "next_link": { "description": "A link to the next page of responses.", "format": "uri", "type": "string" }, "results": { "items": { "$ref": "#/components/schemas/OutputRestApiTimeKioskBadgeaf0bfaa20b9b" }, "type": "array" } }, "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "List kiosk badges", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "kiosk-badges.read" ] }, "post": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/create-kiosk-badges" }, "operationId": "rippling.rest_api.create_kiosk_badges", "parameters": [ { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiTimeKioskBadgeRequest3f416489de5e" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "badge_id": { "description": "The ID associated with the badge. Not to be confused with the record's ID.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_enabled": { "description": "Whether this badge can be used with the Kiosk app.", "type": "boolean" }, "updated_at": { "description": "Record update date", "type": "string" }, "worker": { "description": "The worker associated with the badge.\n\nExpandable field", "properties": { "business_partners": { "description": "Worker's assigned business partners. This field is only populated when explicitly requested via the expand parameter (e.g., ?expand=business_partners). When expanded, returns an empty list ([]) if the worker has no business partners.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiBusinessPartner77b00a069c32" }, "type": "array" }, "business_partners_id": { "description": "Worker's assigned business partners unique identifiers. Returns an empty list ([]) if the worker has no business partners.", "items": { "type": "string" }, "type": "array" }, "citizenship": { "description": "The countries that the worker has citizenship in.", "type": "string" }, "compensation": { "description": "The compensation package for the worker.\n\nExpandable field", "properties": { "annual_compensation": { "description": "The worker's annual compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "annual_salary_equivalent": { "description": "The worker's annual salary equivalent, for insurance purposes. It will be equal to the worker's annual compensation, except for owners that are receiving no cashcompensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "bonus_schedule": { "description": "The worker's bonus schedule.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "hourly_wage": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "id": { "description": "Identifier field", "type": "string" }, "monthly_compensation": { "description": "The worker's monthly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "on_target_commission": { "description": "The worker's on-target commission.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "payment_terms": { "description": "The payment terms for an worker's compensation.", "type": "string" }, "payment_type": { "description": "The payment type for an worker's compensation.", "type": "string" }, "relocation_reimbursement": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "salary_effective_date": { "description": "Salary effective date", "type": "string" }, "signing_bonus": { "description": "The worker's signing bonus.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus": { "description": "The worker's target annual bonus amount.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus_percent": { "anyOf": [ { "description": "The worker's target annual bonus as a percent of annual compensation.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" }, "weekly_compensation": { "description": "The worker's weekly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "worker": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's details.\n\nExpandable field", "type": "object" }, "worker_id": { "description": "The worker's ID.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Compensation", "type": "object" }, "compensation_grade": { "description": "The compensation grade assigned to the worker, if any.", "properties": { "id": { "description": "The compensation grade's unique identifier.", "type": "string" }, "label": { "description": "The compensation grade's label.", "type": "string" } }, "title": "WorkerCompensationGrade", "type": "object" }, "compensation_id": { "description": "The compensation package for the worker.", "type": "string" }, "country": { "description": "The worker's country.", "type": "string" }, "country_fields": { "description": "Country level fields for the worker.", "properties": { "ca": { "description": "Country-wise regional fields for Canada", "properties": { "sin": { "description": "Social Insurance Number (SIN) for Canada employees.", "type": "string" } }, "title": "CanadaFields", "type": "object" }, "nz": { "description": "Country-wise regional fields for New Zealand", "properties": { "ird_number": { "description": "Inland Revenue Department (IRD) number for New Zealand employees.", "type": "string" } }, "title": "NewZealandFields", "type": "object" }, "us": { "description": "Country-wise regional fields for USA", "properties": { "ssn": { "description": "Social Security Number (SSN) for US employees.", "type": "string" } }, "title": "USFields", "type": "object" } }, "title": "CountryFields", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "custom_fields": { "description": "Custom field values defined on the Employee object for this worker\n\nExpandable field", "items": { "additionalProperties": {} }, "type": "array" }, "date_of_birth": { "description": "The worker's date of birth.", "type": "string" }, "department": { "description": "The worker's assigned department.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "department_hierarchy": { "description": "List of departments in the department hierarchy. Refer department_hierarchy_ids for department hierarchy order.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestDepartment" }, "type": "array" }, "department_hierarchy_id": { "description": "The identifier of departments in the department hierarchy ordered from parent department to child department.", "items": { "type": "string" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the department.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestDepartment", "description": "The parent department.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent department.", "type": "string" }, "reference_code": { "description": "Reference code of the department.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Department", "type": "object" }, "department_id": { "description": "The worker's assigned department.", "type": "string" }, "employment_type": { "description": "The worker's employment type.\n\nExpandable field", "properties": { "amount_worked": { "description": "The amount worked for the employment type. * `FULL-TIME`: Full-time is at least 30 hours per week. Full-time workers will typically be eligible for benefits. * `PART-TIME`: Part-time is less than 30 hours per week. These workers may be eligible for benefits, depending on company settings and hours worked. * `TEMPORARY`: These workers are hired on a temporary basis. You can specify how each worker with this employment type will be paid individually.", "type": "string" }, "compensation_time_period": { "description": "The compensation period for the employment type. * `SALARIED`: Employees that are paid a fixed amount per year. * `HOURLY`: Employees that are paid a wage per hour worked.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "label": { "description": "The display label of the employment type.", "type": "string" }, "name": { "description": "The name of the employment type for non-custom employment types.", "type": "string" }, "type": { "description": "The classification of the worker by the company. * `CONTRACTOR`: Contractors are self-employed workers who provide services on a short-term or per-project basis and are not eligible for tax-withholding or benefits. * `EMPLOYEE`: Employees are hired and managed by an employer, work under the employer's direct supervision and control, and are protected by law for wages and employment rights.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "label", "updated_at" ], "title": "CompanyEmploymentType", "type": "object" }, "employment_type_id": { "description": "The worker's employment type.", "type": "string" }, "end_date": { "description": "The end date of the worker.", "type": "string" }, "ethnicity": { "description": "The identified ethnicity of the worker, if specified.", "type": "string" }, "gender": { "description": "The gender of the worker, if specified.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_manager": { "description": "Whether the worker is a manager", "type": "boolean" }, "job_function": { "description": "The worker's job function. When expanded, this field requires `job-functions.read`.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "Displayed name of the job function", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "JobFunction", "type": "object" }, "job_function_id": { "description": "ID of the worker's job function.", "type": "string" }, "legal_entity": { "description": "The worker's associated legal entity.\n\nExpandable field", "properties": { "company": { "description": "The company or organization associated with the legal entity\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "doing_business_as_name": { "description": "The doing business as name for the company.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_entities": { "description": "A list of the company's entities.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestLegalEntity" }, "type": "array" }, "legal_entities_id": { "description": "A list of the company's entities.", "items": { "type": "string" }, "type": "array" }, "legal_name": { "description": "The legal name of the company.", "type": "string" }, "name": { "description": "The name of the company.", "type": "string" }, "parent_legal_entity": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The company's ultimate holding entity.\n\nExpandable field", "type": "object" }, "parent_legal_entity_id": { "description": "The company's ultimate holding entity.", "type": "string" }, "phone": { "description": "The phone number for the company.", "type": "string" }, "physical_address": { "description": "The physical address of the holding entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "primary_email": { "description": "The email address used when registering this company.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "legal_entities", "legal_entities_id", "name", "updated_at" ], "title": "Company", "type": "object" }, "company_id": { "description": "The company or organization associated with the legal entity", "type": "string" }, "country": { "description": "The country the legal entity is based in.", "properties": { "code": { "description": "The code of the country.", "type": "string" } }, "required": [ "code" ], "title": "Country", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "entity_level": { "description": "The legal entity's level in a hierarchy. * `PARENT`: The legal entity is considered the ultimate holding entity. * `SUBSIDIARY`: The legal entity is considered a subsidiary, fully or partially held by another. * `BRANCH`: The legal entity is considered a branch, associated with a parent legal entity.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_name": { "description": "The legal name of the legal entity.", "type": "string" }, "mailing_address": { "description": "The mailing address of the legal entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "management_type": { "description": "The legal entity management type in the case of an employer of record (EOR) or professional employment organization (PEO). * `PEO`: The legal entity is considered a Professional Employment Organization (PEO). * `EOR`: The legal entity is considered an Employer of Record (EOR).", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The parent legal entity.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent legal entity.", "type": "string" }, "physical_address": { "description": "The physical address of the legal entity, if it differs from the mailing address.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "registration_date": { "description": "The registration date of the entity.", "type": "string" }, "tax_identifier": { "description": "The tax identifier for the legal entity.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "LegalEntity", "type": "object" }, "legal_entity_id": { "description": "The worker's associated legal entity.", "type": "string" }, "level": { "description": "The level of the worker.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "description": { "description": "The description of the level.", "type": "string" }, "experience_requirements": { "description": "The experience requirements for the level.", "type": "string" }, "global_level": { "anyOf": [ { "description": "Global level is used to track the seniority of levels. The higher up a level is placed on the page, the more senior and higher-ranked the level. Global level is used in workflows, policies, and reports that use the level attribute (e.g., you can use Level Lookup to set up a workflow that notifies the nearest person in an worker's management chain at or above the specified level).", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the level. Must be unique within the company or organization.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLevel", "description": "The parent level.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent level.", "type": "string" }, "rank": { "anyOf": [ { "description": "The rank of the level within its track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "scope_of_responsibilities": { "description": "The scope of responsibilities for the level.", "type": "string" }, "track": { "description": "The track associated with the level, if it's not a global level.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_default": { "description": "Whether this is the company's default track.", "type": "boolean" }, "name": { "description": "The name of the track. Must be unique within the company or organization.", "type": "string" }, "order": { "anyOf": [ { "description": "The one-based horizontal display order of the track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "start_global_level": { "anyOf": [ { "description": "The highest global level occupied by this track. Empty tracks return null.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Track", "type": "object" }, "track_id": { "description": "The track associated with the level. Required during creation. Include global_level when changing it.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Level", "type": "object" }, "level_id": { "description": "The level of the worker.", "type": "string" }, "location": { "description": "The location that the worker is mapped to for tax purposes. In the case that a worker is remote, the location's type is remote.", "properties": { "type": { "description": "The type of location.", "type": "string" }, "work_location_id": { "description": "The work location, if the worker isn't remote.", "type": "string" } }, "required": [ "type", "work_location_id" ], "title": "WorkerLocation", "type": "object" }, "manager": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's manager.\n\nExpandable field", "type": "object" }, "manager_id": { "description": "The worker's manager.", "type": "string" }, "number": { "anyOf": [ { "description": "The worker's number within the organization.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "original_start_date": { "description": "The worker's earliest start date across their employment history, excluding INIT roles.", "type": "string" }, "overtime_exemption": { "description": "The worker's overtime exemption status.", "type": "string" }, "pay_schedule_id": { "description": "The ID of the pay schedule currently associated with the worker.", "type": "string" }, "personal_email": { "description": "The worker's associated personal email address.", "type": "string" }, "race": { "description": "The identified race of the worker, if specified.", "type": "string" }, "start_date": { "description": "The start date of the worker.", "type": "string" }, "status": { "description": "The worker's status within the organization.", "type": "string" }, "teams": { "description": "The worker's assigned teams.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiTeamcb26bc28f32f" }, "type": "array" }, "teams_id": { "description": "The worker's assigned teams.", "items": { "type": "string" }, "type": "array" }, "termination_details": { "description": "The details of the worker's termination, if applicable.", "properties": { "reason": { "description": "This is a description that will be custom to each Rippling company.", "type": "string" }, "type": { "description": "The termination type indicates whether the termination was voluntary or involuntary.", "type": "string" } }, "title": "TerminationDetails", "type": "object" }, "title": { "description": "The worker's title.", "type": "string" }, "title_effective_date": { "description": "Title effective date", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "user": { "description": "The worker's associated user.\n\nExpandable field", "properties": { "active": { "description": "Whether the user is able to access company resources, typically when they are in actively engaged with the company and not after off-boarding.", "type": "boolean" }, "addresses": { "description": "The user's addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiUserAddressedd59b9ba9a1" }, "type": "array" }, "created_at": { "description": "Record creation date", "type": "string" }, "display_name": { "description": "The display name of the user using either the concatenated preferred given and family name or username depending on availability.", "type": "string" }, "emails": { "description": "The user's email addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiEmail5284c8258dc3" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "locale": { "description": "The User's default location for purposes of localization of currency, date time format, or numerical representations pursuant to RFC5646.", "type": "string" }, "name": { "description": "The user's name.", "properties": { "family_name": { "description": "The legal family name of the user, or last name in most Western languages.", "type": "string" }, "formatted": { "description": "The user's full name.", "type": "string" }, "given_name": { "description": "The given legal name of the user, or first name in most Western languages.", "type": "string" }, "middle_name": { "description": "The middle name(s) of the user.", "type": "string" }, "preferred_family_name": { "description": "The preferred family name, or last name in most Western languages, by the user.", "type": "string" }, "preferred_given_name": { "description": "The preferred given name, or first name in most Western languages, by the user.", "type": "string" } }, "title": "UserName", "type": "object" }, "number": { "description": "The permanent profile number of the user.", "type": "string" }, "phone_numbers": { "description": "The user's phone numbers.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoneNumber12060c61ecf5" }, "type": "array" }, "photos": { "description": "The user's photos.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoto2be7c3ae3f39" }, "type": "array" }, "preferred_language": { "description": "The User's preferred written or spoken language in the same format of the HTTP Accept-Language header, pursuant to Section 5.3.5 of RFC7231.", "type": "string" }, "timezone": { "description": "The User's current time zone in IANA database Olson format", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "username": { "description": "The unique identifier across Rippling used by the User for direct authentication into their associated company. Globally unique.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "User", "type": "object" }, "user_id": { "description": "The worker's associated user.", "type": "string" }, "work_email": { "description": "The worker's associated work email address.", "type": "string" }, "work_schedule": { "additionalProperties": { "$ref": "#/components/schemas/OutputRestApiWorkScheduleDay938f88d94f20" }, "description": "The worker's scheduled working hours for each day of the week.", "type": "object" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Worker", "type": "object" }, "worker_id": { "description": "The ID of the worker associated with the badge.", "type": "string" }, "worker_number": { "anyOf": [ { "description": "The employee number of the worker associated with the badge.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "required": [ "badge_id", "created_at", "id", "updated_at" ], "title": "TimeKioskBadge", "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Create a new kiosk badge", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "kiosk-badges.read-write" ] } }, "/kiosk-badges/{id}/": { "delete": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/delete-kiosk-badges" }, "operationId": "rippling.rest_api.delete_kiosk_badges", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "id", "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "204": { "description": "The resource was deleted successfully" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Delete a kiosk badge", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "kiosk-badges.read-write" ] }, "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/get-kiosk-badges" }, "operationId": "rippling.rest_api.get_kiosk_badges", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "id", "type": "string" } }, { "in": "query", "name": "expand", "required": false, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "__meta": { "properties": { "redacted_fields": { "items": { "$ref": "#/components/schemas/OutputRestApiRedactedField21788a25ef22" }, "type": "array" } }, "type": "object" }, "badge_id": { "description": "The ID associated with the badge. Not to be confused with the record's ID.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_enabled": { "description": "Whether this badge can be used with the Kiosk app.", "type": "boolean" }, "updated_at": { "description": "Record update date", "type": "string" }, "worker": { "description": "The worker associated with the badge.\n\nExpandable field", "properties": { "business_partners": { "description": "Worker's assigned business partners. This field is only populated when explicitly requested via the expand parameter (e.g., ?expand=business_partners). When expanded, returns an empty list ([]) if the worker has no business partners.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiBusinessPartner77b00a069c32" }, "type": "array" }, "business_partners_id": { "description": "Worker's assigned business partners unique identifiers. Returns an empty list ([]) if the worker has no business partners.", "items": { "type": "string" }, "type": "array" }, "citizenship": { "description": "The countries that the worker has citizenship in.", "type": "string" }, "compensation": { "description": "The compensation package for the worker.\n\nExpandable field", "properties": { "annual_compensation": { "description": "The worker's annual compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "annual_salary_equivalent": { "description": "The worker's annual salary equivalent, for insurance purposes. It will be equal to the worker's annual compensation, except for owners that are receiving no cashcompensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "bonus_schedule": { "description": "The worker's bonus schedule.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "hourly_wage": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "id": { "description": "Identifier field", "type": "string" }, "monthly_compensation": { "description": "The worker's monthly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "on_target_commission": { "description": "The worker's on-target commission.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "payment_terms": { "description": "The payment terms for an worker's compensation.", "type": "string" }, "payment_type": { "description": "The payment type for an worker's compensation.", "type": "string" }, "relocation_reimbursement": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "salary_effective_date": { "description": "Salary effective date", "type": "string" }, "signing_bonus": { "description": "The worker's signing bonus.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus": { "description": "The worker's target annual bonus amount.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus_percent": { "anyOf": [ { "description": "The worker's target annual bonus as a percent of annual compensation.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" }, "weekly_compensation": { "description": "The worker's weekly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "worker": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's details.\n\nExpandable field", "type": "object" }, "worker_id": { "description": "The worker's ID.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Compensation", "type": "object" }, "compensation_grade": { "description": "The compensation grade assigned to the worker, if any.", "properties": { "id": { "description": "The compensation grade's unique identifier.", "type": "string" }, "label": { "description": "The compensation grade's label.", "type": "string" } }, "title": "WorkerCompensationGrade", "type": "object" }, "compensation_id": { "description": "The compensation package for the worker.", "type": "string" }, "country": { "description": "The worker's country.", "type": "string" }, "country_fields": { "description": "Country level fields for the worker.", "properties": { "ca": { "description": "Country-wise regional fields for Canada", "properties": { "sin": { "description": "Social Insurance Number (SIN) for Canada employees.", "type": "string" } }, "title": "CanadaFields", "type": "object" }, "nz": { "description": "Country-wise regional fields for New Zealand", "properties": { "ird_number": { "description": "Inland Revenue Department (IRD) number for New Zealand employees.", "type": "string" } }, "title": "NewZealandFields", "type": "object" }, "us": { "description": "Country-wise regional fields for USA", "properties": { "ssn": { "description": "Social Security Number (SSN) for US employees.", "type": "string" } }, "title": "USFields", "type": "object" } }, "title": "CountryFields", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "custom_fields": { "description": "Custom field values defined on the Employee object for this worker\n\nExpandable field", "items": { "additionalProperties": {} }, "type": "array" }, "date_of_birth": { "description": "The worker's date of birth.", "type": "string" }, "department": { "description": "The worker's assigned department.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "department_hierarchy": { "description": "List of departments in the department hierarchy. Refer department_hierarchy_ids for department hierarchy order.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestDepartment" }, "type": "array" }, "department_hierarchy_id": { "description": "The identifier of departments in the department hierarchy ordered from parent department to child department.", "items": { "type": "string" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the department.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestDepartment", "description": "The parent department.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent department.", "type": "string" }, "reference_code": { "description": "Reference code of the department.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Department", "type": "object" }, "department_id": { "description": "The worker's assigned department.", "type": "string" }, "employment_type": { "description": "The worker's employment type.\n\nExpandable field", "properties": { "amount_worked": { "description": "The amount worked for the employment type. * `FULL-TIME`: Full-time is at least 30 hours per week. Full-time workers will typically be eligible for benefits. * `PART-TIME`: Part-time is less than 30 hours per week. These workers may be eligible for benefits, depending on company settings and hours worked. * `TEMPORARY`: These workers are hired on a temporary basis. You can specify how each worker with this employment type will be paid individually.", "type": "string" }, "compensation_time_period": { "description": "The compensation period for the employment type. * `SALARIED`: Employees that are paid a fixed amount per year. * `HOURLY`: Employees that are paid a wage per hour worked.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "label": { "description": "The display label of the employment type.", "type": "string" }, "name": { "description": "The name of the employment type for non-custom employment types.", "type": "string" }, "type": { "description": "The classification of the worker by the company. * `CONTRACTOR`: Contractors are self-employed workers who provide services on a short-term or per-project basis and are not eligible for tax-withholding or benefits. * `EMPLOYEE`: Employees are hired and managed by an employer, work under the employer's direct supervision and control, and are protected by law for wages and employment rights.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "label", "updated_at" ], "title": "CompanyEmploymentType", "type": "object" }, "employment_type_id": { "description": "The worker's employment type.", "type": "string" }, "end_date": { "description": "The end date of the worker.", "type": "string" }, "ethnicity": { "description": "The identified ethnicity of the worker, if specified.", "type": "string" }, "gender": { "description": "The gender of the worker, if specified.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_manager": { "description": "Whether the worker is a manager", "type": "boolean" }, "job_function": { "description": "The worker's job function. When expanded, this field requires `job-functions.read`.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "Displayed name of the job function", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "JobFunction", "type": "object" }, "job_function_id": { "description": "ID of the worker's job function.", "type": "string" }, "legal_entity": { "description": "The worker's associated legal entity.\n\nExpandable field", "properties": { "company": { "description": "The company or organization associated with the legal entity\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "doing_business_as_name": { "description": "The doing business as name for the company.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_entities": { "description": "A list of the company's entities.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestLegalEntity" }, "type": "array" }, "legal_entities_id": { "description": "A list of the company's entities.", "items": { "type": "string" }, "type": "array" }, "legal_name": { "description": "The legal name of the company.", "type": "string" }, "name": { "description": "The name of the company.", "type": "string" }, "parent_legal_entity": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The company's ultimate holding entity.\n\nExpandable field", "type": "object" }, "parent_legal_entity_id": { "description": "The company's ultimate holding entity.", "type": "string" }, "phone": { "description": "The phone number for the company.", "type": "string" }, "physical_address": { "description": "The physical address of the holding entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "primary_email": { "description": "The email address used when registering this company.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "legal_entities", "legal_entities_id", "name", "updated_at" ], "title": "Company", "type": "object" }, "company_id": { "description": "The company or organization associated with the legal entity", "type": "string" }, "country": { "description": "The country the legal entity is based in.", "properties": { "code": { "description": "The code of the country.", "type": "string" } }, "required": [ "code" ], "title": "Country", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "entity_level": { "description": "The legal entity's level in a hierarchy. * `PARENT`: The legal entity is considered the ultimate holding entity. * `SUBSIDIARY`: The legal entity is considered a subsidiary, fully or partially held by another. * `BRANCH`: The legal entity is considered a branch, associated with a parent legal entity.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_name": { "description": "The legal name of the legal entity.", "type": "string" }, "mailing_address": { "description": "The mailing address of the legal entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "management_type": { "description": "The legal entity management type in the case of an employer of record (EOR) or professional employment organization (PEO). * `PEO`: The legal entity is considered a Professional Employment Organization (PEO). * `EOR`: The legal entity is considered an Employer of Record (EOR).", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The parent legal entity.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent legal entity.", "type": "string" }, "physical_address": { "description": "The physical address of the legal entity, if it differs from the mailing address.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "registration_date": { "description": "The registration date of the entity.", "type": "string" }, "tax_identifier": { "description": "The tax identifier for the legal entity.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "LegalEntity", "type": "object" }, "legal_entity_id": { "description": "The worker's associated legal entity.", "type": "string" }, "level": { "description": "The level of the worker.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "description": { "description": "The description of the level.", "type": "string" }, "experience_requirements": { "description": "The experience requirements for the level.", "type": "string" }, "global_level": { "anyOf": [ { "description": "Global level is used to track the seniority of levels. The higher up a level is placed on the page, the more senior and higher-ranked the level. Global level is used in workflows, policies, and reports that use the level attribute (e.g., you can use Level Lookup to set up a workflow that notifies the nearest person in an worker's management chain at or above the specified level).", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the level. Must be unique within the company or organization.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLevel", "description": "The parent level.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent level.", "type": "string" }, "rank": { "anyOf": [ { "description": "The rank of the level within its track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "scope_of_responsibilities": { "description": "The scope of responsibilities for the level.", "type": "string" }, "track": { "description": "The track associated with the level, if it's not a global level.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_default": { "description": "Whether this is the company's default track.", "type": "boolean" }, "name": { "description": "The name of the track. Must be unique within the company or organization.", "type": "string" }, "order": { "anyOf": [ { "description": "The one-based horizontal display order of the track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "start_global_level": { "anyOf": [ { "description": "The highest global level occupied by this track. Empty tracks return null.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Track", "type": "object" }, "track_id": { "description": "The track associated with the level. Required during creation. Include global_level when changing it.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Level", "type": "object" }, "level_id": { "description": "The level of the worker.", "type": "string" }, "location": { "description": "The location that the worker is mapped to for tax purposes. In the case that a worker is remote, the location's type is remote.", "properties": { "type": { "description": "The type of location.", "type": "string" }, "work_location_id": { "description": "The work location, if the worker isn't remote.", "type": "string" } }, "required": [ "type", "work_location_id" ], "title": "WorkerLocation", "type": "object" }, "manager": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's manager.\n\nExpandable field", "type": "object" }, "manager_id": { "description": "The worker's manager.", "type": "string" }, "number": { "anyOf": [ { "description": "The worker's number within the organization.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "original_start_date": { "description": "The worker's earliest start date across their employment history, excluding INIT roles.", "type": "string" }, "overtime_exemption": { "description": "The worker's overtime exemption status.", "type": "string" }, "pay_schedule_id": { "description": "The ID of the pay schedule currently associated with the worker.", "type": "string" }, "personal_email": { "description": "The worker's associated personal email address.", "type": "string" }, "race": { "description": "The identified race of the worker, if specified.", "type": "string" }, "start_date": { "description": "The start date of the worker.", "type": "string" }, "status": { "description": "The worker's status within the organization.", "type": "string" }, "teams": { "description": "The worker's assigned teams.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiTeamcb26bc28f32f" }, "type": "array" }, "teams_id": { "description": "The worker's assigned teams.", "items": { "type": "string" }, "type": "array" }, "termination_details": { "description": "The details of the worker's termination, if applicable.", "properties": { "reason": { "description": "This is a description that will be custom to each Rippling company.", "type": "string" }, "type": { "description": "The termination type indicates whether the termination was voluntary or involuntary.", "type": "string" } }, "title": "TerminationDetails", "type": "object" }, "title": { "description": "The worker's title.", "type": "string" }, "title_effective_date": { "description": "Title effective date", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "user": { "description": "The worker's associated user.\n\nExpandable field", "properties": { "active": { "description": "Whether the user is able to access company resources, typically when they are in actively engaged with the company and not after off-boarding.", "type": "boolean" }, "addresses": { "description": "The user's addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiUserAddressedd59b9ba9a1" }, "type": "array" }, "created_at": { "description": "Record creation date", "type": "string" }, "display_name": { "description": "The display name of the user using either the concatenated preferred given and family name or username depending on availability.", "type": "string" }, "emails": { "description": "The user's email addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiEmail5284c8258dc3" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "locale": { "description": "The User's default location for purposes of localization of currency, date time format, or numerical representations pursuant to RFC5646.", "type": "string" }, "name": { "description": "The user's name.", "properties": { "family_name": { "description": "The legal family name of the user, or last name in most Western languages.", "type": "string" }, "formatted": { "description": "The user's full name.", "type": "string" }, "given_name": { "description": "The given legal name of the user, or first name in most Western languages.", "type": "string" }, "middle_name": { "description": "The middle name(s) of the user.", "type": "string" }, "preferred_family_name": { "description": "The preferred family name, or last name in most Western languages, by the user.", "type": "string" }, "preferred_given_name": { "description": "The preferred given name, or first name in most Western languages, by the user.", "type": "string" } }, "title": "UserName", "type": "object" }, "number": { "description": "The permanent profile number of the user.", "type": "string" }, "phone_numbers": { "description": "The user's phone numbers.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoneNumber12060c61ecf5" }, "type": "array" }, "photos": { "description": "The user's photos.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoto2be7c3ae3f39" }, "type": "array" }, "preferred_language": { "description": "The User's preferred written or spoken language in the same format of the HTTP Accept-Language header, pursuant to Section 5.3.5 of RFC7231.", "type": "string" }, "timezone": { "description": "The User's current time zone in IANA database Olson format", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "username": { "description": "The unique identifier across Rippling used by the User for direct authentication into their associated company. Globally unique.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "User", "type": "object" }, "user_id": { "description": "The worker's associated user.", "type": "string" }, "work_email": { "description": "The worker's associated work email address.", "type": "string" }, "work_schedule": { "additionalProperties": { "$ref": "#/components/schemas/OutputRestApiWorkScheduleDay938f88d94f20" }, "description": "The worker's scheduled working hours for each day of the week.", "type": "object" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Worker", "type": "object" }, "worker_id": { "description": "The ID of the worker associated with the badge.", "type": "string" }, "worker_number": { "anyOf": [ { "description": "The employee number of the worker associated with the badge.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "required": [ "badge_id", "created_at", "id", "updated_at" ], "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Retrieve a specific kiosk badge", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "kiosk-badges.read" ] }, "patch": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/update-kiosk-badges" }, "operationId": "rippling.rest_api.update_kiosk_badges", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "id", "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiTimeKioskBadgeUpdateRequest0d5d854b7006" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "badge_id": { "description": "The ID associated with the badge. Not to be confused with the record's ID.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_enabled": { "description": "Whether this badge can be used with the Kiosk app.", "type": "boolean" }, "updated_at": { "description": "Record update date", "type": "string" }, "worker": { "description": "The worker associated with the badge.\n\nExpandable field", "properties": { "business_partners": { "description": "Worker's assigned business partners. This field is only populated when explicitly requested via the expand parameter (e.g., ?expand=business_partners). When expanded, returns an empty list ([]) if the worker has no business partners.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiBusinessPartner77b00a069c32" }, "type": "array" }, "business_partners_id": { "description": "Worker's assigned business partners unique identifiers. Returns an empty list ([]) if the worker has no business partners.", "items": { "type": "string" }, "type": "array" }, "citizenship": { "description": "The countries that the worker has citizenship in.", "type": "string" }, "compensation": { "description": "The compensation package for the worker.\n\nExpandable field", "properties": { "annual_compensation": { "description": "The worker's annual compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "annual_salary_equivalent": { "description": "The worker's annual salary equivalent, for insurance purposes. It will be equal to the worker's annual compensation, except for owners that are receiving no cashcompensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "bonus_schedule": { "description": "The worker's bonus schedule.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "hourly_wage": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "id": { "description": "Identifier field", "type": "string" }, "monthly_compensation": { "description": "The worker's monthly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "on_target_commission": { "description": "The worker's on-target commission.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "payment_terms": { "description": "The payment terms for an worker's compensation.", "type": "string" }, "payment_type": { "description": "The payment type for an worker's compensation.", "type": "string" }, "relocation_reimbursement": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "salary_effective_date": { "description": "Salary effective date", "type": "string" }, "signing_bonus": { "description": "The worker's signing bonus.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus": { "description": "The worker's target annual bonus amount.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus_percent": { "anyOf": [ { "description": "The worker's target annual bonus as a percent of annual compensation.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" }, "weekly_compensation": { "description": "The worker's weekly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "worker": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's details.\n\nExpandable field", "type": "object" }, "worker_id": { "description": "The worker's ID.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Compensation", "type": "object" }, "compensation_grade": { "description": "The compensation grade assigned to the worker, if any.", "properties": { "id": { "description": "The compensation grade's unique identifier.", "type": "string" }, "label": { "description": "The compensation grade's label.", "type": "string" } }, "title": "WorkerCompensationGrade", "type": "object" }, "compensation_id": { "description": "The compensation package for the worker.", "type": "string" }, "country": { "description": "The worker's country.", "type": "string" }, "country_fields": { "description": "Country level fields for the worker.", "properties": { "ca": { "description": "Country-wise regional fields for Canada", "properties": { "sin": { "description": "Social Insurance Number (SIN) for Canada employees.", "type": "string" } }, "title": "CanadaFields", "type": "object" }, "nz": { "description": "Country-wise regional fields for New Zealand", "properties": { "ird_number": { "description": "Inland Revenue Department (IRD) number for New Zealand employees.", "type": "string" } }, "title": "NewZealandFields", "type": "object" }, "us": { "description": "Country-wise regional fields for USA", "properties": { "ssn": { "description": "Social Security Number (SSN) for US employees.", "type": "string" } }, "title": "USFields", "type": "object" } }, "title": "CountryFields", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "custom_fields": { "description": "Custom field values defined on the Employee object for this worker\n\nExpandable field", "items": { "additionalProperties": {} }, "type": "array" }, "date_of_birth": { "description": "The worker's date of birth.", "type": "string" }, "department": { "description": "The worker's assigned department.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "department_hierarchy": { "description": "List of departments in the department hierarchy. Refer department_hierarchy_ids for department hierarchy order.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestDepartment" }, "type": "array" }, "department_hierarchy_id": { "description": "The identifier of departments in the department hierarchy ordered from parent department to child department.", "items": { "type": "string" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the department.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestDepartment", "description": "The parent department.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent department.", "type": "string" }, "reference_code": { "description": "Reference code of the department.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Department", "type": "object" }, "department_id": { "description": "The worker's assigned department.", "type": "string" }, "employment_type": { "description": "The worker's employment type.\n\nExpandable field", "properties": { "amount_worked": { "description": "The amount worked for the employment type. * `FULL-TIME`: Full-time is at least 30 hours per week. Full-time workers will typically be eligible for benefits. * `PART-TIME`: Part-time is less than 30 hours per week. These workers may be eligible for benefits, depending on company settings and hours worked. * `TEMPORARY`: These workers are hired on a temporary basis. You can specify how each worker with this employment type will be paid individually.", "type": "string" }, "compensation_time_period": { "description": "The compensation period for the employment type. * `SALARIED`: Employees that are paid a fixed amount per year. * `HOURLY`: Employees that are paid a wage per hour worked.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "label": { "description": "The display label of the employment type.", "type": "string" }, "name": { "description": "The name of the employment type for non-custom employment types.", "type": "string" }, "type": { "description": "The classification of the worker by the company. * `CONTRACTOR`: Contractors are self-employed workers who provide services on a short-term or per-project basis and are not eligible for tax-withholding or benefits. * `EMPLOYEE`: Employees are hired and managed by an employer, work under the employer's direct supervision and control, and are protected by law for wages and employment rights.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "label", "updated_at" ], "title": "CompanyEmploymentType", "type": "object" }, "employment_type_id": { "description": "The worker's employment type.", "type": "string" }, "end_date": { "description": "The end date of the worker.", "type": "string" }, "ethnicity": { "description": "The identified ethnicity of the worker, if specified.", "type": "string" }, "gender": { "description": "The gender of the worker, if specified.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_manager": { "description": "Whether the worker is a manager", "type": "boolean" }, "job_function": { "description": "The worker's job function. When expanded, this field requires `job-functions.read`.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "Displayed name of the job function", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "JobFunction", "type": "object" }, "job_function_id": { "description": "ID of the worker's job function.", "type": "string" }, "legal_entity": { "description": "The worker's associated legal entity.\n\nExpandable field", "properties": { "company": { "description": "The company or organization associated with the legal entity\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "doing_business_as_name": { "description": "The doing business as name for the company.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_entities": { "description": "A list of the company's entities.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestLegalEntity" }, "type": "array" }, "legal_entities_id": { "description": "A list of the company's entities.", "items": { "type": "string" }, "type": "array" }, "legal_name": { "description": "The legal name of the company.", "type": "string" }, "name": { "description": "The name of the company.", "type": "string" }, "parent_legal_entity": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The company's ultimate holding entity.\n\nExpandable field", "type": "object" }, "parent_legal_entity_id": { "description": "The company's ultimate holding entity.", "type": "string" }, "phone": { "description": "The phone number for the company.", "type": "string" }, "physical_address": { "description": "The physical address of the holding entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "primary_email": { "description": "The email address used when registering this company.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "legal_entities", "legal_entities_id", "name", "updated_at" ], "title": "Company", "type": "object" }, "company_id": { "description": "The company or organization associated with the legal entity", "type": "string" }, "country": { "description": "The country the legal entity is based in.", "properties": { "code": { "description": "The code of the country.", "type": "string" } }, "required": [ "code" ], "title": "Country", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "entity_level": { "description": "The legal entity's level in a hierarchy. * `PARENT`: The legal entity is considered the ultimate holding entity. * `SUBSIDIARY`: The legal entity is considered a subsidiary, fully or partially held by another. * `BRANCH`: The legal entity is considered a branch, associated with a parent legal entity.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_name": { "description": "The legal name of the legal entity.", "type": "string" }, "mailing_address": { "description": "The mailing address of the legal entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "management_type": { "description": "The legal entity management type in the case of an employer of record (EOR) or professional employment organization (PEO). * `PEO`: The legal entity is considered a Professional Employment Organization (PEO). * `EOR`: The legal entity is considered an Employer of Record (EOR).", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The parent legal entity.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent legal entity.", "type": "string" }, "physical_address": { "description": "The physical address of the legal entity, if it differs from the mailing address.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "registration_date": { "description": "The registration date of the entity.", "type": "string" }, "tax_identifier": { "description": "The tax identifier for the legal entity.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "LegalEntity", "type": "object" }, "legal_entity_id": { "description": "The worker's associated legal entity.", "type": "string" }, "level": { "description": "The level of the worker.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "description": { "description": "The description of the level.", "type": "string" }, "experience_requirements": { "description": "The experience requirements for the level.", "type": "string" }, "global_level": { "anyOf": [ { "description": "Global level is used to track the seniority of levels. The higher up a level is placed on the page, the more senior and higher-ranked the level. Global level is used in workflows, policies, and reports that use the level attribute (e.g., you can use Level Lookup to set up a workflow that notifies the nearest person in an worker's management chain at or above the specified level).", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the level. Must be unique within the company or organization.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLevel", "description": "The parent level.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent level.", "type": "string" }, "rank": { "anyOf": [ { "description": "The rank of the level within its track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "scope_of_responsibilities": { "description": "The scope of responsibilities for the level.", "type": "string" }, "track": { "description": "The track associated with the level, if it's not a global level.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_default": { "description": "Whether this is the company's default track.", "type": "boolean" }, "name": { "description": "The name of the track. Must be unique within the company or organization.", "type": "string" }, "order": { "anyOf": [ { "description": "The one-based horizontal display order of the track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "start_global_level": { "anyOf": [ { "description": "The highest global level occupied by this track. Empty tracks return null.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Track", "type": "object" }, "track_id": { "description": "The track associated with the level. Required during creation. Include global_level when changing it.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Level", "type": "object" }, "level_id": { "description": "The level of the worker.", "type": "string" }, "location": { "description": "The location that the worker is mapped to for tax purposes. In the case that a worker is remote, the location's type is remote.", "properties": { "type": { "description": "The type of location.", "type": "string" }, "work_location_id": { "description": "The work location, if the worker isn't remote.", "type": "string" } }, "required": [ "type", "work_location_id" ], "title": "WorkerLocation", "type": "object" }, "manager": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's manager.\n\nExpandable field", "type": "object" }, "manager_id": { "description": "The worker's manager.", "type": "string" }, "number": { "anyOf": [ { "description": "The worker's number within the organization.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "original_start_date": { "description": "The worker's earliest start date across their employment history, excluding INIT roles.", "type": "string" }, "overtime_exemption": { "description": "The worker's overtime exemption status.", "type": "string" }, "pay_schedule_id": { "description": "The ID of the pay schedule currently associated with the worker.", "type": "string" }, "personal_email": { "description": "The worker's associated personal email address.", "type": "string" }, "race": { "description": "The identified race of the worker, if specified.", "type": "string" }, "start_date": { "description": "The start date of the worker.", "type": "string" }, "status": { "description": "The worker's status within the organization.", "type": "string" }, "teams": { "description": "The worker's assigned teams.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiTeamcb26bc28f32f" }, "type": "array" }, "teams_id": { "description": "The worker's assigned teams.", "items": { "type": "string" }, "type": "array" }, "termination_details": { "description": "The details of the worker's termination, if applicable.", "properties": { "reason": { "description": "This is a description that will be custom to each Rippling company.", "type": "string" }, "type": { "description": "The termination type indicates whether the termination was voluntary or involuntary.", "type": "string" } }, "title": "TerminationDetails", "type": "object" }, "title": { "description": "The worker's title.", "type": "string" }, "title_effective_date": { "description": "Title effective date", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "user": { "description": "The worker's associated user.\n\nExpandable field", "properties": { "active": { "description": "Whether the user is able to access company resources, typically when they are in actively engaged with the company and not after off-boarding.", "type": "boolean" }, "addresses": { "description": "The user's addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiUserAddressedd59b9ba9a1" }, "type": "array" }, "created_at": { "description": "Record creation date", "type": "string" }, "display_name": { "description": "The display name of the user using either the concatenated preferred given and family name or username depending on availability.", "type": "string" }, "emails": { "description": "The user's email addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiEmail5284c8258dc3" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "locale": { "description": "The User's default location for purposes of localization of currency, date time format, or numerical representations pursuant to RFC5646.", "type": "string" }, "name": { "description": "The user's name.", "properties": { "family_name": { "description": "The legal family name of the user, or last name in most Western languages.", "type": "string" }, "formatted": { "description": "The user's full name.", "type": "string" }, "given_name": { "description": "The given legal name of the user, or first name in most Western languages.", "type": "string" }, "middle_name": { "description": "The middle name(s) of the user.", "type": "string" }, "preferred_family_name": { "description": "The preferred family name, or last name in most Western languages, by the user.", "type": "string" }, "preferred_given_name": { "description": "The preferred given name, or first name in most Western languages, by the user.", "type": "string" } }, "title": "UserName", "type": "object" }, "number": { "description": "The permanent profile number of the user.", "type": "string" }, "phone_numbers": { "description": "The user's phone numbers.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoneNumber12060c61ecf5" }, "type": "array" }, "photos": { "description": "The user's photos.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoto2be7c3ae3f39" }, "type": "array" }, "preferred_language": { "description": "The User's preferred written or spoken language in the same format of the HTTP Accept-Language header, pursuant to Section 5.3.5 of RFC7231.", "type": "string" }, "timezone": { "description": "The User's current time zone in IANA database Olson format", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "username": { "description": "The unique identifier across Rippling used by the User for direct authentication into their associated company. Globally unique.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "User", "type": "object" }, "user_id": { "description": "The worker's associated user.", "type": "string" }, "work_email": { "description": "The worker's associated work email address.", "type": "string" }, "work_schedule": { "additionalProperties": { "$ref": "#/components/schemas/OutputRestApiWorkScheduleDay938f88d94f20" }, "description": "The worker's scheduled working hours for each day of the week.", "type": "object" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Worker", "type": "object" }, "worker_id": { "description": "The ID of the worker associated with the badge.", "type": "string" }, "worker_number": { "anyOf": [ { "description": "The employee number of the worker associated with the badge.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "required": [ "badge_id", "created_at", "id", "updated_at" ], "title": "TimeKioskBadge", "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Update a kiosk badge", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "kiosk-badges.read-write" ] } }, "/leave-accruals/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/list-leave-accruals" }, "operationId": "rippling.rest_api.list_leave_accruals", "parameters": [ { "in": "query", "name": "filter", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "expand", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 100, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "__meta": { "$ref": "#/components/schemas/OutputRestApiRedactedFields9f7657dc2a2f" }, "next_link": { "description": "A link to the next page of responses.", "format": "uri", "type": "string" }, "results": { "items": { "$ref": "#/components/schemas/OutputRestApiLeaveAccruald674b7ad5007" }, "type": "array" } }, "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "List leave accruals", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "leave-accruals.read" ] }, "post": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/create-leave-accruals" }, "operationId": "rippling.rest_api.create_leave_accruals", "parameters": [ { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiLeaveAccrualRequest9c3376b9cdef" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "\n Leave accrual resource representing time off credits granted to employees.\n\n Leave accruals track the allocation of paid time off (vacation, sick days, etc.)\n to employees based on company policies, manual grants, or other accrual sources.\n ", "properties": { "accrual_date": { "description": "The date when this accrual becomes effective", "type": "string" }, "accrual_type": { "description": "The type of accrual", "type": "string" }, "comment": { "description": "The comment for this accrual. This is required if the leave policy requires a comment on accruals.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "expiration_date": { "description": "The date when this accrual expires (if applicable)", "type": "string" }, "grantor": { "description": "The worker who granted this accrual. This is typically the Time Off admin.\n\nExpandable field", "properties": { "business_partners": { "description": "Worker's assigned business partners. This field is only populated when explicitly requested via the expand parameter (e.g., ?expand=business_partners). When expanded, returns an empty list ([]) if the worker has no business partners.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiBusinessPartner77b00a069c32" }, "type": "array" }, "business_partners_id": { "description": "Worker's assigned business partners unique identifiers. Returns an empty list ([]) if the worker has no business partners.", "items": { "type": "string" }, "type": "array" }, "citizenship": { "description": "The countries that the worker has citizenship in.", "type": "string" }, "compensation": { "description": "The compensation package for the worker.\n\nExpandable field", "properties": { "annual_compensation": { "description": "The worker's annual compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "annual_salary_equivalent": { "description": "The worker's annual salary equivalent, for insurance purposes. It will be equal to the worker's annual compensation, except for owners that are receiving no cashcompensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "bonus_schedule": { "description": "The worker's bonus schedule.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "hourly_wage": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "id": { "description": "Identifier field", "type": "string" }, "monthly_compensation": { "description": "The worker's monthly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "on_target_commission": { "description": "The worker's on-target commission.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "payment_terms": { "description": "The payment terms for an worker's compensation.", "type": "string" }, "payment_type": { "description": "The payment type for an worker's compensation.", "type": "string" }, "relocation_reimbursement": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "salary_effective_date": { "description": "Salary effective date", "type": "string" }, "signing_bonus": { "description": "The worker's signing bonus.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus": { "description": "The worker's target annual bonus amount.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus_percent": { "anyOf": [ { "description": "The worker's target annual bonus as a percent of annual compensation.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" }, "weekly_compensation": { "description": "The worker's weekly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "worker": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's details.\n\nExpandable field", "type": "object" }, "worker_id": { "description": "The worker's ID.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Compensation", "type": "object" }, "compensation_grade": { "description": "The compensation grade assigned to the worker, if any.", "properties": { "id": { "description": "The compensation grade's unique identifier.", "type": "string" }, "label": { "description": "The compensation grade's label.", "type": "string" } }, "title": "WorkerCompensationGrade", "type": "object" }, "compensation_id": { "description": "The compensation package for the worker.", "type": "string" }, "country": { "description": "The worker's country.", "type": "string" }, "country_fields": { "description": "Country level fields for the worker.", "properties": { "ca": { "description": "Country-wise regional fields for Canada", "properties": { "sin": { "description": "Social Insurance Number (SIN) for Canada employees.", "type": "string" } }, "title": "CanadaFields", "type": "object" }, "nz": { "description": "Country-wise regional fields for New Zealand", "properties": { "ird_number": { "description": "Inland Revenue Department (IRD) number for New Zealand employees.", "type": "string" } }, "title": "NewZealandFields", "type": "object" }, "us": { "description": "Country-wise regional fields for USA", "properties": { "ssn": { "description": "Social Security Number (SSN) for US employees.", "type": "string" } }, "title": "USFields", "type": "object" } }, "title": "CountryFields", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "custom_fields": { "description": "Custom field values defined on the Employee object for this worker\n\nExpandable field", "items": { "additionalProperties": {} }, "type": "array" }, "date_of_birth": { "description": "The worker's date of birth.", "type": "string" }, "department": { "description": "The worker's assigned department.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "department_hierarchy": { "description": "List of departments in the department hierarchy. Refer department_hierarchy_ids for department hierarchy order.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestDepartment" }, "type": "array" }, "department_hierarchy_id": { "description": "The identifier of departments in the department hierarchy ordered from parent department to child department.", "items": { "type": "string" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the department.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestDepartment", "description": "The parent department.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent department.", "type": "string" }, "reference_code": { "description": "Reference code of the department.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Department", "type": "object" }, "department_id": { "description": "The worker's assigned department.", "type": "string" }, "employment_type": { "description": "The worker's employment type.\n\nExpandable field", "properties": { "amount_worked": { "description": "The amount worked for the employment type. * `FULL-TIME`: Full-time is at least 30 hours per week. Full-time workers will typically be eligible for benefits. * `PART-TIME`: Part-time is less than 30 hours per week. These workers may be eligible for benefits, depending on company settings and hours worked. * `TEMPORARY`: These workers are hired on a temporary basis. You can specify how each worker with this employment type will be paid individually.", "type": "string" }, "compensation_time_period": { "description": "The compensation period for the employment type. * `SALARIED`: Employees that are paid a fixed amount per year. * `HOURLY`: Employees that are paid a wage per hour worked.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "label": { "description": "The display label of the employment type.", "type": "string" }, "name": { "description": "The name of the employment type for non-custom employment types.", "type": "string" }, "type": { "description": "The classification of the worker by the company. * `CONTRACTOR`: Contractors are self-employed workers who provide services on a short-term or per-project basis and are not eligible for tax-withholding or benefits. * `EMPLOYEE`: Employees are hired and managed by an employer, work under the employer's direct supervision and control, and are protected by law for wages and employment rights.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "label", "updated_at" ], "title": "CompanyEmploymentType", "type": "object" }, "employment_type_id": { "description": "The worker's employment type.", "type": "string" }, "end_date": { "description": "The end date of the worker.", "type": "string" }, "ethnicity": { "description": "The identified ethnicity of the worker, if specified.", "type": "string" }, "gender": { "description": "The gender of the worker, if specified.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_manager": { "description": "Whether the worker is a manager", "type": "boolean" }, "job_function": { "description": "The worker's job function. When expanded, this field requires `job-functions.read`.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "Displayed name of the job function", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "JobFunction", "type": "object" }, "job_function_id": { "description": "ID of the worker's job function.", "type": "string" }, "legal_entity": { "description": "The worker's associated legal entity.\n\nExpandable field", "properties": { "company": { "description": "The company or organization associated with the legal entity\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "doing_business_as_name": { "description": "The doing business as name for the company.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_entities": { "description": "A list of the company's entities.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestLegalEntity" }, "type": "array" }, "legal_entities_id": { "description": "A list of the company's entities.", "items": { "type": "string" }, "type": "array" }, "legal_name": { "description": "The legal name of the company.", "type": "string" }, "name": { "description": "The name of the company.", "type": "string" }, "parent_legal_entity": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The company's ultimate holding entity.\n\nExpandable field", "type": "object" }, "parent_legal_entity_id": { "description": "The company's ultimate holding entity.", "type": "string" }, "phone": { "description": "The phone number for the company.", "type": "string" }, "physical_address": { "description": "The physical address of the holding entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "primary_email": { "description": "The email address used when registering this company.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "legal_entities", "legal_entities_id", "name", "updated_at" ], "title": "Company", "type": "object" }, "company_id": { "description": "The company or organization associated with the legal entity", "type": "string" }, "country": { "description": "The country the legal entity is based in.", "properties": { "code": { "description": "The code of the country.", "type": "string" } }, "required": [ "code" ], "title": "Country", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "entity_level": { "description": "The legal entity's level in a hierarchy. * `PARENT`: The legal entity is considered the ultimate holding entity. * `SUBSIDIARY`: The legal entity is considered a subsidiary, fully or partially held by another. * `BRANCH`: The legal entity is considered a branch, associated with a parent legal entity.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_name": { "description": "The legal name of the legal entity.", "type": "string" }, "mailing_address": { "description": "The mailing address of the legal entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "management_type": { "description": "The legal entity management type in the case of an employer of record (EOR) or professional employment organization (PEO). * `PEO`: The legal entity is considered a Professional Employment Organization (PEO). * `EOR`: The legal entity is considered an Employer of Record (EOR).", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The parent legal entity.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent legal entity.", "type": "string" }, "physical_address": { "description": "The physical address of the legal entity, if it differs from the mailing address.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "registration_date": { "description": "The registration date of the entity.", "type": "string" }, "tax_identifier": { "description": "The tax identifier for the legal entity.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "LegalEntity", "type": "object" }, "legal_entity_id": { "description": "The worker's associated legal entity.", "type": "string" }, "level": { "description": "The level of the worker.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "description": { "description": "The description of the level.", "type": "string" }, "experience_requirements": { "description": "The experience requirements for the level.", "type": "string" }, "global_level": { "anyOf": [ { "description": "Global level is used to track the seniority of levels. The higher up a level is placed on the page, the more senior and higher-ranked the level. Global level is used in workflows, policies, and reports that use the level attribute (e.g., you can use Level Lookup to set up a workflow that notifies the nearest person in an worker's management chain at or above the specified level).", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the level. Must be unique within the company or organization.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLevel", "description": "The parent level.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent level.", "type": "string" }, "rank": { "anyOf": [ { "description": "The rank of the level within its track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "scope_of_responsibilities": { "description": "The scope of responsibilities for the level.", "type": "string" }, "track": { "description": "The track associated with the level, if it's not a global level.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_default": { "description": "Whether this is the company's default track.", "type": "boolean" }, "name": { "description": "The name of the track. Must be unique within the company or organization.", "type": "string" }, "order": { "anyOf": [ { "description": "The one-based horizontal display order of the track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "start_global_level": { "anyOf": [ { "description": "The highest global level occupied by this track. Empty tracks return null.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Track", "type": "object" }, "track_id": { "description": "The track associated with the level. Required during creation. Include global_level when changing it.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Level", "type": "object" }, "level_id": { "description": "The level of the worker.", "type": "string" }, "location": { "description": "The location that the worker is mapped to for tax purposes. In the case that a worker is remote, the location's type is remote.", "properties": { "type": { "description": "The type of location.", "type": "string" }, "work_location_id": { "description": "The work location, if the worker isn't remote.", "type": "string" } }, "required": [ "type", "work_location_id" ], "title": "WorkerLocation", "type": "object" }, "manager": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's manager.\n\nExpandable field", "type": "object" }, "manager_id": { "description": "The worker's manager.", "type": "string" }, "number": { "anyOf": [ { "description": "The worker's number within the organization.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "original_start_date": { "description": "The worker's earliest start date across their employment history, excluding INIT roles.", "type": "string" }, "overtime_exemption": { "description": "The worker's overtime exemption status.", "type": "string" }, "pay_schedule_id": { "description": "The ID of the pay schedule currently associated with the worker.", "type": "string" }, "personal_email": { "description": "The worker's associated personal email address.", "type": "string" }, "race": { "description": "The identified race of the worker, if specified.", "type": "string" }, "start_date": { "description": "The start date of the worker.", "type": "string" }, "status": { "description": "The worker's status within the organization.", "type": "string" }, "teams": { "description": "The worker's assigned teams.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiTeamcb26bc28f32f" }, "type": "array" }, "teams_id": { "description": "The worker's assigned teams.", "items": { "type": "string" }, "type": "array" }, "termination_details": { "description": "The details of the worker's termination, if applicable.", "properties": { "reason": { "description": "This is a description that will be custom to each Rippling company.", "type": "string" }, "type": { "description": "The termination type indicates whether the termination was voluntary or involuntary.", "type": "string" } }, "title": "TerminationDetails", "type": "object" }, "title": { "description": "The worker's title.", "type": "string" }, "title_effective_date": { "description": "Title effective date", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "user": { "description": "The worker's associated user.\n\nExpandable field", "properties": { "active": { "description": "Whether the user is able to access company resources, typically when they are in actively engaged with the company and not after off-boarding.", "type": "boolean" }, "addresses": { "description": "The user's addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiUserAddressedd59b9ba9a1" }, "type": "array" }, "created_at": { "description": "Record creation date", "type": "string" }, "display_name": { "description": "The display name of the user using either the concatenated preferred given and family name or username depending on availability.", "type": "string" }, "emails": { "description": "The user's email addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiEmail5284c8258dc3" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "locale": { "description": "The User's default location for purposes of localization of currency, date time format, or numerical representations pursuant to RFC5646.", "type": "string" }, "name": { "description": "The user's name.", "properties": { "family_name": { "description": "The legal family name of the user, or last name in most Western languages.", "type": "string" }, "formatted": { "description": "The user's full name.", "type": "string" }, "given_name": { "description": "The given legal name of the user, or first name in most Western languages.", "type": "string" }, "middle_name": { "description": "The middle name(s) of the user.", "type": "string" }, "preferred_family_name": { "description": "The preferred family name, or last name in most Western languages, by the user.", "type": "string" }, "preferred_given_name": { "description": "The preferred given name, or first name in most Western languages, by the user.", "type": "string" } }, "title": "UserName", "type": "object" }, "number": { "description": "The permanent profile number of the user.", "type": "string" }, "phone_numbers": { "description": "The user's phone numbers.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoneNumber12060c61ecf5" }, "type": "array" }, "photos": { "description": "The user's photos.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoto2be7c3ae3f39" }, "type": "array" }, "preferred_language": { "description": "The User's preferred written or spoken language in the same format of the HTTP Accept-Language header, pursuant to Section 5.3.5 of RFC7231.", "type": "string" }, "timezone": { "description": "The User's current time zone in IANA database Olson format", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "username": { "description": "The unique identifier across Rippling used by the User for direct authentication into their associated company. Globally unique.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "User", "type": "object" }, "user_id": { "description": "The worker's associated user.", "type": "string" }, "work_email": { "description": "The worker's associated work email address.", "type": "string" }, "work_schedule": { "additionalProperties": { "$ref": "#/components/schemas/OutputRestApiWorkScheduleDay938f88d94f20" }, "description": "The worker's scheduled working hours for each day of the week.", "type": "object" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Worker", "type": "object" }, "grantor_id": { "description": "The ID of the worker who granted this accrual. This is typically the Time Off admin.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "leave_type_id": { "description": "The company leave type ID associated with this accrual", "type": "string" }, "monetary_amount_accrued": { "anyOf": [ { "description": "The monetary value of this accrual (for policies with monetary tracking)", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "num_days": { "anyOf": [ { "description": "The number of days accrued. It can be negative for deductions. This is applicable if the policy tracks in days.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "num_hours": { "anyOf": [ { "description": "The number of hours accrued. It can be negative for deductions. This is applicable if the policy tracks in hours.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" }, "worker": { "description": "The worker for whom the accrual is for\n\nExpandable field", "properties": { "business_partners": { "description": "Worker's assigned business partners. This field is only populated when explicitly requested via the expand parameter (e.g., ?expand=business_partners). When expanded, returns an empty list ([]) if the worker has no business partners.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiBusinessPartner77b00a069c32" }, "type": "array" }, "business_partners_id": { "description": "Worker's assigned business partners unique identifiers. Returns an empty list ([]) if the worker has no business partners.", "items": { "type": "string" }, "type": "array" }, "citizenship": { "description": "The countries that the worker has citizenship in.", "type": "string" }, "compensation": { "description": "The compensation package for the worker.\n\nExpandable field", "properties": { "annual_compensation": { "description": "The worker's annual compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "annual_salary_equivalent": { "description": "The worker's annual salary equivalent, for insurance purposes. It will be equal to the worker's annual compensation, except for owners that are receiving no cashcompensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "bonus_schedule": { "description": "The worker's bonus schedule.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "hourly_wage": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "id": { "description": "Identifier field", "type": "string" }, "monthly_compensation": { "description": "The worker's monthly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "on_target_commission": { "description": "The worker's on-target commission.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "payment_terms": { "description": "The payment terms for an worker's compensation.", "type": "string" }, "payment_type": { "description": "The payment type for an worker's compensation.", "type": "string" }, "relocation_reimbursement": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "salary_effective_date": { "description": "Salary effective date", "type": "string" }, "signing_bonus": { "description": "The worker's signing bonus.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus": { "description": "The worker's target annual bonus amount.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus_percent": { "anyOf": [ { "description": "The worker's target annual bonus as a percent of annual compensation.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" }, "weekly_compensation": { "description": "The worker's weekly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "worker": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's details.\n\nExpandable field", "type": "object" }, "worker_id": { "description": "The worker's ID.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Compensation", "type": "object" }, "compensation_grade": { "description": "The compensation grade assigned to the worker, if any.", "properties": { "id": { "description": "The compensation grade's unique identifier.", "type": "string" }, "label": { "description": "The compensation grade's label.", "type": "string" } }, "title": "WorkerCompensationGrade", "type": "object" }, "compensation_id": { "description": "The compensation package for the worker.", "type": "string" }, "country": { "description": "The worker's country.", "type": "string" }, "country_fields": { "description": "Country level fields for the worker.", "properties": { "ca": { "description": "Country-wise regional fields for Canada", "properties": { "sin": { "description": "Social Insurance Number (SIN) for Canada employees.", "type": "string" } }, "title": "CanadaFields", "type": "object" }, "nz": { "description": "Country-wise regional fields for New Zealand", "properties": { "ird_number": { "description": "Inland Revenue Department (IRD) number for New Zealand employees.", "type": "string" } }, "title": "NewZealandFields", "type": "object" }, "us": { "description": "Country-wise regional fields for USA", "properties": { "ssn": { "description": "Social Security Number (SSN) for US employees.", "type": "string" } }, "title": "USFields", "type": "object" } }, "title": "CountryFields", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "custom_fields": { "description": "Custom field values defined on the Employee object for this worker\n\nExpandable field", "items": { "additionalProperties": {} }, "type": "array" }, "date_of_birth": { "description": "The worker's date of birth.", "type": "string" }, "department": { "description": "The worker's assigned department.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "department_hierarchy": { "description": "List of departments in the department hierarchy. Refer department_hierarchy_ids for department hierarchy order.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestDepartment" }, "type": "array" }, "department_hierarchy_id": { "description": "The identifier of departments in the department hierarchy ordered from parent department to child department.", "items": { "type": "string" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the department.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestDepartment", "description": "The parent department.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent department.", "type": "string" }, "reference_code": { "description": "Reference code of the department.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Department", "type": "object" }, "department_id": { "description": "The worker's assigned department.", "type": "string" }, "employment_type": { "description": "The worker's employment type.\n\nExpandable field", "properties": { "amount_worked": { "description": "The amount worked for the employment type. * `FULL-TIME`: Full-time is at least 30 hours per week. Full-time workers will typically be eligible for benefits. * `PART-TIME`: Part-time is less than 30 hours per week. These workers may be eligible for benefits, depending on company settings and hours worked. * `TEMPORARY`: These workers are hired on a temporary basis. You can specify how each worker with this employment type will be paid individually.", "type": "string" }, "compensation_time_period": { "description": "The compensation period for the employment type. * `SALARIED`: Employees that are paid a fixed amount per year. * `HOURLY`: Employees that are paid a wage per hour worked.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "label": { "description": "The display label of the employment type.", "type": "string" }, "name": { "description": "The name of the employment type for non-custom employment types.", "type": "string" }, "type": { "description": "The classification of the worker by the company. * `CONTRACTOR`: Contractors are self-employed workers who provide services on a short-term or per-project basis and are not eligible for tax-withholding or benefits. * `EMPLOYEE`: Employees are hired and managed by an employer, work under the employer's direct supervision and control, and are protected by law for wages and employment rights.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "label", "updated_at" ], "title": "CompanyEmploymentType", "type": "object" }, "employment_type_id": { "description": "The worker's employment type.", "type": "string" }, "end_date": { "description": "The end date of the worker.", "type": "string" }, "ethnicity": { "description": "The identified ethnicity of the worker, if specified.", "type": "string" }, "gender": { "description": "The gender of the worker, if specified.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_manager": { "description": "Whether the worker is a manager", "type": "boolean" }, "job_function": { "description": "The worker's job function. When expanded, this field requires `job-functions.read`.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "Displayed name of the job function", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "JobFunction", "type": "object" }, "job_function_id": { "description": "ID of the worker's job function.", "type": "string" }, "legal_entity": { "description": "The worker's associated legal entity.\n\nExpandable field", "properties": { "company": { "description": "The company or organization associated with the legal entity\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "doing_business_as_name": { "description": "The doing business as name for the company.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_entities": { "description": "A list of the company's entities.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestLegalEntity" }, "type": "array" }, "legal_entities_id": { "description": "A list of the company's entities.", "items": { "type": "string" }, "type": "array" }, "legal_name": { "description": "The legal name of the company.", "type": "string" }, "name": { "description": "The name of the company.", "type": "string" }, "parent_legal_entity": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The company's ultimate holding entity.\n\nExpandable field", "type": "object" }, "parent_legal_entity_id": { "description": "The company's ultimate holding entity.", "type": "string" }, "phone": { "description": "The phone number for the company.", "type": "string" }, "physical_address": { "description": "The physical address of the holding entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "primary_email": { "description": "The email address used when registering this company.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "legal_entities", "legal_entities_id", "name", "updated_at" ], "title": "Company", "type": "object" }, "company_id": { "description": "The company or organization associated with the legal entity", "type": "string" }, "country": { "description": "The country the legal entity is based in.", "properties": { "code": { "description": "The code of the country.", "type": "string" } }, "required": [ "code" ], "title": "Country", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "entity_level": { "description": "The legal entity's level in a hierarchy. * `PARENT`: The legal entity is considered the ultimate holding entity. * `SUBSIDIARY`: The legal entity is considered a subsidiary, fully or partially held by another. * `BRANCH`: The legal entity is considered a branch, associated with a parent legal entity.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_name": { "description": "The legal name of the legal entity.", "type": "string" }, "mailing_address": { "description": "The mailing address of the legal entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "management_type": { "description": "The legal entity management type in the case of an employer of record (EOR) or professional employment organization (PEO). * `PEO`: The legal entity is considered a Professional Employment Organization (PEO). * `EOR`: The legal entity is considered an Employer of Record (EOR).", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The parent legal entity.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent legal entity.", "type": "string" }, "physical_address": { "description": "The physical address of the legal entity, if it differs from the mailing address.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "registration_date": { "description": "The registration date of the entity.", "type": "string" }, "tax_identifier": { "description": "The tax identifier for the legal entity.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "LegalEntity", "type": "object" }, "legal_entity_id": { "description": "The worker's associated legal entity.", "type": "string" }, "level": { "description": "The level of the worker.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "description": { "description": "The description of the level.", "type": "string" }, "experience_requirements": { "description": "The experience requirements for the level.", "type": "string" }, "global_level": { "anyOf": [ { "description": "Global level is used to track the seniority of levels. The higher up a level is placed on the page, the more senior and higher-ranked the level. Global level is used in workflows, policies, and reports that use the level attribute (e.g., you can use Level Lookup to set up a workflow that notifies the nearest person in an worker's management chain at or above the specified level).", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the level. Must be unique within the company or organization.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLevel", "description": "The parent level.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent level.", "type": "string" }, "rank": { "anyOf": [ { "description": "The rank of the level within its track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "scope_of_responsibilities": { "description": "The scope of responsibilities for the level.", "type": "string" }, "track": { "description": "The track associated with the level, if it's not a global level.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_default": { "description": "Whether this is the company's default track.", "type": "boolean" }, "name": { "description": "The name of the track. Must be unique within the company or organization.", "type": "string" }, "order": { "anyOf": [ { "description": "The one-based horizontal display order of the track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "start_global_level": { "anyOf": [ { "description": "The highest global level occupied by this track. Empty tracks return null.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Track", "type": "object" }, "track_id": { "description": "The track associated with the level. Required during creation. Include global_level when changing it.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Level", "type": "object" }, "level_id": { "description": "The level of the worker.", "type": "string" }, "location": { "description": "The location that the worker is mapped to for tax purposes. In the case that a worker is remote, the location's type is remote.", "properties": { "type": { "description": "The type of location.", "type": "string" }, "work_location_id": { "description": "The work location, if the worker isn't remote.", "type": "string" } }, "required": [ "type", "work_location_id" ], "title": "WorkerLocation", "type": "object" }, "manager": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's manager.\n\nExpandable field", "type": "object" }, "manager_id": { "description": "The worker's manager.", "type": "string" }, "number": { "anyOf": [ { "description": "The worker's number within the organization.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "original_start_date": { "description": "The worker's earliest start date across their employment history, excluding INIT roles.", "type": "string" }, "overtime_exemption": { "description": "The worker's overtime exemption status.", "type": "string" }, "pay_schedule_id": { "description": "The ID of the pay schedule currently associated with the worker.", "type": "string" }, "personal_email": { "description": "The worker's associated personal email address.", "type": "string" }, "race": { "description": "The identified race of the worker, if specified.", "type": "string" }, "start_date": { "description": "The start date of the worker.", "type": "string" }, "status": { "description": "The worker's status within the organization.", "type": "string" }, "teams": { "description": "The worker's assigned teams.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiTeamcb26bc28f32f" }, "type": "array" }, "teams_id": { "description": "The worker's assigned teams.", "items": { "type": "string" }, "type": "array" }, "termination_details": { "description": "The details of the worker's termination, if applicable.", "properties": { "reason": { "description": "This is a description that will be custom to each Rippling company.", "type": "string" }, "type": { "description": "The termination type indicates whether the termination was voluntary or involuntary.", "type": "string" } }, "title": "TerminationDetails", "type": "object" }, "title": { "description": "The worker's title.", "type": "string" }, "title_effective_date": { "description": "Title effective date", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "user": { "description": "The worker's associated user.\n\nExpandable field", "properties": { "active": { "description": "Whether the user is able to access company resources, typically when they are in actively engaged with the company and not after off-boarding.", "type": "boolean" }, "addresses": { "description": "The user's addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiUserAddressedd59b9ba9a1" }, "type": "array" }, "created_at": { "description": "Record creation date", "type": "string" }, "display_name": { "description": "The display name of the user using either the concatenated preferred given and family name or username depending on availability.", "type": "string" }, "emails": { "description": "The user's email addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiEmail5284c8258dc3" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "locale": { "description": "The User's default location for purposes of localization of currency, date time format, or numerical representations pursuant to RFC5646.", "type": "string" }, "name": { "description": "The user's name.", "properties": { "family_name": { "description": "The legal family name of the user, or last name in most Western languages.", "type": "string" }, "formatted": { "description": "The user's full name.", "type": "string" }, "given_name": { "description": "The given legal name of the user, or first name in most Western languages.", "type": "string" }, "middle_name": { "description": "The middle name(s) of the user.", "type": "string" }, "preferred_family_name": { "description": "The preferred family name, or last name in most Western languages, by the user.", "type": "string" }, "preferred_given_name": { "description": "The preferred given name, or first name in most Western languages, by the user.", "type": "string" } }, "title": "UserName", "type": "object" }, "number": { "description": "The permanent profile number of the user.", "type": "string" }, "phone_numbers": { "description": "The user's phone numbers.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoneNumber12060c61ecf5" }, "type": "array" }, "photos": { "description": "The user's photos.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoto2be7c3ae3f39" }, "type": "array" }, "preferred_language": { "description": "The User's preferred written or spoken language in the same format of the HTTP Accept-Language header, pursuant to Section 5.3.5 of RFC7231.", "type": "string" }, "timezone": { "description": "The User's current time zone in IANA database Olson format", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "username": { "description": "The unique identifier across Rippling used by the User for direct authentication into their associated company. Globally unique.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "User", "type": "object" }, "user_id": { "description": "The worker's associated user.", "type": "string" }, "work_email": { "description": "The worker's associated work email address.", "type": "string" }, "work_schedule": { "additionalProperties": { "$ref": "#/components/schemas/OutputRestApiWorkScheduleDay938f88d94f20" }, "description": "The worker's scheduled working hours for each day of the week.", "type": "object" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Worker", "type": "object" }, "worker_id": { "description": "The ID of the worker for whom the accrual is for", "type": "string" } }, "required": [ "accrual_date", "created_at", "grantor_id", "id", "leave_type_id", "updated_at", "worker_id" ], "title": "LeaveAccrual", "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Create a new leave accrual", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "leave-accruals.read-write" ] } }, "/leave-accruals/{id}/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/get-leave-accruals" }, "operationId": "rippling.rest_api.get_leave_accruals", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "id", "type": "string" } }, { "in": "query", "name": "expand", "required": false, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "__meta": { "properties": { "redacted_fields": { "items": { "$ref": "#/components/schemas/OutputRestApiRedactedField21788a25ef22" }, "type": "array" } }, "type": "object" }, "accrual_date": { "description": "The date when this accrual becomes effective", "type": "string" }, "accrual_type": { "description": "The type of accrual", "type": "string" }, "comment": { "description": "The comment for this accrual. This is required if the leave policy requires a comment on accruals.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "expiration_date": { "description": "The date when this accrual expires (if applicable)", "type": "string" }, "grantor": { "description": "The worker who granted this accrual. This is typically the Time Off admin.\n\nExpandable field", "properties": { "business_partners": { "description": "Worker's assigned business partners. This field is only populated when explicitly requested via the expand parameter (e.g., ?expand=business_partners). When expanded, returns an empty list ([]) if the worker has no business partners.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiBusinessPartner77b00a069c32" }, "type": "array" }, "business_partners_id": { "description": "Worker's assigned business partners unique identifiers. Returns an empty list ([]) if the worker has no business partners.", "items": { "type": "string" }, "type": "array" }, "citizenship": { "description": "The countries that the worker has citizenship in.", "type": "string" }, "compensation": { "description": "The compensation package for the worker.\n\nExpandable field", "properties": { "annual_compensation": { "description": "The worker's annual compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "annual_salary_equivalent": { "description": "The worker's annual salary equivalent, for insurance purposes. It will be equal to the worker's annual compensation, except for owners that are receiving no cashcompensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "bonus_schedule": { "description": "The worker's bonus schedule.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "hourly_wage": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "id": { "description": "Identifier field", "type": "string" }, "monthly_compensation": { "description": "The worker's monthly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "on_target_commission": { "description": "The worker's on-target commission.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "payment_terms": { "description": "The payment terms for an worker's compensation.", "type": "string" }, "payment_type": { "description": "The payment type for an worker's compensation.", "type": "string" }, "relocation_reimbursement": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "salary_effective_date": { "description": "Salary effective date", "type": "string" }, "signing_bonus": { "description": "The worker's signing bonus.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus": { "description": "The worker's target annual bonus amount.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus_percent": { "anyOf": [ { "description": "The worker's target annual bonus as a percent of annual compensation.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" }, "weekly_compensation": { "description": "The worker's weekly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "worker": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's details.\n\nExpandable field", "type": "object" }, "worker_id": { "description": "The worker's ID.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Compensation", "type": "object" }, "compensation_grade": { "description": "The compensation grade assigned to the worker, if any.", "properties": { "id": { "description": "The compensation grade's unique identifier.", "type": "string" }, "label": { "description": "The compensation grade's label.", "type": "string" } }, "title": "WorkerCompensationGrade", "type": "object" }, "compensation_id": { "description": "The compensation package for the worker.", "type": "string" }, "country": { "description": "The worker's country.", "type": "string" }, "country_fields": { "description": "Country level fields for the worker.", "properties": { "ca": { "description": "Country-wise regional fields for Canada", "properties": { "sin": { "description": "Social Insurance Number (SIN) for Canada employees.", "type": "string" } }, "title": "CanadaFields", "type": "object" }, "nz": { "description": "Country-wise regional fields for New Zealand", "properties": { "ird_number": { "description": "Inland Revenue Department (IRD) number for New Zealand employees.", "type": "string" } }, "title": "NewZealandFields", "type": "object" }, "us": { "description": "Country-wise regional fields for USA", "properties": { "ssn": { "description": "Social Security Number (SSN) for US employees.", "type": "string" } }, "title": "USFields", "type": "object" } }, "title": "CountryFields", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "custom_fields": { "description": "Custom field values defined on the Employee object for this worker\n\nExpandable field", "items": { "additionalProperties": {} }, "type": "array" }, "date_of_birth": { "description": "The worker's date of birth.", "type": "string" }, "department": { "description": "The worker's assigned department.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "department_hierarchy": { "description": "List of departments in the department hierarchy. Refer department_hierarchy_ids for department hierarchy order.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestDepartment" }, "type": "array" }, "department_hierarchy_id": { "description": "The identifier of departments in the department hierarchy ordered from parent department to child department.", "items": { "type": "string" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the department.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestDepartment", "description": "The parent department.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent department.", "type": "string" }, "reference_code": { "description": "Reference code of the department.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Department", "type": "object" }, "department_id": { "description": "The worker's assigned department.", "type": "string" }, "employment_type": { "description": "The worker's employment type.\n\nExpandable field", "properties": { "amount_worked": { "description": "The amount worked for the employment type. * `FULL-TIME`: Full-time is at least 30 hours per week. Full-time workers will typically be eligible for benefits. * `PART-TIME`: Part-time is less than 30 hours per week. These workers may be eligible for benefits, depending on company settings and hours worked. * `TEMPORARY`: These workers are hired on a temporary basis. You can specify how each worker with this employment type will be paid individually.", "type": "string" }, "compensation_time_period": { "description": "The compensation period for the employment type. * `SALARIED`: Employees that are paid a fixed amount per year. * `HOURLY`: Employees that are paid a wage per hour worked.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "label": { "description": "The display label of the employment type.", "type": "string" }, "name": { "description": "The name of the employment type for non-custom employment types.", "type": "string" }, "type": { "description": "The classification of the worker by the company. * `CONTRACTOR`: Contractors are self-employed workers who provide services on a short-term or per-project basis and are not eligible for tax-withholding or benefits. * `EMPLOYEE`: Employees are hired and managed by an employer, work under the employer's direct supervision and control, and are protected by law for wages and employment rights.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "label", "updated_at" ], "title": "CompanyEmploymentType", "type": "object" }, "employment_type_id": { "description": "The worker's employment type.", "type": "string" }, "end_date": { "description": "The end date of the worker.", "type": "string" }, "ethnicity": { "description": "The identified ethnicity of the worker, if specified.", "type": "string" }, "gender": { "description": "The gender of the worker, if specified.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_manager": { "description": "Whether the worker is a manager", "type": "boolean" }, "job_function": { "description": "The worker's job function. When expanded, this field requires `job-functions.read`.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "Displayed name of the job function", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "JobFunction", "type": "object" }, "job_function_id": { "description": "ID of the worker's job function.", "type": "string" }, "legal_entity": { "description": "The worker's associated legal entity.\n\nExpandable field", "properties": { "company": { "description": "The company or organization associated with the legal entity\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "doing_business_as_name": { "description": "The doing business as name for the company.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_entities": { "description": "A list of the company's entities.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestLegalEntity" }, "type": "array" }, "legal_entities_id": { "description": "A list of the company's entities.", "items": { "type": "string" }, "type": "array" }, "legal_name": { "description": "The legal name of the company.", "type": "string" }, "name": { "description": "The name of the company.", "type": "string" }, "parent_legal_entity": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The company's ultimate holding entity.\n\nExpandable field", "type": "object" }, "parent_legal_entity_id": { "description": "The company's ultimate holding entity.", "type": "string" }, "phone": { "description": "The phone number for the company.", "type": "string" }, "physical_address": { "description": "The physical address of the holding entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "primary_email": { "description": "The email address used when registering this company.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "legal_entities", "legal_entities_id", "name", "updated_at" ], "title": "Company", "type": "object" }, "company_id": { "description": "The company or organization associated with the legal entity", "type": "string" }, "country": { "description": "The country the legal entity is based in.", "properties": { "code": { "description": "The code of the country.", "type": "string" } }, "required": [ "code" ], "title": "Country", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "entity_level": { "description": "The legal entity's level in a hierarchy. * `PARENT`: The legal entity is considered the ultimate holding entity. * `SUBSIDIARY`: The legal entity is considered a subsidiary, fully or partially held by another. * `BRANCH`: The legal entity is considered a branch, associated with a parent legal entity.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_name": { "description": "The legal name of the legal entity.", "type": "string" }, "mailing_address": { "description": "The mailing address of the legal entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "management_type": { "description": "The legal entity management type in the case of an employer of record (EOR) or professional employment organization (PEO). * `PEO`: The legal entity is considered a Professional Employment Organization (PEO). * `EOR`: The legal entity is considered an Employer of Record (EOR).", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The parent legal entity.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent legal entity.", "type": "string" }, "physical_address": { "description": "The physical address of the legal entity, if it differs from the mailing address.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "registration_date": { "description": "The registration date of the entity.", "type": "string" }, "tax_identifier": { "description": "The tax identifier for the legal entity.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "LegalEntity", "type": "object" }, "legal_entity_id": { "description": "The worker's associated legal entity.", "type": "string" }, "level": { "description": "The level of the worker.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "description": { "description": "The description of the level.", "type": "string" }, "experience_requirements": { "description": "The experience requirements for the level.", "type": "string" }, "global_level": { "anyOf": [ { "description": "Global level is used to track the seniority of levels. The higher up a level is placed on the page, the more senior and higher-ranked the level. Global level is used in workflows, policies, and reports that use the level attribute (e.g., you can use Level Lookup to set up a workflow that notifies the nearest person in an worker's management chain at or above the specified level).", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the level. Must be unique within the company or organization.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLevel", "description": "The parent level.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent level.", "type": "string" }, "rank": { "anyOf": [ { "description": "The rank of the level within its track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "scope_of_responsibilities": { "description": "The scope of responsibilities for the level.", "type": "string" }, "track": { "description": "The track associated with the level, if it's not a global level.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_default": { "description": "Whether this is the company's default track.", "type": "boolean" }, "name": { "description": "The name of the track. Must be unique within the company or organization.", "type": "string" }, "order": { "anyOf": [ { "description": "The one-based horizontal display order of the track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "start_global_level": { "anyOf": [ { "description": "The highest global level occupied by this track. Empty tracks return null.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Track", "type": "object" }, "track_id": { "description": "The track associated with the level. Required during creation. Include global_level when changing it.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Level", "type": "object" }, "level_id": { "description": "The level of the worker.", "type": "string" }, "location": { "description": "The location that the worker is mapped to for tax purposes. In the case that a worker is remote, the location's type is remote.", "properties": { "type": { "description": "The type of location.", "type": "string" }, "work_location_id": { "description": "The work location, if the worker isn't remote.", "type": "string" } }, "required": [ "type", "work_location_id" ], "title": "WorkerLocation", "type": "object" }, "manager": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's manager.\n\nExpandable field", "type": "object" }, "manager_id": { "description": "The worker's manager.", "type": "string" }, "number": { "anyOf": [ { "description": "The worker's number within the organization.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "original_start_date": { "description": "The worker's earliest start date across their employment history, excluding INIT roles.", "type": "string" }, "overtime_exemption": { "description": "The worker's overtime exemption status.", "type": "string" }, "pay_schedule_id": { "description": "The ID of the pay schedule currently associated with the worker.", "type": "string" }, "personal_email": { "description": "The worker's associated personal email address.", "type": "string" }, "race": { "description": "The identified race of the worker, if specified.", "type": "string" }, "start_date": { "description": "The start date of the worker.", "type": "string" }, "status": { "description": "The worker's status within the organization.", "type": "string" }, "teams": { "description": "The worker's assigned teams.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiTeamcb26bc28f32f" }, "type": "array" }, "teams_id": { "description": "The worker's assigned teams.", "items": { "type": "string" }, "type": "array" }, "termination_details": { "description": "The details of the worker's termination, if applicable.", "properties": { "reason": { "description": "This is a description that will be custom to each Rippling company.", "type": "string" }, "type": { "description": "The termination type indicates whether the termination was voluntary or involuntary.", "type": "string" } }, "title": "TerminationDetails", "type": "object" }, "title": { "description": "The worker's title.", "type": "string" }, "title_effective_date": { "description": "Title effective date", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "user": { "description": "The worker's associated user.\n\nExpandable field", "properties": { "active": { "description": "Whether the user is able to access company resources, typically when they are in actively engaged with the company and not after off-boarding.", "type": "boolean" }, "addresses": { "description": "The user's addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiUserAddressedd59b9ba9a1" }, "type": "array" }, "created_at": { "description": "Record creation date", "type": "string" }, "display_name": { "description": "The display name of the user using either the concatenated preferred given and family name or username depending on availability.", "type": "string" }, "emails": { "description": "The user's email addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiEmail5284c8258dc3" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "locale": { "description": "The User's default location for purposes of localization of currency, date time format, or numerical representations pursuant to RFC5646.", "type": "string" }, "name": { "description": "The user's name.", "properties": { "family_name": { "description": "The legal family name of the user, or last name in most Western languages.", "type": "string" }, "formatted": { "description": "The user's full name.", "type": "string" }, "given_name": { "description": "The given legal name of the user, or first name in most Western languages.", "type": "string" }, "middle_name": { "description": "The middle name(s) of the user.", "type": "string" }, "preferred_family_name": { "description": "The preferred family name, or last name in most Western languages, by the user.", "type": "string" }, "preferred_given_name": { "description": "The preferred given name, or first name in most Western languages, by the user.", "type": "string" } }, "title": "UserName", "type": "object" }, "number": { "description": "The permanent profile number of the user.", "type": "string" }, "phone_numbers": { "description": "The user's phone numbers.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoneNumber12060c61ecf5" }, "type": "array" }, "photos": { "description": "The user's photos.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoto2be7c3ae3f39" }, "type": "array" }, "preferred_language": { "description": "The User's preferred written or spoken language in the same format of the HTTP Accept-Language header, pursuant to Section 5.3.5 of RFC7231.", "type": "string" }, "timezone": { "description": "The User's current time zone in IANA database Olson format", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "username": { "description": "The unique identifier across Rippling used by the User for direct authentication into their associated company. Globally unique.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "User", "type": "object" }, "user_id": { "description": "The worker's associated user.", "type": "string" }, "work_email": { "description": "The worker's associated work email address.", "type": "string" }, "work_schedule": { "additionalProperties": { "$ref": "#/components/schemas/OutputRestApiWorkScheduleDay938f88d94f20" }, "description": "The worker's scheduled working hours for each day of the week.", "type": "object" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Worker", "type": "object" }, "grantor_id": { "description": "The ID of the worker who granted this accrual. This is typically the Time Off admin.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "leave_type_id": { "description": "The company leave type ID associated with this accrual", "type": "string" }, "monetary_amount_accrued": { "anyOf": [ { "description": "The monetary value of this accrual (for policies with monetary tracking)", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "num_days": { "anyOf": [ { "description": "The number of days accrued. It can be negative for deductions. This is applicable if the policy tracks in days.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "num_hours": { "anyOf": [ { "description": "The number of hours accrued. It can be negative for deductions. This is applicable if the policy tracks in hours.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" }, "worker": { "description": "The worker for whom the accrual is for\n\nExpandable field", "properties": { "business_partners": { "description": "Worker's assigned business partners. This field is only populated when explicitly requested via the expand parameter (e.g., ?expand=business_partners). When expanded, returns an empty list ([]) if the worker has no business partners.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiBusinessPartner77b00a069c32" }, "type": "array" }, "business_partners_id": { "description": "Worker's assigned business partners unique identifiers. Returns an empty list ([]) if the worker has no business partners.", "items": { "type": "string" }, "type": "array" }, "citizenship": { "description": "The countries that the worker has citizenship in.", "type": "string" }, "compensation": { "description": "The compensation package for the worker.\n\nExpandable field", "properties": { "annual_compensation": { "description": "The worker's annual compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "annual_salary_equivalent": { "description": "The worker's annual salary equivalent, for insurance purposes. It will be equal to the worker's annual compensation, except for owners that are receiving no cashcompensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "bonus_schedule": { "description": "The worker's bonus schedule.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "hourly_wage": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "id": { "description": "Identifier field", "type": "string" }, "monthly_compensation": { "description": "The worker's monthly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "on_target_commission": { "description": "The worker's on-target commission.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "payment_terms": { "description": "The payment terms for an worker's compensation.", "type": "string" }, "payment_type": { "description": "The payment type for an worker's compensation.", "type": "string" }, "relocation_reimbursement": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "salary_effective_date": { "description": "Salary effective date", "type": "string" }, "signing_bonus": { "description": "The worker's signing bonus.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus": { "description": "The worker's target annual bonus amount.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus_percent": { "anyOf": [ { "description": "The worker's target annual bonus as a percent of annual compensation.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" }, "weekly_compensation": { "description": "The worker's weekly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "worker": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's details.\n\nExpandable field", "type": "object" }, "worker_id": { "description": "The worker's ID.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Compensation", "type": "object" }, "compensation_grade": { "description": "The compensation grade assigned to the worker, if any.", "properties": { "id": { "description": "The compensation grade's unique identifier.", "type": "string" }, "label": { "description": "The compensation grade's label.", "type": "string" } }, "title": "WorkerCompensationGrade", "type": "object" }, "compensation_id": { "description": "The compensation package for the worker.", "type": "string" }, "country": { "description": "The worker's country.", "type": "string" }, "country_fields": { "description": "Country level fields for the worker.", "properties": { "ca": { "description": "Country-wise regional fields for Canada", "properties": { "sin": { "description": "Social Insurance Number (SIN) for Canada employees.", "type": "string" } }, "title": "CanadaFields", "type": "object" }, "nz": { "description": "Country-wise regional fields for New Zealand", "properties": { "ird_number": { "description": "Inland Revenue Department (IRD) number for New Zealand employees.", "type": "string" } }, "title": "NewZealandFields", "type": "object" }, "us": { "description": "Country-wise regional fields for USA", "properties": { "ssn": { "description": "Social Security Number (SSN) for US employees.", "type": "string" } }, "title": "USFields", "type": "object" } }, "title": "CountryFields", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "custom_fields": { "description": "Custom field values defined on the Employee object for this worker\n\nExpandable field", "items": { "additionalProperties": {} }, "type": "array" }, "date_of_birth": { "description": "The worker's date of birth.", "type": "string" }, "department": { "description": "The worker's assigned department.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "department_hierarchy": { "description": "List of departments in the department hierarchy. Refer department_hierarchy_ids for department hierarchy order.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestDepartment" }, "type": "array" }, "department_hierarchy_id": { "description": "The identifier of departments in the department hierarchy ordered from parent department to child department.", "items": { "type": "string" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the department.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestDepartment", "description": "The parent department.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent department.", "type": "string" }, "reference_code": { "description": "Reference code of the department.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Department", "type": "object" }, "department_id": { "description": "The worker's assigned department.", "type": "string" }, "employment_type": { "description": "The worker's employment type.\n\nExpandable field", "properties": { "amount_worked": { "description": "The amount worked for the employment type. * `FULL-TIME`: Full-time is at least 30 hours per week. Full-time workers will typically be eligible for benefits. * `PART-TIME`: Part-time is less than 30 hours per week. These workers may be eligible for benefits, depending on company settings and hours worked. * `TEMPORARY`: These workers are hired on a temporary basis. You can specify how each worker with this employment type will be paid individually.", "type": "string" }, "compensation_time_period": { "description": "The compensation period for the employment type. * `SALARIED`: Employees that are paid a fixed amount per year. * `HOURLY`: Employees that are paid a wage per hour worked.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "label": { "description": "The display label of the employment type.", "type": "string" }, "name": { "description": "The name of the employment type for non-custom employment types.", "type": "string" }, "type": { "description": "The classification of the worker by the company. * `CONTRACTOR`: Contractors are self-employed workers who provide services on a short-term or per-project basis and are not eligible for tax-withholding or benefits. * `EMPLOYEE`: Employees are hired and managed by an employer, work under the employer's direct supervision and control, and are protected by law for wages and employment rights.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "label", "updated_at" ], "title": "CompanyEmploymentType", "type": "object" }, "employment_type_id": { "description": "The worker's employment type.", "type": "string" }, "end_date": { "description": "The end date of the worker.", "type": "string" }, "ethnicity": { "description": "The identified ethnicity of the worker, if specified.", "type": "string" }, "gender": { "description": "The gender of the worker, if specified.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_manager": { "description": "Whether the worker is a manager", "type": "boolean" }, "job_function": { "description": "The worker's job function. When expanded, this field requires `job-functions.read`.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "Displayed name of the job function", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "JobFunction", "type": "object" }, "job_function_id": { "description": "ID of the worker's job function.", "type": "string" }, "legal_entity": { "description": "The worker's associated legal entity.\n\nExpandable field", "properties": { "company": { "description": "The company or organization associated with the legal entity\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "doing_business_as_name": { "description": "The doing business as name for the company.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_entities": { "description": "A list of the company's entities.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestLegalEntity" }, "type": "array" }, "legal_entities_id": { "description": "A list of the company's entities.", "items": { "type": "string" }, "type": "array" }, "legal_name": { "description": "The legal name of the company.", "type": "string" }, "name": { "description": "The name of the company.", "type": "string" }, "parent_legal_entity": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The company's ultimate holding entity.\n\nExpandable field", "type": "object" }, "parent_legal_entity_id": { "description": "The company's ultimate holding entity.", "type": "string" }, "phone": { "description": "The phone number for the company.", "type": "string" }, "physical_address": { "description": "The physical address of the holding entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "primary_email": { "description": "The email address used when registering this company.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "legal_entities", "legal_entities_id", "name", "updated_at" ], "title": "Company", "type": "object" }, "company_id": { "description": "The company or organization associated with the legal entity", "type": "string" }, "country": { "description": "The country the legal entity is based in.", "properties": { "code": { "description": "The code of the country.", "type": "string" } }, "required": [ "code" ], "title": "Country", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "entity_level": { "description": "The legal entity's level in a hierarchy. * `PARENT`: The legal entity is considered the ultimate holding entity. * `SUBSIDIARY`: The legal entity is considered a subsidiary, fully or partially held by another. * `BRANCH`: The legal entity is considered a branch, associated with a parent legal entity.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_name": { "description": "The legal name of the legal entity.", "type": "string" }, "mailing_address": { "description": "The mailing address of the legal entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "management_type": { "description": "The legal entity management type in the case of an employer of record (EOR) or professional employment organization (PEO). * `PEO`: The legal entity is considered a Professional Employment Organization (PEO). * `EOR`: The legal entity is considered an Employer of Record (EOR).", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The parent legal entity.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent legal entity.", "type": "string" }, "physical_address": { "description": "The physical address of the legal entity, if it differs from the mailing address.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "registration_date": { "description": "The registration date of the entity.", "type": "string" }, "tax_identifier": { "description": "The tax identifier for the legal entity.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "LegalEntity", "type": "object" }, "legal_entity_id": { "description": "The worker's associated legal entity.", "type": "string" }, "level": { "description": "The level of the worker.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "description": { "description": "The description of the level.", "type": "string" }, "experience_requirements": { "description": "The experience requirements for the level.", "type": "string" }, "global_level": { "anyOf": [ { "description": "Global level is used to track the seniority of levels. The higher up a level is placed on the page, the more senior and higher-ranked the level. Global level is used in workflows, policies, and reports that use the level attribute (e.g., you can use Level Lookup to set up a workflow that notifies the nearest person in an worker's management chain at or above the specified level).", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the level. Must be unique within the company or organization.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLevel", "description": "The parent level.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent level.", "type": "string" }, "rank": { "anyOf": [ { "description": "The rank of the level within its track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "scope_of_responsibilities": { "description": "The scope of responsibilities for the level.", "type": "string" }, "track": { "description": "The track associated with the level, if it's not a global level.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_default": { "description": "Whether this is the company's default track.", "type": "boolean" }, "name": { "description": "The name of the track. Must be unique within the company or organization.", "type": "string" }, "order": { "anyOf": [ { "description": "The one-based horizontal display order of the track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "start_global_level": { "anyOf": [ { "description": "The highest global level occupied by this track. Empty tracks return null.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Track", "type": "object" }, "track_id": { "description": "The track associated with the level. Required during creation. Include global_level when changing it.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Level", "type": "object" }, "level_id": { "description": "The level of the worker.", "type": "string" }, "location": { "description": "The location that the worker is mapped to for tax purposes. In the case that a worker is remote, the location's type is remote.", "properties": { "type": { "description": "The type of location.", "type": "string" }, "work_location_id": { "description": "The work location, if the worker isn't remote.", "type": "string" } }, "required": [ "type", "work_location_id" ], "title": "WorkerLocation", "type": "object" }, "manager": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's manager.\n\nExpandable field", "type": "object" }, "manager_id": { "description": "The worker's manager.", "type": "string" }, "number": { "anyOf": [ { "description": "The worker's number within the organization.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "original_start_date": { "description": "The worker's earliest start date across their employment history, excluding INIT roles.", "type": "string" }, "overtime_exemption": { "description": "The worker's overtime exemption status.", "type": "string" }, "pay_schedule_id": { "description": "The ID of the pay schedule currently associated with the worker.", "type": "string" }, "personal_email": { "description": "The worker's associated personal email address.", "type": "string" }, "race": { "description": "The identified race of the worker, if specified.", "type": "string" }, "start_date": { "description": "The start date of the worker.", "type": "string" }, "status": { "description": "The worker's status within the organization.", "type": "string" }, "teams": { "description": "The worker's assigned teams.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiTeamcb26bc28f32f" }, "type": "array" }, "teams_id": { "description": "The worker's assigned teams.", "items": { "type": "string" }, "type": "array" }, "termination_details": { "description": "The details of the worker's termination, if applicable.", "properties": { "reason": { "description": "This is a description that will be custom to each Rippling company.", "type": "string" }, "type": { "description": "The termination type indicates whether the termination was voluntary or involuntary.", "type": "string" } }, "title": "TerminationDetails", "type": "object" }, "title": { "description": "The worker's title.", "type": "string" }, "title_effective_date": { "description": "Title effective date", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "user": { "description": "The worker's associated user.\n\nExpandable field", "properties": { "active": { "description": "Whether the user is able to access company resources, typically when they are in actively engaged with the company and not after off-boarding.", "type": "boolean" }, "addresses": { "description": "The user's addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiUserAddressedd59b9ba9a1" }, "type": "array" }, "created_at": { "description": "Record creation date", "type": "string" }, "display_name": { "description": "The display name of the user using either the concatenated preferred given and family name or username depending on availability.", "type": "string" }, "emails": { "description": "The user's email addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiEmail5284c8258dc3" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "locale": { "description": "The User's default location for purposes of localization of currency, date time format, or numerical representations pursuant to RFC5646.", "type": "string" }, "name": { "description": "The user's name.", "properties": { "family_name": { "description": "The legal family name of the user, or last name in most Western languages.", "type": "string" }, "formatted": { "description": "The user's full name.", "type": "string" }, "given_name": { "description": "The given legal name of the user, or first name in most Western languages.", "type": "string" }, "middle_name": { "description": "The middle name(s) of the user.", "type": "string" }, "preferred_family_name": { "description": "The preferred family name, or last name in most Western languages, by the user.", "type": "string" }, "preferred_given_name": { "description": "The preferred given name, or first name in most Western languages, by the user.", "type": "string" } }, "title": "UserName", "type": "object" }, "number": { "description": "The permanent profile number of the user.", "type": "string" }, "phone_numbers": { "description": "The user's phone numbers.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoneNumber12060c61ecf5" }, "type": "array" }, "photos": { "description": "The user's photos.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoto2be7c3ae3f39" }, "type": "array" }, "preferred_language": { "description": "The User's preferred written or spoken language in the same format of the HTTP Accept-Language header, pursuant to Section 5.3.5 of RFC7231.", "type": "string" }, "timezone": { "description": "The User's current time zone in IANA database Olson format", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "username": { "description": "The unique identifier across Rippling used by the User for direct authentication into their associated company. Globally unique.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "User", "type": "object" }, "user_id": { "description": "The worker's associated user.", "type": "string" }, "work_email": { "description": "The worker's associated work email address.", "type": "string" }, "work_schedule": { "additionalProperties": { "$ref": "#/components/schemas/OutputRestApiWorkScheduleDay938f88d94f20" }, "description": "The worker's scheduled working hours for each day of the week.", "type": "object" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Worker", "type": "object" }, "worker_id": { "description": "The ID of the worker for whom the accrual is for", "type": "string" } }, "required": [ "accrual_date", "created_at", "grantor_id", "id", "leave_type_id", "updated_at", "worker_id" ], "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Retrieve a specific leave accrual", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "leave-accruals.read" ] } }, "/leave-balances/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/list-leave-balances" }, "operationId": "rippling.rest_api.list_leave_balances", "parameters": [ { "in": "query", "name": "filter", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "expand", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 100, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "__meta": { "$ref": "#/components/schemas/OutputRestApiRedactedFields9f7657dc2a2f" }, "next_link": { "description": "A link to the next page of responses.", "format": "uri", "type": "string" }, "results": { "items": { "$ref": "#/components/schemas/OutputRestApiLeaveBalancea7326fca745d" }, "type": "array" } }, "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "List leave balances", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "leave-balances.read" ] } }, "/leave-balances/{id}/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/get-leave-balances" }, "operationId": "rippling.rest_api.get_leave_balances", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "id", "type": "string" } }, { "in": "query", "name": "expand", "required": false, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "__meta": { "properties": { "redacted_fields": { "items": { "$ref": "#/components/schemas/OutputRestApiRedactedField21788a25ef22" }, "type": "array" } }, "type": "object" }, "balance_excluding_future_requests": { "anyOf": [ { "description": "The worker's leave balance excluding future leave requests. If the leave balance is unlimited, this field will be null.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "balance_excluding_future_requests_in_days": { "anyOf": [ { "description": "The worker's leave balance in days excluding future leave requests. If the leave balance is unlimited, this field will be null.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "balance_including_future_requests": { "anyOf": [ { "description": "The worker's leave balance including future leave requests. If the leave balance is unlimited, this field will be null.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "balance_including_future_requests_in_days": { "anyOf": [ { "description": "The worker's leave balance in days including future leave requests. If the leave balance is unlimited, this field will be null.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_balance_unlimited": { "description": "Indicates if the leave balance is unlimited.", "type": "boolean" }, "leave_type": { "description": "The leave type associated with the leave balance.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "description": { "description": "The description of the leave type.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_managed_by_external_system": { "description": "Whether the leave is managed by an external system.", "type": "boolean" }, "is_paid": { "description": "Whether the leave is paid.", "type": "boolean" }, "name": { "description": "The name of the leave type.", "type": "string" }, "type": { "description": "The type of leave.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "is_managed_by_external_system", "is_paid", "name", "type", "updated_at" ], "title": "LeaveType", "type": "object" }, "leave_type_id": { "description": "The ID of the leave type associated with the leave balance.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "worker": { "description": "The worker associated with the leave balance.\n\nExpandable field", "properties": { "business_partners": { "description": "Worker's assigned business partners. This field is only populated when explicitly requested via the expand parameter (e.g., ?expand=business_partners). When expanded, returns an empty list ([]) if the worker has no business partners.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiBusinessPartner77b00a069c32" }, "type": "array" }, "business_partners_id": { "description": "Worker's assigned business partners unique identifiers. Returns an empty list ([]) if the worker has no business partners.", "items": { "type": "string" }, "type": "array" }, "citizenship": { "description": "The countries that the worker has citizenship in.", "type": "string" }, "compensation": { "description": "The compensation package for the worker.\n\nExpandable field", "properties": { "annual_compensation": { "description": "The worker's annual compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "annual_salary_equivalent": { "description": "The worker's annual salary equivalent, for insurance purposes. It will be equal to the worker's annual compensation, except for owners that are receiving no cashcompensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "bonus_schedule": { "description": "The worker's bonus schedule.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "hourly_wage": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "id": { "description": "Identifier field", "type": "string" }, "monthly_compensation": { "description": "The worker's monthly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "on_target_commission": { "description": "The worker's on-target commission.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "payment_terms": { "description": "The payment terms for an worker's compensation.", "type": "string" }, "payment_type": { "description": "The payment type for an worker's compensation.", "type": "string" }, "relocation_reimbursement": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "salary_effective_date": { "description": "Salary effective date", "type": "string" }, "signing_bonus": { "description": "The worker's signing bonus.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus": { "description": "The worker's target annual bonus amount.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus_percent": { "anyOf": [ { "description": "The worker's target annual bonus as a percent of annual compensation.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" }, "weekly_compensation": { "description": "The worker's weekly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "worker": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's details.\n\nExpandable field", "type": "object" }, "worker_id": { "description": "The worker's ID.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Compensation", "type": "object" }, "compensation_grade": { "description": "The compensation grade assigned to the worker, if any.", "properties": { "id": { "description": "The compensation grade's unique identifier.", "type": "string" }, "label": { "description": "The compensation grade's label.", "type": "string" } }, "title": "WorkerCompensationGrade", "type": "object" }, "compensation_id": { "description": "The compensation package for the worker.", "type": "string" }, "country": { "description": "The worker's country.", "type": "string" }, "country_fields": { "description": "Country level fields for the worker.", "properties": { "ca": { "description": "Country-wise regional fields for Canada", "properties": { "sin": { "description": "Social Insurance Number (SIN) for Canada employees.", "type": "string" } }, "title": "CanadaFields", "type": "object" }, "nz": { "description": "Country-wise regional fields for New Zealand", "properties": { "ird_number": { "description": "Inland Revenue Department (IRD) number for New Zealand employees.", "type": "string" } }, "title": "NewZealandFields", "type": "object" }, "us": { "description": "Country-wise regional fields for USA", "properties": { "ssn": { "description": "Social Security Number (SSN) for US employees.", "type": "string" } }, "title": "USFields", "type": "object" } }, "title": "CountryFields", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "custom_fields": { "description": "Custom field values defined on the Employee object for this worker\n\nExpandable field", "items": { "additionalProperties": {} }, "type": "array" }, "date_of_birth": { "description": "The worker's date of birth.", "type": "string" }, "department": { "description": "The worker's assigned department.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "department_hierarchy": { "description": "List of departments in the department hierarchy. Refer department_hierarchy_ids for department hierarchy order.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestDepartment" }, "type": "array" }, "department_hierarchy_id": { "description": "The identifier of departments in the department hierarchy ordered from parent department to child department.", "items": { "type": "string" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the department.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestDepartment", "description": "The parent department.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent department.", "type": "string" }, "reference_code": { "description": "Reference code of the department.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Department", "type": "object" }, "department_id": { "description": "The worker's assigned department.", "type": "string" }, "employment_type": { "description": "The worker's employment type.\n\nExpandable field", "properties": { "amount_worked": { "description": "The amount worked for the employment type. * `FULL-TIME`: Full-time is at least 30 hours per week. Full-time workers will typically be eligible for benefits. * `PART-TIME`: Part-time is less than 30 hours per week. These workers may be eligible for benefits, depending on company settings and hours worked. * `TEMPORARY`: These workers are hired on a temporary basis. You can specify how each worker with this employment type will be paid individually.", "type": "string" }, "compensation_time_period": { "description": "The compensation period for the employment type. * `SALARIED`: Employees that are paid a fixed amount per year. * `HOURLY`: Employees that are paid a wage per hour worked.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "label": { "description": "The display label of the employment type.", "type": "string" }, "name": { "description": "The name of the employment type for non-custom employment types.", "type": "string" }, "type": { "description": "The classification of the worker by the company. * `CONTRACTOR`: Contractors are self-employed workers who provide services on a short-term or per-project basis and are not eligible for tax-withholding or benefits. * `EMPLOYEE`: Employees are hired and managed by an employer, work under the employer's direct supervision and control, and are protected by law for wages and employment rights.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "label", "updated_at" ], "title": "CompanyEmploymentType", "type": "object" }, "employment_type_id": { "description": "The worker's employment type.", "type": "string" }, "end_date": { "description": "The end date of the worker.", "type": "string" }, "ethnicity": { "description": "The identified ethnicity of the worker, if specified.", "type": "string" }, "gender": { "description": "The gender of the worker, if specified.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_manager": { "description": "Whether the worker is a manager", "type": "boolean" }, "job_function": { "description": "The worker's job function. When expanded, this field requires `job-functions.read`.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "Displayed name of the job function", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "JobFunction", "type": "object" }, "job_function_id": { "description": "ID of the worker's job function.", "type": "string" }, "legal_entity": { "description": "The worker's associated legal entity.\n\nExpandable field", "properties": { "company": { "description": "The company or organization associated with the legal entity\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "doing_business_as_name": { "description": "The doing business as name for the company.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_entities": { "description": "A list of the company's entities.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestLegalEntity" }, "type": "array" }, "legal_entities_id": { "description": "A list of the company's entities.", "items": { "type": "string" }, "type": "array" }, "legal_name": { "description": "The legal name of the company.", "type": "string" }, "name": { "description": "The name of the company.", "type": "string" }, "parent_legal_entity": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The company's ultimate holding entity.\n\nExpandable field", "type": "object" }, "parent_legal_entity_id": { "description": "The company's ultimate holding entity.", "type": "string" }, "phone": { "description": "The phone number for the company.", "type": "string" }, "physical_address": { "description": "The physical address of the holding entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "primary_email": { "description": "The email address used when registering this company.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "legal_entities", "legal_entities_id", "name", "updated_at" ], "title": "Company", "type": "object" }, "company_id": { "description": "The company or organization associated with the legal entity", "type": "string" }, "country": { "description": "The country the legal entity is based in.", "properties": { "code": { "description": "The code of the country.", "type": "string" } }, "required": [ "code" ], "title": "Country", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "entity_level": { "description": "The legal entity's level in a hierarchy. * `PARENT`: The legal entity is considered the ultimate holding entity. * `SUBSIDIARY`: The legal entity is considered a subsidiary, fully or partially held by another. * `BRANCH`: The legal entity is considered a branch, associated with a parent legal entity.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_name": { "description": "The legal name of the legal entity.", "type": "string" }, "mailing_address": { "description": "The mailing address of the legal entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "management_type": { "description": "The legal entity management type in the case of an employer of record (EOR) or professional employment organization (PEO). * `PEO`: The legal entity is considered a Professional Employment Organization (PEO). * `EOR`: The legal entity is considered an Employer of Record (EOR).", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The parent legal entity.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent legal entity.", "type": "string" }, "physical_address": { "description": "The physical address of the legal entity, if it differs from the mailing address.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "registration_date": { "description": "The registration date of the entity.", "type": "string" }, "tax_identifier": { "description": "The tax identifier for the legal entity.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "LegalEntity", "type": "object" }, "legal_entity_id": { "description": "The worker's associated legal entity.", "type": "string" }, "level": { "description": "The level of the worker.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "description": { "description": "The description of the level.", "type": "string" }, "experience_requirements": { "description": "The experience requirements for the level.", "type": "string" }, "global_level": { "anyOf": [ { "description": "Global level is used to track the seniority of levels. The higher up a level is placed on the page, the more senior and higher-ranked the level. Global level is used in workflows, policies, and reports that use the level attribute (e.g., you can use Level Lookup to set up a workflow that notifies the nearest person in an worker's management chain at or above the specified level).", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the level. Must be unique within the company or organization.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLevel", "description": "The parent level.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent level.", "type": "string" }, "rank": { "anyOf": [ { "description": "The rank of the level within its track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "scope_of_responsibilities": { "description": "The scope of responsibilities for the level.", "type": "string" }, "track": { "description": "The track associated with the level, if it's not a global level.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_default": { "description": "Whether this is the company's default track.", "type": "boolean" }, "name": { "description": "The name of the track. Must be unique within the company or organization.", "type": "string" }, "order": { "anyOf": [ { "description": "The one-based horizontal display order of the track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "start_global_level": { "anyOf": [ { "description": "The highest global level occupied by this track. Empty tracks return null.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Track", "type": "object" }, "track_id": { "description": "The track associated with the level. Required during creation. Include global_level when changing it.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Level", "type": "object" }, "level_id": { "description": "The level of the worker.", "type": "string" }, "location": { "description": "The location that the worker is mapped to for tax purposes. In the case that a worker is remote, the location's type is remote.", "properties": { "type": { "description": "The type of location.", "type": "string" }, "work_location_id": { "description": "The work location, if the worker isn't remote.", "type": "string" } }, "required": [ "type", "work_location_id" ], "title": "WorkerLocation", "type": "object" }, "manager": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's manager.\n\nExpandable field", "type": "object" }, "manager_id": { "description": "The worker's manager.", "type": "string" }, "number": { "anyOf": [ { "description": "The worker's number within the organization.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "original_start_date": { "description": "The worker's earliest start date across their employment history, excluding INIT roles.", "type": "string" }, "overtime_exemption": { "description": "The worker's overtime exemption status.", "type": "string" }, "pay_schedule_id": { "description": "The ID of the pay schedule currently associated with the worker.", "type": "string" }, "personal_email": { "description": "The worker's associated personal email address.", "type": "string" }, "race": { "description": "The identified race of the worker, if specified.", "type": "string" }, "start_date": { "description": "The start date of the worker.", "type": "string" }, "status": { "description": "The worker's status within the organization.", "type": "string" }, "teams": { "description": "The worker's assigned teams.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiTeamcb26bc28f32f" }, "type": "array" }, "teams_id": { "description": "The worker's assigned teams.", "items": { "type": "string" }, "type": "array" }, "termination_details": { "description": "The details of the worker's termination, if applicable.", "properties": { "reason": { "description": "This is a description that will be custom to each Rippling company.", "type": "string" }, "type": { "description": "The termination type indicates whether the termination was voluntary or involuntary.", "type": "string" } }, "title": "TerminationDetails", "type": "object" }, "title": { "description": "The worker's title.", "type": "string" }, "title_effective_date": { "description": "Title effective date", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "user": { "description": "The worker's associated user.\n\nExpandable field", "properties": { "active": { "description": "Whether the user is able to access company resources, typically when they are in actively engaged with the company and not after off-boarding.", "type": "boolean" }, "addresses": { "description": "The user's addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiUserAddressedd59b9ba9a1" }, "type": "array" }, "created_at": { "description": "Record creation date", "type": "string" }, "display_name": { "description": "The display name of the user using either the concatenated preferred given and family name or username depending on availability.", "type": "string" }, "emails": { "description": "The user's email addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiEmail5284c8258dc3" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "locale": { "description": "The User's default location for purposes of localization of currency, date time format, or numerical representations pursuant to RFC5646.", "type": "string" }, "name": { "description": "The user's name.", "properties": { "family_name": { "description": "The legal family name of the user, or last name in most Western languages.", "type": "string" }, "formatted": { "description": "The user's full name.", "type": "string" }, "given_name": { "description": "The given legal name of the user, or first name in most Western languages.", "type": "string" }, "middle_name": { "description": "The middle name(s) of the user.", "type": "string" }, "preferred_family_name": { "description": "The preferred family name, or last name in most Western languages, by the user.", "type": "string" }, "preferred_given_name": { "description": "The preferred given name, or first name in most Western languages, by the user.", "type": "string" } }, "title": "UserName", "type": "object" }, "number": { "description": "The permanent profile number of the user.", "type": "string" }, "phone_numbers": { "description": "The user's phone numbers.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoneNumber12060c61ecf5" }, "type": "array" }, "photos": { "description": "The user's photos.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoto2be7c3ae3f39" }, "type": "array" }, "preferred_language": { "description": "The User's preferred written or spoken language in the same format of the HTTP Accept-Language header, pursuant to Section 5.3.5 of RFC7231.", "type": "string" }, "timezone": { "description": "The User's current time zone in IANA database Olson format", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "username": { "description": "The unique identifier across Rippling used by the User for direct authentication into their associated company. Globally unique.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "User", "type": "object" }, "user_id": { "description": "The worker's associated user.", "type": "string" }, "work_email": { "description": "The worker's associated work email address.", "type": "string" }, "work_schedule": { "additionalProperties": { "$ref": "#/components/schemas/OutputRestApiWorkScheduleDay938f88d94f20" }, "description": "The worker's scheduled working hours for each day of the week.", "type": "object" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Worker", "type": "object" }, "worker_id": { "description": "The ID of the worker associated with the leave balance.", "type": "string" } }, "required": [ "created_at", "id", "updated_at", "worker_id" ], "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Retrieve a specific leave balance", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "leave-balances.read" ] } }, "/leave-program-evaluations/": { "post": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/create-leave-program-evaluations" }, "operationId": "rippling.rest_api.create_leave_program_evaluations", "parameters": [ { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiLeavePlanEvaluationRequested784c02b55a" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "leave_plan": { "description": "Combined leave plan derived from all non-ineligible program results. Join program_results by program_code for eligibility, pay rates, and gaps; program_contributions carry placement windows only.", "properties": { "balance_adjustments": { "description": "Flattened balance adjustment directives from payable program results.", "items": { "$ref": "#/components/schemas/OutputRestApiBalanceAdjustmentInputab4e8d80def3" }, "type": "array" }, "claim_end_date": { "description": "Requested leave end date used for this plan, if provided.", "type": "string" }, "claim_start_date": { "description": "Requested leave start date used for this plan.", "type": "string" }, "coverage_segments": { "description": "Contiguous spans where the same program set overlaps.", "items": { "$ref": "#/components/schemas/OutputRestApiCoverageSegment54c23d42c145" }, "type": "array" }, "earnings": { "description": "Flattened payroll earning directives from payable program results.", "items": { "$ref": "#/components/schemas/OutputRestApiEarningInput0e55076c2e04" }, "type": "array" }, "leave_request": { "description": "Merged bookable leave request directive, if any.", "properties": { "end_date": { "description": "Recommended leave request end date, if known.", "type": "string" }, "leave_type": { "description": "Leave type to use if booking a leave request from the evaluation.", "type": "string" }, "start_date": { "description": "Recommended leave request start date.", "type": "string" }, "status": { "description": "Optional leave request status to use when booking.", "type": "string" } }, "required": [ "leave_type", "start_date" ], "title": "LeaveRequestInput", "type": "object" }, "pay_periods": { "description": "Estimated per-paycheck amounts when claim_end_date and pay schedule are known.", "items": { "$ref": "#/components/schemas/OutputRestApiPayPeriodContributionb24011515e91" }, "type": "array" }, "program_contributions": { "description": "Per-program placement windows on the claim.", "items": { "$ref": "#/components/schemas/OutputRestApiProgramContributionba9b17304162" }, "type": "array" } }, "required": [ "balance_adjustments", "claim_start_date", "coverage_segments", "earnings", "pay_periods", "program_contributions" ], "title": "LeavePlan", "type": "object" }, "missing_evidence": { "description": "Structured evidence gaps reported by evaluated eligibility rules.", "items": { "$ref": "#/components/schemas/OutputRestApiMissingLeaveEvidencec3ffdc0bb742" }, "type": "array" }, "program_results": { "description": "Per-program rule outputs in evaluation order.", "items": { "$ref": "#/components/schemas/OutputRestApiLeaveProgramResult481bd55806cf" }, "type": "array" } }, "required": [ "leave_plan", "missing_evidence", "program_results" ], "title": "LeavePlanEvaluation", "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Evaluate a leave program evaluation", "x-rippling-entitlements": [ "Internal_Testing" ], "x-rippling-required-scopes": [ "leave-program-evaluations.read-write" ] } }, "/leave-requests/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/list-leave-requests" }, "operationId": "rippling.rest_api.list_leave_requests", "parameters": [ { "in": "query", "name": "filter", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "expand", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 100, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "__meta": { "$ref": "#/components/schemas/OutputRestApiRedactedFields9f7657dc2a2f" }, "next_link": { "description": "A link to the next page of responses.", "format": "uri", "type": "string" }, "results": { "items": { "$ref": "#/components/schemas/OutputRestApiLeaveRequest738c6bddbfca" }, "type": "array" } }, "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "List leave requests", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "leave-requests.read" ] }, "post": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/create-leave-requests" }, "operationId": "rippling.rest_api.create_leave_requests", "parameters": [ { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiLeaveRequestRequest67e95f6f8193" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "comments": { "description": "The comments associated with the leave request.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "days_take_off": { "description": "The specific dates taken off and the amount of time taken off for each one.", "items": { "$ref": "#/components/schemas/OutputRestApiDayOff9e4b21f07f8d" }, "type": "array" }, "end_date": { "description": "The end date of the leave request.", "type": "string" }, "end_time": { "description": "The end time of the leave request.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_managed_by_external_system": { "description": "Whether the leave request is managed by an external system.", "type": "boolean" }, "leave_event_id": { "description": "The ID of the leave event associated with the leave request, if any.", "type": "string" }, "leave_policy_id": { "description": "The ID of the leave policy associated with the leave request, either leave_policy_id or leave_type_id must be provided.", "type": "string" }, "leave_type": { "description": "The leave type associated with the leave request.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "description": { "description": "The description of the leave type.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_managed_by_external_system": { "description": "Whether the leave is managed by an external system.", "type": "boolean" }, "is_paid": { "description": "Whether the leave is paid.", "type": "boolean" }, "name": { "description": "The name of the leave type.", "type": "string" }, "type": { "description": "The type of leave.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "is_managed_by_external_system", "is_paid", "name", "type", "updated_at" ], "title": "LeaveType", "type": "object" }, "leave_type_id": { "description": "The ID of the leave type associated with the leave request, either leave_policy_id or leave_type_id must be provided.", "type": "string" }, "number_of_minutes_requested": { "anyOf": [ { "description": "The number of minutes requested for the leave request.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "reason_for_leave": { "description": "The reason for the leave request.", "type": "string" }, "requester": { "description": "The worker who requested the leave request.\n\nExpandable field", "properties": { "business_partners": { "description": "Worker's assigned business partners. This field is only populated when explicitly requested via the expand parameter (e.g., ?expand=business_partners). When expanded, returns an empty list ([]) if the worker has no business partners.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiBusinessPartner77b00a069c32" }, "type": "array" }, "business_partners_id": { "description": "Worker's assigned business partners unique identifiers. Returns an empty list ([]) if the worker has no business partners.", "items": { "type": "string" }, "type": "array" }, "citizenship": { "description": "The countries that the worker has citizenship in.", "type": "string" }, "compensation": { "description": "The compensation package for the worker.\n\nExpandable field", "properties": { "annual_compensation": { "description": "The worker's annual compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "annual_salary_equivalent": { "description": "The worker's annual salary equivalent, for insurance purposes. It will be equal to the worker's annual compensation, except for owners that are receiving no cashcompensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "bonus_schedule": { "description": "The worker's bonus schedule.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "hourly_wage": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "id": { "description": "Identifier field", "type": "string" }, "monthly_compensation": { "description": "The worker's monthly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "on_target_commission": { "description": "The worker's on-target commission.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "payment_terms": { "description": "The payment terms for an worker's compensation.", "type": "string" }, "payment_type": { "description": "The payment type for an worker's compensation.", "type": "string" }, "relocation_reimbursement": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "salary_effective_date": { "description": "Salary effective date", "type": "string" }, "signing_bonus": { "description": "The worker's signing bonus.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus": { "description": "The worker's target annual bonus amount.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus_percent": { "anyOf": [ { "description": "The worker's target annual bonus as a percent of annual compensation.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" }, "weekly_compensation": { "description": "The worker's weekly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "worker": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's details.\n\nExpandable field", "type": "object" }, "worker_id": { "description": "The worker's ID.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Compensation", "type": "object" }, "compensation_grade": { "description": "The compensation grade assigned to the worker, if any.", "properties": { "id": { "description": "The compensation grade's unique identifier.", "type": "string" }, "label": { "description": "The compensation grade's label.", "type": "string" } }, "title": "WorkerCompensationGrade", "type": "object" }, "compensation_id": { "description": "The compensation package for the worker.", "type": "string" }, "country": { "description": "The worker's country.", "type": "string" }, "country_fields": { "description": "Country level fields for the worker.", "properties": { "ca": { "description": "Country-wise regional fields for Canada", "properties": { "sin": { "description": "Social Insurance Number (SIN) for Canada employees.", "type": "string" } }, "title": "CanadaFields", "type": "object" }, "nz": { "description": "Country-wise regional fields for New Zealand", "properties": { "ird_number": { "description": "Inland Revenue Department (IRD) number for New Zealand employees.", "type": "string" } }, "title": "NewZealandFields", "type": "object" }, "us": { "description": "Country-wise regional fields for USA", "properties": { "ssn": { "description": "Social Security Number (SSN) for US employees.", "type": "string" } }, "title": "USFields", "type": "object" } }, "title": "CountryFields", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "custom_fields": { "description": "Custom field values defined on the Employee object for this worker\n\nExpandable field", "items": { "additionalProperties": {} }, "type": "array" }, "date_of_birth": { "description": "The worker's date of birth.", "type": "string" }, "department": { "description": "The worker's assigned department.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "department_hierarchy": { "description": "List of departments in the department hierarchy. Refer department_hierarchy_ids for department hierarchy order.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestDepartment" }, "type": "array" }, "department_hierarchy_id": { "description": "The identifier of departments in the department hierarchy ordered from parent department to child department.", "items": { "type": "string" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the department.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestDepartment", "description": "The parent department.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent department.", "type": "string" }, "reference_code": { "description": "Reference code of the department.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Department", "type": "object" }, "department_id": { "description": "The worker's assigned department.", "type": "string" }, "employment_type": { "description": "The worker's employment type.\n\nExpandable field", "properties": { "amount_worked": { "description": "The amount worked for the employment type. * `FULL-TIME`: Full-time is at least 30 hours per week. Full-time workers will typically be eligible for benefits. * `PART-TIME`: Part-time is less than 30 hours per week. These workers may be eligible for benefits, depending on company settings and hours worked. * `TEMPORARY`: These workers are hired on a temporary basis. You can specify how each worker with this employment type will be paid individually.", "type": "string" }, "compensation_time_period": { "description": "The compensation period for the employment type. * `SALARIED`: Employees that are paid a fixed amount per year. * `HOURLY`: Employees that are paid a wage per hour worked.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "label": { "description": "The display label of the employment type.", "type": "string" }, "name": { "description": "The name of the employment type for non-custom employment types.", "type": "string" }, "type": { "description": "The classification of the worker by the company. * `CONTRACTOR`: Contractors are self-employed workers who provide services on a short-term or per-project basis and are not eligible for tax-withholding or benefits. * `EMPLOYEE`: Employees are hired and managed by an employer, work under the employer's direct supervision and control, and are protected by law for wages and employment rights.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "label", "updated_at" ], "title": "CompanyEmploymentType", "type": "object" }, "employment_type_id": { "description": "The worker's employment type.", "type": "string" }, "end_date": { "description": "The end date of the worker.", "type": "string" }, "ethnicity": { "description": "The identified ethnicity of the worker, if specified.", "type": "string" }, "gender": { "description": "The gender of the worker, if specified.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_manager": { "description": "Whether the worker is a manager", "type": "boolean" }, "job_function": { "description": "The worker's job function. When expanded, this field requires `job-functions.read`.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "Displayed name of the job function", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "JobFunction", "type": "object" }, "job_function_id": { "description": "ID of the worker's job function.", "type": "string" }, "legal_entity": { "description": "The worker's associated legal entity.\n\nExpandable field", "properties": { "company": { "description": "The company or organization associated with the legal entity\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "doing_business_as_name": { "description": "The doing business as name for the company.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_entities": { "description": "A list of the company's entities.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestLegalEntity" }, "type": "array" }, "legal_entities_id": { "description": "A list of the company's entities.", "items": { "type": "string" }, "type": "array" }, "legal_name": { "description": "The legal name of the company.", "type": "string" }, "name": { "description": "The name of the company.", "type": "string" }, "parent_legal_entity": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The company's ultimate holding entity.\n\nExpandable field", "type": "object" }, "parent_legal_entity_id": { "description": "The company's ultimate holding entity.", "type": "string" }, "phone": { "description": "The phone number for the company.", "type": "string" }, "physical_address": { "description": "The physical address of the holding entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "primary_email": { "description": "The email address used when registering this company.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "legal_entities", "legal_entities_id", "name", "updated_at" ], "title": "Company", "type": "object" }, "company_id": { "description": "The company or organization associated with the legal entity", "type": "string" }, "country": { "description": "The country the legal entity is based in.", "properties": { "code": { "description": "The code of the country.", "type": "string" } }, "required": [ "code" ], "title": "Country", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "entity_level": { "description": "The legal entity's level in a hierarchy. * `PARENT`: The legal entity is considered the ultimate holding entity. * `SUBSIDIARY`: The legal entity is considered a subsidiary, fully or partially held by another. * `BRANCH`: The legal entity is considered a branch, associated with a parent legal entity.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_name": { "description": "The legal name of the legal entity.", "type": "string" }, "mailing_address": { "description": "The mailing address of the legal entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "management_type": { "description": "The legal entity management type in the case of an employer of record (EOR) or professional employment organization (PEO). * `PEO`: The legal entity is considered a Professional Employment Organization (PEO). * `EOR`: The legal entity is considered an Employer of Record (EOR).", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The parent legal entity.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent legal entity.", "type": "string" }, "physical_address": { "description": "The physical address of the legal entity, if it differs from the mailing address.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "registration_date": { "description": "The registration date of the entity.", "type": "string" }, "tax_identifier": { "description": "The tax identifier for the legal entity.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "LegalEntity", "type": "object" }, "legal_entity_id": { "description": "The worker's associated legal entity.", "type": "string" }, "level": { "description": "The level of the worker.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "description": { "description": "The description of the level.", "type": "string" }, "experience_requirements": { "description": "The experience requirements for the level.", "type": "string" }, "global_level": { "anyOf": [ { "description": "Global level is used to track the seniority of levels. The higher up a level is placed on the page, the more senior and higher-ranked the level. Global level is used in workflows, policies, and reports that use the level attribute (e.g., you can use Level Lookup to set up a workflow that notifies the nearest person in an worker's management chain at or above the specified level).", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the level. Must be unique within the company or organization.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLevel", "description": "The parent level.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent level.", "type": "string" }, "rank": { "anyOf": [ { "description": "The rank of the level within its track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "scope_of_responsibilities": { "description": "The scope of responsibilities for the level.", "type": "string" }, "track": { "description": "The track associated with the level, if it's not a global level.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_default": { "description": "Whether this is the company's default track.", "type": "boolean" }, "name": { "description": "The name of the track. Must be unique within the company or organization.", "type": "string" }, "order": { "anyOf": [ { "description": "The one-based horizontal display order of the track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "start_global_level": { "anyOf": [ { "description": "The highest global level occupied by this track. Empty tracks return null.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Track", "type": "object" }, "track_id": { "description": "The track associated with the level. Required during creation. Include global_level when changing it.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Level", "type": "object" }, "level_id": { "description": "The level of the worker.", "type": "string" }, "location": { "description": "The location that the worker is mapped to for tax purposes. In the case that a worker is remote, the location's type is remote.", "properties": { "type": { "description": "The type of location.", "type": "string" }, "work_location_id": { "description": "The work location, if the worker isn't remote.", "type": "string" } }, "required": [ "type", "work_location_id" ], "title": "WorkerLocation", "type": "object" }, "manager": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's manager.\n\nExpandable field", "type": "object" }, "manager_id": { "description": "The worker's manager.", "type": "string" }, "number": { "anyOf": [ { "description": "The worker's number within the organization.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "original_start_date": { "description": "The worker's earliest start date across their employment history, excluding INIT roles.", "type": "string" }, "overtime_exemption": { "description": "The worker's overtime exemption status.", "type": "string" }, "pay_schedule_id": { "description": "The ID of the pay schedule currently associated with the worker.", "type": "string" }, "personal_email": { "description": "The worker's associated personal email address.", "type": "string" }, "race": { "description": "The identified race of the worker, if specified.", "type": "string" }, "start_date": { "description": "The start date of the worker.", "type": "string" }, "status": { "description": "The worker's status within the organization.", "type": "string" }, "teams": { "description": "The worker's assigned teams.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiTeamcb26bc28f32f" }, "type": "array" }, "teams_id": { "description": "The worker's assigned teams.", "items": { "type": "string" }, "type": "array" }, "termination_details": { "description": "The details of the worker's termination, if applicable.", "properties": { "reason": { "description": "This is a description that will be custom to each Rippling company.", "type": "string" }, "type": { "description": "The termination type indicates whether the termination was voluntary or involuntary.", "type": "string" } }, "title": "TerminationDetails", "type": "object" }, "title": { "description": "The worker's title.", "type": "string" }, "title_effective_date": { "description": "Title effective date", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "user": { "description": "The worker's associated user.\n\nExpandable field", "properties": { "active": { "description": "Whether the user is able to access company resources, typically when they are in actively engaged with the company and not after off-boarding.", "type": "boolean" }, "addresses": { "description": "The user's addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiUserAddressedd59b9ba9a1" }, "type": "array" }, "created_at": { "description": "Record creation date", "type": "string" }, "display_name": { "description": "The display name of the user using either the concatenated preferred given and family name or username depending on availability.", "type": "string" }, "emails": { "description": "The user's email addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiEmail5284c8258dc3" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "locale": { "description": "The User's default location for purposes of localization of currency, date time format, or numerical representations pursuant to RFC5646.", "type": "string" }, "name": { "description": "The user's name.", "properties": { "family_name": { "description": "The legal family name of the user, or last name in most Western languages.", "type": "string" }, "formatted": { "description": "The user's full name.", "type": "string" }, "given_name": { "description": "The given legal name of the user, or first name in most Western languages.", "type": "string" }, "middle_name": { "description": "The middle name(s) of the user.", "type": "string" }, "preferred_family_name": { "description": "The preferred family name, or last name in most Western languages, by the user.", "type": "string" }, "preferred_given_name": { "description": "The preferred given name, or first name in most Western languages, by the user.", "type": "string" } }, "title": "UserName", "type": "object" }, "number": { "description": "The permanent profile number of the user.", "type": "string" }, "phone_numbers": { "description": "The user's phone numbers.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoneNumber12060c61ecf5" }, "type": "array" }, "photos": { "description": "The user's photos.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoto2be7c3ae3f39" }, "type": "array" }, "preferred_language": { "description": "The User's preferred written or spoken language in the same format of the HTTP Accept-Language header, pursuant to Section 5.3.5 of RFC7231.", "type": "string" }, "timezone": { "description": "The User's current time zone in IANA database Olson format", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "username": { "description": "The unique identifier across Rippling used by the User for direct authentication into their associated company. Globally unique.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "User", "type": "object" }, "user_id": { "description": "The worker's associated user.", "type": "string" }, "work_email": { "description": "The worker's associated work email address.", "type": "string" }, "work_schedule": { "additionalProperties": { "$ref": "#/components/schemas/OutputRestApiWorkScheduleDay938f88d94f20" }, "description": "The worker's scheduled working hours for each day of the week.", "type": "object" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Worker", "type": "object" }, "requester_id": { "description": "The ID of the worker who requested the leave request.", "type": "string" }, "reviewed_at": { "description": "The timestamp of when the leave request was reviewed.", "type": "string" }, "reviewer": { "description": "The worker who reviewed the leave request.\n\nExpandable field", "properties": { "business_partners": { "description": "Worker's assigned business partners. This field is only populated when explicitly requested via the expand parameter (e.g., ?expand=business_partners). When expanded, returns an empty list ([]) if the worker has no business partners.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiBusinessPartner77b00a069c32" }, "type": "array" }, "business_partners_id": { "description": "Worker's assigned business partners unique identifiers. Returns an empty list ([]) if the worker has no business partners.", "items": { "type": "string" }, "type": "array" }, "citizenship": { "description": "The countries that the worker has citizenship in.", "type": "string" }, "compensation": { "description": "The compensation package for the worker.\n\nExpandable field", "properties": { "annual_compensation": { "description": "The worker's annual compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "annual_salary_equivalent": { "description": "The worker's annual salary equivalent, for insurance purposes. It will be equal to the worker's annual compensation, except for owners that are receiving no cashcompensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "bonus_schedule": { "description": "The worker's bonus schedule.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "hourly_wage": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "id": { "description": "Identifier field", "type": "string" }, "monthly_compensation": { "description": "The worker's monthly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "on_target_commission": { "description": "The worker's on-target commission.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "payment_terms": { "description": "The payment terms for an worker's compensation.", "type": "string" }, "payment_type": { "description": "The payment type for an worker's compensation.", "type": "string" }, "relocation_reimbursement": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "salary_effective_date": { "description": "Salary effective date", "type": "string" }, "signing_bonus": { "description": "The worker's signing bonus.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus": { "description": "The worker's target annual bonus amount.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus_percent": { "anyOf": [ { "description": "The worker's target annual bonus as a percent of annual compensation.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" }, "weekly_compensation": { "description": "The worker's weekly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "worker": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's details.\n\nExpandable field", "type": "object" }, "worker_id": { "description": "The worker's ID.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Compensation", "type": "object" }, "compensation_grade": { "description": "The compensation grade assigned to the worker, if any.", "properties": { "id": { "description": "The compensation grade's unique identifier.", "type": "string" }, "label": { "description": "The compensation grade's label.", "type": "string" } }, "title": "WorkerCompensationGrade", "type": "object" }, "compensation_id": { "description": "The compensation package for the worker.", "type": "string" }, "country": { "description": "The worker's country.", "type": "string" }, "country_fields": { "description": "Country level fields for the worker.", "properties": { "ca": { "description": "Country-wise regional fields for Canada", "properties": { "sin": { "description": "Social Insurance Number (SIN) for Canada employees.", "type": "string" } }, "title": "CanadaFields", "type": "object" }, "nz": { "description": "Country-wise regional fields for New Zealand", "properties": { "ird_number": { "description": "Inland Revenue Department (IRD) number for New Zealand employees.", "type": "string" } }, "title": "NewZealandFields", "type": "object" }, "us": { "description": "Country-wise regional fields for USA", "properties": { "ssn": { "description": "Social Security Number (SSN) for US employees.", "type": "string" } }, "title": "USFields", "type": "object" } }, "title": "CountryFields", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "custom_fields": { "description": "Custom field values defined on the Employee object for this worker\n\nExpandable field", "items": { "additionalProperties": {} }, "type": "array" }, "date_of_birth": { "description": "The worker's date of birth.", "type": "string" }, "department": { "description": "The worker's assigned department.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "department_hierarchy": { "description": "List of departments in the department hierarchy. Refer department_hierarchy_ids for department hierarchy order.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestDepartment" }, "type": "array" }, "department_hierarchy_id": { "description": "The identifier of departments in the department hierarchy ordered from parent department to child department.", "items": { "type": "string" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the department.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestDepartment", "description": "The parent department.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent department.", "type": "string" }, "reference_code": { "description": "Reference code of the department.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Department", "type": "object" }, "department_id": { "description": "The worker's assigned department.", "type": "string" }, "employment_type": { "description": "The worker's employment type.\n\nExpandable field", "properties": { "amount_worked": { "description": "The amount worked for the employment type. * `FULL-TIME`: Full-time is at least 30 hours per week. Full-time workers will typically be eligible for benefits. * `PART-TIME`: Part-time is less than 30 hours per week. These workers may be eligible for benefits, depending on company settings and hours worked. * `TEMPORARY`: These workers are hired on a temporary basis. You can specify how each worker with this employment type will be paid individually.", "type": "string" }, "compensation_time_period": { "description": "The compensation period for the employment type. * `SALARIED`: Employees that are paid a fixed amount per year. * `HOURLY`: Employees that are paid a wage per hour worked.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "label": { "description": "The display label of the employment type.", "type": "string" }, "name": { "description": "The name of the employment type for non-custom employment types.", "type": "string" }, "type": { "description": "The classification of the worker by the company. * `CONTRACTOR`: Contractors are self-employed workers who provide services on a short-term or per-project basis and are not eligible for tax-withholding or benefits. * `EMPLOYEE`: Employees are hired and managed by an employer, work under the employer's direct supervision and control, and are protected by law for wages and employment rights.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "label", "updated_at" ], "title": "CompanyEmploymentType", "type": "object" }, "employment_type_id": { "description": "The worker's employment type.", "type": "string" }, "end_date": { "description": "The end date of the worker.", "type": "string" }, "ethnicity": { "description": "The identified ethnicity of the worker, if specified.", "type": "string" }, "gender": { "description": "The gender of the worker, if specified.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_manager": { "description": "Whether the worker is a manager", "type": "boolean" }, "job_function": { "description": "The worker's job function. When expanded, this field requires `job-functions.read`.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "Displayed name of the job function", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "JobFunction", "type": "object" }, "job_function_id": { "description": "ID of the worker's job function.", "type": "string" }, "legal_entity": { "description": "The worker's associated legal entity.\n\nExpandable field", "properties": { "company": { "description": "The company or organization associated with the legal entity\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "doing_business_as_name": { "description": "The doing business as name for the company.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_entities": { "description": "A list of the company's entities.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestLegalEntity" }, "type": "array" }, "legal_entities_id": { "description": "A list of the company's entities.", "items": { "type": "string" }, "type": "array" }, "legal_name": { "description": "The legal name of the company.", "type": "string" }, "name": { "description": "The name of the company.", "type": "string" }, "parent_legal_entity": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The company's ultimate holding entity.\n\nExpandable field", "type": "object" }, "parent_legal_entity_id": { "description": "The company's ultimate holding entity.", "type": "string" }, "phone": { "description": "The phone number for the company.", "type": "string" }, "physical_address": { "description": "The physical address of the holding entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "primary_email": { "description": "The email address used when registering this company.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "legal_entities", "legal_entities_id", "name", "updated_at" ], "title": "Company", "type": "object" }, "company_id": { "description": "The company or organization associated with the legal entity", "type": "string" }, "country": { "description": "The country the legal entity is based in.", "properties": { "code": { "description": "The code of the country.", "type": "string" } }, "required": [ "code" ], "title": "Country", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "entity_level": { "description": "The legal entity's level in a hierarchy. * `PARENT`: The legal entity is considered the ultimate holding entity. * `SUBSIDIARY`: The legal entity is considered a subsidiary, fully or partially held by another. * `BRANCH`: The legal entity is considered a branch, associated with a parent legal entity.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_name": { "description": "The legal name of the legal entity.", "type": "string" }, "mailing_address": { "description": "The mailing address of the legal entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "management_type": { "description": "The legal entity management type in the case of an employer of record (EOR) or professional employment organization (PEO). * `PEO`: The legal entity is considered a Professional Employment Organization (PEO). * `EOR`: The legal entity is considered an Employer of Record (EOR).", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The parent legal entity.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent legal entity.", "type": "string" }, "physical_address": { "description": "The physical address of the legal entity, if it differs from the mailing address.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "registration_date": { "description": "The registration date of the entity.", "type": "string" }, "tax_identifier": { "description": "The tax identifier for the legal entity.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "LegalEntity", "type": "object" }, "legal_entity_id": { "description": "The worker's associated legal entity.", "type": "string" }, "level": { "description": "The level of the worker.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "description": { "description": "The description of the level.", "type": "string" }, "experience_requirements": { "description": "The experience requirements for the level.", "type": "string" }, "global_level": { "anyOf": [ { "description": "Global level is used to track the seniority of levels. The higher up a level is placed on the page, the more senior and higher-ranked the level. Global level is used in workflows, policies, and reports that use the level attribute (e.g., you can use Level Lookup to set up a workflow that notifies the nearest person in an worker's management chain at or above the specified level).", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the level. Must be unique within the company or organization.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLevel", "description": "The parent level.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent level.", "type": "string" }, "rank": { "anyOf": [ { "description": "The rank of the level within its track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "scope_of_responsibilities": { "description": "The scope of responsibilities for the level.", "type": "string" }, "track": { "description": "The track associated with the level, if it's not a global level.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_default": { "description": "Whether this is the company's default track.", "type": "boolean" }, "name": { "description": "The name of the track. Must be unique within the company or organization.", "type": "string" }, "order": { "anyOf": [ { "description": "The one-based horizontal display order of the track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "start_global_level": { "anyOf": [ { "description": "The highest global level occupied by this track. Empty tracks return null.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Track", "type": "object" }, "track_id": { "description": "The track associated with the level. Required during creation. Include global_level when changing it.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Level", "type": "object" }, "level_id": { "description": "The level of the worker.", "type": "string" }, "location": { "description": "The location that the worker is mapped to for tax purposes. In the case that a worker is remote, the location's type is remote.", "properties": { "type": { "description": "The type of location.", "type": "string" }, "work_location_id": { "description": "The work location, if the worker isn't remote.", "type": "string" } }, "required": [ "type", "work_location_id" ], "title": "WorkerLocation", "type": "object" }, "manager": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's manager.\n\nExpandable field", "type": "object" }, "manager_id": { "description": "The worker's manager.", "type": "string" }, "number": { "anyOf": [ { "description": "The worker's number within the organization.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "original_start_date": { "description": "The worker's earliest start date across their employment history, excluding INIT roles.", "type": "string" }, "overtime_exemption": { "description": "The worker's overtime exemption status.", "type": "string" }, "pay_schedule_id": { "description": "The ID of the pay schedule currently associated with the worker.", "type": "string" }, "personal_email": { "description": "The worker's associated personal email address.", "type": "string" }, "race": { "description": "The identified race of the worker, if specified.", "type": "string" }, "start_date": { "description": "The start date of the worker.", "type": "string" }, "status": { "description": "The worker's status within the organization.", "type": "string" }, "teams": { "description": "The worker's assigned teams.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiTeamcb26bc28f32f" }, "type": "array" }, "teams_id": { "description": "The worker's assigned teams.", "items": { "type": "string" }, "type": "array" }, "termination_details": { "description": "The details of the worker's termination, if applicable.", "properties": { "reason": { "description": "This is a description that will be custom to each Rippling company.", "type": "string" }, "type": { "description": "The termination type indicates whether the termination was voluntary or involuntary.", "type": "string" } }, "title": "TerminationDetails", "type": "object" }, "title": { "description": "The worker's title.", "type": "string" }, "title_effective_date": { "description": "Title effective date", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "user": { "description": "The worker's associated user.\n\nExpandable field", "properties": { "active": { "description": "Whether the user is able to access company resources, typically when they are in actively engaged with the company and not after off-boarding.", "type": "boolean" }, "addresses": { "description": "The user's addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiUserAddressedd59b9ba9a1" }, "type": "array" }, "created_at": { "description": "Record creation date", "type": "string" }, "display_name": { "description": "The display name of the user using either the concatenated preferred given and family name or username depending on availability.", "type": "string" }, "emails": { "description": "The user's email addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiEmail5284c8258dc3" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "locale": { "description": "The User's default location for purposes of localization of currency, date time format, or numerical representations pursuant to RFC5646.", "type": "string" }, "name": { "description": "The user's name.", "properties": { "family_name": { "description": "The legal family name of the user, or last name in most Western languages.", "type": "string" }, "formatted": { "description": "The user's full name.", "type": "string" }, "given_name": { "description": "The given legal name of the user, or first name in most Western languages.", "type": "string" }, "middle_name": { "description": "The middle name(s) of the user.", "type": "string" }, "preferred_family_name": { "description": "The preferred family name, or last name in most Western languages, by the user.", "type": "string" }, "preferred_given_name": { "description": "The preferred given name, or first name in most Western languages, by the user.", "type": "string" } }, "title": "UserName", "type": "object" }, "number": { "description": "The permanent profile number of the user.", "type": "string" }, "phone_numbers": { "description": "The user's phone numbers.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoneNumber12060c61ecf5" }, "type": "array" }, "photos": { "description": "The user's photos.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoto2be7c3ae3f39" }, "type": "array" }, "preferred_language": { "description": "The User's preferred written or spoken language in the same format of the HTTP Accept-Language header, pursuant to Section 5.3.5 of RFC7231.", "type": "string" }, "timezone": { "description": "The User's current time zone in IANA database Olson format", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "username": { "description": "The unique identifier across Rippling used by the User for direct authentication into their associated company. Globally unique.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "User", "type": "object" }, "user_id": { "description": "The worker's associated user.", "type": "string" }, "work_email": { "description": "The worker's associated work email address.", "type": "string" }, "work_schedule": { "additionalProperties": { "$ref": "#/components/schemas/OutputRestApiWorkScheduleDay938f88d94f20" }, "description": "The worker's scheduled working hours for each day of the week.", "type": "object" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Worker", "type": "object" }, "reviewer_id": { "description": "The ID of the worker who reviewed the leave request.", "type": "string" }, "start_date": { "description": "The start date of the leave request.", "type": "string" }, "start_time": { "description": "The start time of the leave request.", "type": "string" }, "status": { "description": "The status of the leave request.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "worker": { "description": "The worker associated with the leave request.\n\nExpandable field", "properties": { "business_partners": { "description": "Worker's assigned business partners. This field is only populated when explicitly requested via the expand parameter (e.g., ?expand=business_partners). When expanded, returns an empty list ([]) if the worker has no business partners.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiBusinessPartner77b00a069c32" }, "type": "array" }, "business_partners_id": { "description": "Worker's assigned business partners unique identifiers. Returns an empty list ([]) if the worker has no business partners.", "items": { "type": "string" }, "type": "array" }, "citizenship": { "description": "The countries that the worker has citizenship in.", "type": "string" }, "compensation": { "description": "The compensation package for the worker.\n\nExpandable field", "properties": { "annual_compensation": { "description": "The worker's annual compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "annual_salary_equivalent": { "description": "The worker's annual salary equivalent, for insurance purposes. It will be equal to the worker's annual compensation, except for owners that are receiving no cashcompensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "bonus_schedule": { "description": "The worker's bonus schedule.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "hourly_wage": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "id": { "description": "Identifier field", "type": "string" }, "monthly_compensation": { "description": "The worker's monthly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "on_target_commission": { "description": "The worker's on-target commission.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "payment_terms": { "description": "The payment terms for an worker's compensation.", "type": "string" }, "payment_type": { "description": "The payment type for an worker's compensation.", "type": "string" }, "relocation_reimbursement": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "salary_effective_date": { "description": "Salary effective date", "type": "string" }, "signing_bonus": { "description": "The worker's signing bonus.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus": { "description": "The worker's target annual bonus amount.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus_percent": { "anyOf": [ { "description": "The worker's target annual bonus as a percent of annual compensation.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" }, "weekly_compensation": { "description": "The worker's weekly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "worker": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's details.\n\nExpandable field", "type": "object" }, "worker_id": { "description": "The worker's ID.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Compensation", "type": "object" }, "compensation_grade": { "description": "The compensation grade assigned to the worker, if any.", "properties": { "id": { "description": "The compensation grade's unique identifier.", "type": "string" }, "label": { "description": "The compensation grade's label.", "type": "string" } }, "title": "WorkerCompensationGrade", "type": "object" }, "compensation_id": { "description": "The compensation package for the worker.", "type": "string" }, "country": { "description": "The worker's country.", "type": "string" }, "country_fields": { "description": "Country level fields for the worker.", "properties": { "ca": { "description": "Country-wise regional fields for Canada", "properties": { "sin": { "description": "Social Insurance Number (SIN) for Canada employees.", "type": "string" } }, "title": "CanadaFields", "type": "object" }, "nz": { "description": "Country-wise regional fields for New Zealand", "properties": { "ird_number": { "description": "Inland Revenue Department (IRD) number for New Zealand employees.", "type": "string" } }, "title": "NewZealandFields", "type": "object" }, "us": { "description": "Country-wise regional fields for USA", "properties": { "ssn": { "description": "Social Security Number (SSN) for US employees.", "type": "string" } }, "title": "USFields", "type": "object" } }, "title": "CountryFields", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "custom_fields": { "description": "Custom field values defined on the Employee object for this worker\n\nExpandable field", "items": { "additionalProperties": {} }, "type": "array" }, "date_of_birth": { "description": "The worker's date of birth.", "type": "string" }, "department": { "description": "The worker's assigned department.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "department_hierarchy": { "description": "List of departments in the department hierarchy. Refer department_hierarchy_ids for department hierarchy order.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestDepartment" }, "type": "array" }, "department_hierarchy_id": { "description": "The identifier of departments in the department hierarchy ordered from parent department to child department.", "items": { "type": "string" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the department.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestDepartment", "description": "The parent department.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent department.", "type": "string" }, "reference_code": { "description": "Reference code of the department.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Department", "type": "object" }, "department_id": { "description": "The worker's assigned department.", "type": "string" }, "employment_type": { "description": "The worker's employment type.\n\nExpandable field", "properties": { "amount_worked": { "description": "The amount worked for the employment type. * `FULL-TIME`: Full-time is at least 30 hours per week. Full-time workers will typically be eligible for benefits. * `PART-TIME`: Part-time is less than 30 hours per week. These workers may be eligible for benefits, depending on company settings and hours worked. * `TEMPORARY`: These workers are hired on a temporary basis. You can specify how each worker with this employment type will be paid individually.", "type": "string" }, "compensation_time_period": { "description": "The compensation period for the employment type. * `SALARIED`: Employees that are paid a fixed amount per year. * `HOURLY`: Employees that are paid a wage per hour worked.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "label": { "description": "The display label of the employment type.", "type": "string" }, "name": { "description": "The name of the employment type for non-custom employment types.", "type": "string" }, "type": { "description": "The classification of the worker by the company. * `CONTRACTOR`: Contractors are self-employed workers who provide services on a short-term or per-project basis and are not eligible for tax-withholding or benefits. * `EMPLOYEE`: Employees are hired and managed by an employer, work under the employer's direct supervision and control, and are protected by law for wages and employment rights.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "label", "updated_at" ], "title": "CompanyEmploymentType", "type": "object" }, "employment_type_id": { "description": "The worker's employment type.", "type": "string" }, "end_date": { "description": "The end date of the worker.", "type": "string" }, "ethnicity": { "description": "The identified ethnicity of the worker, if specified.", "type": "string" }, "gender": { "description": "The gender of the worker, if specified.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_manager": { "description": "Whether the worker is a manager", "type": "boolean" }, "job_function": { "description": "The worker's job function. When expanded, this field requires `job-functions.read`.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "Displayed name of the job function", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "JobFunction", "type": "object" }, "job_function_id": { "description": "ID of the worker's job function.", "type": "string" }, "legal_entity": { "description": "The worker's associated legal entity.\n\nExpandable field", "properties": { "company": { "description": "The company or organization associated with the legal entity\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "doing_business_as_name": { "description": "The doing business as name for the company.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_entities": { "description": "A list of the company's entities.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestLegalEntity" }, "type": "array" }, "legal_entities_id": { "description": "A list of the company's entities.", "items": { "type": "string" }, "type": "array" }, "legal_name": { "description": "The legal name of the company.", "type": "string" }, "name": { "description": "The name of the company.", "type": "string" }, "parent_legal_entity": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The company's ultimate holding entity.\n\nExpandable field", "type": "object" }, "parent_legal_entity_id": { "description": "The company's ultimate holding entity.", "type": "string" }, "phone": { "description": "The phone number for the company.", "type": "string" }, "physical_address": { "description": "The physical address of the holding entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "primary_email": { "description": "The email address used when registering this company.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "legal_entities", "legal_entities_id", "name", "updated_at" ], "title": "Company", "type": "object" }, "company_id": { "description": "The company or organization associated with the legal entity", "type": "string" }, "country": { "description": "The country the legal entity is based in.", "properties": { "code": { "description": "The code of the country.", "type": "string" } }, "required": [ "code" ], "title": "Country", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "entity_level": { "description": "The legal entity's level in a hierarchy. * `PARENT`: The legal entity is considered the ultimate holding entity. * `SUBSIDIARY`: The legal entity is considered a subsidiary, fully or partially held by another. * `BRANCH`: The legal entity is considered a branch, associated with a parent legal entity.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_name": { "description": "The legal name of the legal entity.", "type": "string" }, "mailing_address": { "description": "The mailing address of the legal entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "management_type": { "description": "The legal entity management type in the case of an employer of record (EOR) or professional employment organization (PEO). * `PEO`: The legal entity is considered a Professional Employment Organization (PEO). * `EOR`: The legal entity is considered an Employer of Record (EOR).", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The parent legal entity.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent legal entity.", "type": "string" }, "physical_address": { "description": "The physical address of the legal entity, if it differs from the mailing address.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "registration_date": { "description": "The registration date of the entity.", "type": "string" }, "tax_identifier": { "description": "The tax identifier for the legal entity.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "LegalEntity", "type": "object" }, "legal_entity_id": { "description": "The worker's associated legal entity.", "type": "string" }, "level": { "description": "The level of the worker.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "description": { "description": "The description of the level.", "type": "string" }, "experience_requirements": { "description": "The experience requirements for the level.", "type": "string" }, "global_level": { "anyOf": [ { "description": "Global level is used to track the seniority of levels. The higher up a level is placed on the page, the more senior and higher-ranked the level. Global level is used in workflows, policies, and reports that use the level attribute (e.g., you can use Level Lookup to set up a workflow that notifies the nearest person in an worker's management chain at or above the specified level).", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the level. Must be unique within the company or organization.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLevel", "description": "The parent level.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent level.", "type": "string" }, "rank": { "anyOf": [ { "description": "The rank of the level within its track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "scope_of_responsibilities": { "description": "The scope of responsibilities for the level.", "type": "string" }, "track": { "description": "The track associated with the level, if it's not a global level.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_default": { "description": "Whether this is the company's default track.", "type": "boolean" }, "name": { "description": "The name of the track. Must be unique within the company or organization.", "type": "string" }, "order": { "anyOf": [ { "description": "The one-based horizontal display order of the track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "start_global_level": { "anyOf": [ { "description": "The highest global level occupied by this track. Empty tracks return null.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Track", "type": "object" }, "track_id": { "description": "The track associated with the level. Required during creation. Include global_level when changing it.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Level", "type": "object" }, "level_id": { "description": "The level of the worker.", "type": "string" }, "location": { "description": "The location that the worker is mapped to for tax purposes. In the case that a worker is remote, the location's type is remote.", "properties": { "type": { "description": "The type of location.", "type": "string" }, "work_location_id": { "description": "The work location, if the worker isn't remote.", "type": "string" } }, "required": [ "type", "work_location_id" ], "title": "WorkerLocation", "type": "object" }, "manager": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's manager.\n\nExpandable field", "type": "object" }, "manager_id": { "description": "The worker's manager.", "type": "string" }, "number": { "anyOf": [ { "description": "The worker's number within the organization.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "original_start_date": { "description": "The worker's earliest start date across their employment history, excluding INIT roles.", "type": "string" }, "overtime_exemption": { "description": "The worker's overtime exemption status.", "type": "string" }, "pay_schedule_id": { "description": "The ID of the pay schedule currently associated with the worker.", "type": "string" }, "personal_email": { "description": "The worker's associated personal email address.", "type": "string" }, "race": { "description": "The identified race of the worker, if specified.", "type": "string" }, "start_date": { "description": "The start date of the worker.", "type": "string" }, "status": { "description": "The worker's status within the organization.", "type": "string" }, "teams": { "description": "The worker's assigned teams.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiTeamcb26bc28f32f" }, "type": "array" }, "teams_id": { "description": "The worker's assigned teams.", "items": { "type": "string" }, "type": "array" }, "termination_details": { "description": "The details of the worker's termination, if applicable.", "properties": { "reason": { "description": "This is a description that will be custom to each Rippling company.", "type": "string" }, "type": { "description": "The termination type indicates whether the termination was voluntary or involuntary.", "type": "string" } }, "title": "TerminationDetails", "type": "object" }, "title": { "description": "The worker's title.", "type": "string" }, "title_effective_date": { "description": "Title effective date", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "user": { "description": "The worker's associated user.\n\nExpandable field", "properties": { "active": { "description": "Whether the user is able to access company resources, typically when they are in actively engaged with the company and not after off-boarding.", "type": "boolean" }, "addresses": { "description": "The user's addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiUserAddressedd59b9ba9a1" }, "type": "array" }, "created_at": { "description": "Record creation date", "type": "string" }, "display_name": { "description": "The display name of the user using either the concatenated preferred given and family name or username depending on availability.", "type": "string" }, "emails": { "description": "The user's email addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiEmail5284c8258dc3" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "locale": { "description": "The User's default location for purposes of localization of currency, date time format, or numerical representations pursuant to RFC5646.", "type": "string" }, "name": { "description": "The user's name.", "properties": { "family_name": { "description": "The legal family name of the user, or last name in most Western languages.", "type": "string" }, "formatted": { "description": "The user's full name.", "type": "string" }, "given_name": { "description": "The given legal name of the user, or first name in most Western languages.", "type": "string" }, "middle_name": { "description": "The middle name(s) of the user.", "type": "string" }, "preferred_family_name": { "description": "The preferred family name, or last name in most Western languages, by the user.", "type": "string" }, "preferred_given_name": { "description": "The preferred given name, or first name in most Western languages, by the user.", "type": "string" } }, "title": "UserName", "type": "object" }, "number": { "description": "The permanent profile number of the user.", "type": "string" }, "phone_numbers": { "description": "The user's phone numbers.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoneNumber12060c61ecf5" }, "type": "array" }, "photos": { "description": "The user's photos.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoto2be7c3ae3f39" }, "type": "array" }, "preferred_language": { "description": "The User's preferred written or spoken language in the same format of the HTTP Accept-Language header, pursuant to Section 5.3.5 of RFC7231.", "type": "string" }, "timezone": { "description": "The User's current time zone in IANA database Olson format", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "username": { "description": "The unique identifier across Rippling used by the User for direct authentication into their associated company. Globally unique.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "User", "type": "object" }, "user_id": { "description": "The worker's associated user.", "type": "string" }, "work_email": { "description": "The worker's associated work email address.", "type": "string" }, "work_schedule": { "additionalProperties": { "$ref": "#/components/schemas/OutputRestApiWorkScheduleDay938f88d94f20" }, "description": "The worker's scheduled working hours for each day of the week.", "type": "object" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Worker", "type": "object" }, "worker_id": { "description": "The ID of the worker associated with the leave request.", "type": "string" } }, "required": [ "created_at", "end_date", "id", "start_date", "status", "updated_at", "worker_id" ], "title": "LeaveRequest", "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Create a new leave request", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "leave-requests.read-write" ] } }, "/leave-requests/{id}/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/get-leave-requests" }, "operationId": "rippling.rest_api.get_leave_requests", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "id", "type": "string" } }, { "in": "query", "name": "expand", "required": false, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "__meta": { "properties": { "redacted_fields": { "items": { "$ref": "#/components/schemas/OutputRestApiRedactedField21788a25ef22" }, "type": "array" } }, "type": "object" }, "comments": { "description": "The comments associated with the leave request.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "days_take_off": { "description": "The specific dates taken off and the amount of time taken off for each one.", "items": { "$ref": "#/components/schemas/OutputRestApiDayOff9e4b21f07f8d" }, "type": "array" }, "end_date": { "description": "The end date of the leave request.", "type": "string" }, "end_time": { "description": "The end time of the leave request.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_managed_by_external_system": { "description": "Whether the leave request is managed by an external system.", "type": "boolean" }, "leave_event_id": { "description": "The ID of the leave event associated with the leave request, if any.", "type": "string" }, "leave_policy_id": { "description": "The ID of the leave policy associated with the leave request, either leave_policy_id or leave_type_id must be provided.", "type": "string" }, "leave_type": { "description": "The leave type associated with the leave request.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "description": { "description": "The description of the leave type.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_managed_by_external_system": { "description": "Whether the leave is managed by an external system.", "type": "boolean" }, "is_paid": { "description": "Whether the leave is paid.", "type": "boolean" }, "name": { "description": "The name of the leave type.", "type": "string" }, "type": { "description": "The type of leave.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "is_managed_by_external_system", "is_paid", "name", "type", "updated_at" ], "title": "LeaveType", "type": "object" }, "leave_type_id": { "description": "The ID of the leave type associated with the leave request, either leave_policy_id or leave_type_id must be provided.", "type": "string" }, "number_of_minutes_requested": { "anyOf": [ { "description": "The number of minutes requested for the leave request.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "reason_for_leave": { "description": "The reason for the leave request.", "type": "string" }, "requester": { "description": "The worker who requested the leave request.\n\nExpandable field", "properties": { "business_partners": { "description": "Worker's assigned business partners. This field is only populated when explicitly requested via the expand parameter (e.g., ?expand=business_partners). When expanded, returns an empty list ([]) if the worker has no business partners.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiBusinessPartner77b00a069c32" }, "type": "array" }, "business_partners_id": { "description": "Worker's assigned business partners unique identifiers. Returns an empty list ([]) if the worker has no business partners.", "items": { "type": "string" }, "type": "array" }, "citizenship": { "description": "The countries that the worker has citizenship in.", "type": "string" }, "compensation": { "description": "The compensation package for the worker.\n\nExpandable field", "properties": { "annual_compensation": { "description": "The worker's annual compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "annual_salary_equivalent": { "description": "The worker's annual salary equivalent, for insurance purposes. It will be equal to the worker's annual compensation, except for owners that are receiving no cashcompensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "bonus_schedule": { "description": "The worker's bonus schedule.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "hourly_wage": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "id": { "description": "Identifier field", "type": "string" }, "monthly_compensation": { "description": "The worker's monthly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "on_target_commission": { "description": "The worker's on-target commission.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "payment_terms": { "description": "The payment terms for an worker's compensation.", "type": "string" }, "payment_type": { "description": "The payment type for an worker's compensation.", "type": "string" }, "relocation_reimbursement": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "salary_effective_date": { "description": "Salary effective date", "type": "string" }, "signing_bonus": { "description": "The worker's signing bonus.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus": { "description": "The worker's target annual bonus amount.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus_percent": { "anyOf": [ { "description": "The worker's target annual bonus as a percent of annual compensation.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" }, "weekly_compensation": { "description": "The worker's weekly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "worker": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's details.\n\nExpandable field", "type": "object" }, "worker_id": { "description": "The worker's ID.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Compensation", "type": "object" }, "compensation_grade": { "description": "The compensation grade assigned to the worker, if any.", "properties": { "id": { "description": "The compensation grade's unique identifier.", "type": "string" }, "label": { "description": "The compensation grade's label.", "type": "string" } }, "title": "WorkerCompensationGrade", "type": "object" }, "compensation_id": { "description": "The compensation package for the worker.", "type": "string" }, "country": { "description": "The worker's country.", "type": "string" }, "country_fields": { "description": "Country level fields for the worker.", "properties": { "ca": { "description": "Country-wise regional fields for Canada", "properties": { "sin": { "description": "Social Insurance Number (SIN) for Canada employees.", "type": "string" } }, "title": "CanadaFields", "type": "object" }, "nz": { "description": "Country-wise regional fields for New Zealand", "properties": { "ird_number": { "description": "Inland Revenue Department (IRD) number for New Zealand employees.", "type": "string" } }, "title": "NewZealandFields", "type": "object" }, "us": { "description": "Country-wise regional fields for USA", "properties": { "ssn": { "description": "Social Security Number (SSN) for US employees.", "type": "string" } }, "title": "USFields", "type": "object" } }, "title": "CountryFields", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "custom_fields": { "description": "Custom field values defined on the Employee object for this worker\n\nExpandable field", "items": { "additionalProperties": {} }, "type": "array" }, "date_of_birth": { "description": "The worker's date of birth.", "type": "string" }, "department": { "description": "The worker's assigned department.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "department_hierarchy": { "description": "List of departments in the department hierarchy. Refer department_hierarchy_ids for department hierarchy order.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestDepartment" }, "type": "array" }, "department_hierarchy_id": { "description": "The identifier of departments in the department hierarchy ordered from parent department to child department.", "items": { "type": "string" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the department.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestDepartment", "description": "The parent department.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent department.", "type": "string" }, "reference_code": { "description": "Reference code of the department.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Department", "type": "object" }, "department_id": { "description": "The worker's assigned department.", "type": "string" }, "employment_type": { "description": "The worker's employment type.\n\nExpandable field", "properties": { "amount_worked": { "description": "The amount worked for the employment type. * `FULL-TIME`: Full-time is at least 30 hours per week. Full-time workers will typically be eligible for benefits. * `PART-TIME`: Part-time is less than 30 hours per week. These workers may be eligible for benefits, depending on company settings and hours worked. * `TEMPORARY`: These workers are hired on a temporary basis. You can specify how each worker with this employment type will be paid individually.", "type": "string" }, "compensation_time_period": { "description": "The compensation period for the employment type. * `SALARIED`: Employees that are paid a fixed amount per year. * `HOURLY`: Employees that are paid a wage per hour worked.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "label": { "description": "The display label of the employment type.", "type": "string" }, "name": { "description": "The name of the employment type for non-custom employment types.", "type": "string" }, "type": { "description": "The classification of the worker by the company. * `CONTRACTOR`: Contractors are self-employed workers who provide services on a short-term or per-project basis and are not eligible for tax-withholding or benefits. * `EMPLOYEE`: Employees are hired and managed by an employer, work under the employer's direct supervision and control, and are protected by law for wages and employment rights.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "label", "updated_at" ], "title": "CompanyEmploymentType", "type": "object" }, "employment_type_id": { "description": "The worker's employment type.", "type": "string" }, "end_date": { "description": "The end date of the worker.", "type": "string" }, "ethnicity": { "description": "The identified ethnicity of the worker, if specified.", "type": "string" }, "gender": { "description": "The gender of the worker, if specified.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_manager": { "description": "Whether the worker is a manager", "type": "boolean" }, "job_function": { "description": "The worker's job function. When expanded, this field requires `job-functions.read`.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "Displayed name of the job function", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "JobFunction", "type": "object" }, "job_function_id": { "description": "ID of the worker's job function.", "type": "string" }, "legal_entity": { "description": "The worker's associated legal entity.\n\nExpandable field", "properties": { "company": { "description": "The company or organization associated with the legal entity\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "doing_business_as_name": { "description": "The doing business as name for the company.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_entities": { "description": "A list of the company's entities.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestLegalEntity" }, "type": "array" }, "legal_entities_id": { "description": "A list of the company's entities.", "items": { "type": "string" }, "type": "array" }, "legal_name": { "description": "The legal name of the company.", "type": "string" }, "name": { "description": "The name of the company.", "type": "string" }, "parent_legal_entity": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The company's ultimate holding entity.\n\nExpandable field", "type": "object" }, "parent_legal_entity_id": { "description": "The company's ultimate holding entity.", "type": "string" }, "phone": { "description": "The phone number for the company.", "type": "string" }, "physical_address": { "description": "The physical address of the holding entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "primary_email": { "description": "The email address used when registering this company.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "legal_entities", "legal_entities_id", "name", "updated_at" ], "title": "Company", "type": "object" }, "company_id": { "description": "The company or organization associated with the legal entity", "type": "string" }, "country": { "description": "The country the legal entity is based in.", "properties": { "code": { "description": "The code of the country.", "type": "string" } }, "required": [ "code" ], "title": "Country", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "entity_level": { "description": "The legal entity's level in a hierarchy. * `PARENT`: The legal entity is considered the ultimate holding entity. * `SUBSIDIARY`: The legal entity is considered a subsidiary, fully or partially held by another. * `BRANCH`: The legal entity is considered a branch, associated with a parent legal entity.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_name": { "description": "The legal name of the legal entity.", "type": "string" }, "mailing_address": { "description": "The mailing address of the legal entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "management_type": { "description": "The legal entity management type in the case of an employer of record (EOR) or professional employment organization (PEO). * `PEO`: The legal entity is considered a Professional Employment Organization (PEO). * `EOR`: The legal entity is considered an Employer of Record (EOR).", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The parent legal entity.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent legal entity.", "type": "string" }, "physical_address": { "description": "The physical address of the legal entity, if it differs from the mailing address.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "registration_date": { "description": "The registration date of the entity.", "type": "string" }, "tax_identifier": { "description": "The tax identifier for the legal entity.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "LegalEntity", "type": "object" }, "legal_entity_id": { "description": "The worker's associated legal entity.", "type": "string" }, "level": { "description": "The level of the worker.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "description": { "description": "The description of the level.", "type": "string" }, "experience_requirements": { "description": "The experience requirements for the level.", "type": "string" }, "global_level": { "anyOf": [ { "description": "Global level is used to track the seniority of levels. The higher up a level is placed on the page, the more senior and higher-ranked the level. Global level is used in workflows, policies, and reports that use the level attribute (e.g., you can use Level Lookup to set up a workflow that notifies the nearest person in an worker's management chain at or above the specified level).", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the level. Must be unique within the company or organization.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLevel", "description": "The parent level.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent level.", "type": "string" }, "rank": { "anyOf": [ { "description": "The rank of the level within its track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "scope_of_responsibilities": { "description": "The scope of responsibilities for the level.", "type": "string" }, "track": { "description": "The track associated with the level, if it's not a global level.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_default": { "description": "Whether this is the company's default track.", "type": "boolean" }, "name": { "description": "The name of the track. Must be unique within the company or organization.", "type": "string" }, "order": { "anyOf": [ { "description": "The one-based horizontal display order of the track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "start_global_level": { "anyOf": [ { "description": "The highest global level occupied by this track. Empty tracks return null.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Track", "type": "object" }, "track_id": { "description": "The track associated with the level. Required during creation. Include global_level when changing it.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Level", "type": "object" }, "level_id": { "description": "The level of the worker.", "type": "string" }, "location": { "description": "The location that the worker is mapped to for tax purposes. In the case that a worker is remote, the location's type is remote.", "properties": { "type": { "description": "The type of location.", "type": "string" }, "work_location_id": { "description": "The work location, if the worker isn't remote.", "type": "string" } }, "required": [ "type", "work_location_id" ], "title": "WorkerLocation", "type": "object" }, "manager": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's manager.\n\nExpandable field", "type": "object" }, "manager_id": { "description": "The worker's manager.", "type": "string" }, "number": { "anyOf": [ { "description": "The worker's number within the organization.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "original_start_date": { "description": "The worker's earliest start date across their employment history, excluding INIT roles.", "type": "string" }, "overtime_exemption": { "description": "The worker's overtime exemption status.", "type": "string" }, "pay_schedule_id": { "description": "The ID of the pay schedule currently associated with the worker.", "type": "string" }, "personal_email": { "description": "The worker's associated personal email address.", "type": "string" }, "race": { "description": "The identified race of the worker, if specified.", "type": "string" }, "start_date": { "description": "The start date of the worker.", "type": "string" }, "status": { "description": "The worker's status within the organization.", "type": "string" }, "teams": { "description": "The worker's assigned teams.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiTeamcb26bc28f32f" }, "type": "array" }, "teams_id": { "description": "The worker's assigned teams.", "items": { "type": "string" }, "type": "array" }, "termination_details": { "description": "The details of the worker's termination, if applicable.", "properties": { "reason": { "description": "This is a description that will be custom to each Rippling company.", "type": "string" }, "type": { "description": "The termination type indicates whether the termination was voluntary or involuntary.", "type": "string" } }, "title": "TerminationDetails", "type": "object" }, "title": { "description": "The worker's title.", "type": "string" }, "title_effective_date": { "description": "Title effective date", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "user": { "description": "The worker's associated user.\n\nExpandable field", "properties": { "active": { "description": "Whether the user is able to access company resources, typically when they are in actively engaged with the company and not after off-boarding.", "type": "boolean" }, "addresses": { "description": "The user's addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiUserAddressedd59b9ba9a1" }, "type": "array" }, "created_at": { "description": "Record creation date", "type": "string" }, "display_name": { "description": "The display name of the user using either the concatenated preferred given and family name or username depending on availability.", "type": "string" }, "emails": { "description": "The user's email addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiEmail5284c8258dc3" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "locale": { "description": "The User's default location for purposes of localization of currency, date time format, or numerical representations pursuant to RFC5646.", "type": "string" }, "name": { "description": "The user's name.", "properties": { "family_name": { "description": "The legal family name of the user, or last name in most Western languages.", "type": "string" }, "formatted": { "description": "The user's full name.", "type": "string" }, "given_name": { "description": "The given legal name of the user, or first name in most Western languages.", "type": "string" }, "middle_name": { "description": "The middle name(s) of the user.", "type": "string" }, "preferred_family_name": { "description": "The preferred family name, or last name in most Western languages, by the user.", "type": "string" }, "preferred_given_name": { "description": "The preferred given name, or first name in most Western languages, by the user.", "type": "string" } }, "title": "UserName", "type": "object" }, "number": { "description": "The permanent profile number of the user.", "type": "string" }, "phone_numbers": { "description": "The user's phone numbers.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoneNumber12060c61ecf5" }, "type": "array" }, "photos": { "description": "The user's photos.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoto2be7c3ae3f39" }, "type": "array" }, "preferred_language": { "description": "The User's preferred written or spoken language in the same format of the HTTP Accept-Language header, pursuant to Section 5.3.5 of RFC7231.", "type": "string" }, "timezone": { "description": "The User's current time zone in IANA database Olson format", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "username": { "description": "The unique identifier across Rippling used by the User for direct authentication into their associated company. Globally unique.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "User", "type": "object" }, "user_id": { "description": "The worker's associated user.", "type": "string" }, "work_email": { "description": "The worker's associated work email address.", "type": "string" }, "work_schedule": { "additionalProperties": { "$ref": "#/components/schemas/OutputRestApiWorkScheduleDay938f88d94f20" }, "description": "The worker's scheduled working hours for each day of the week.", "type": "object" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Worker", "type": "object" }, "requester_id": { "description": "The ID of the worker who requested the leave request.", "type": "string" }, "reviewed_at": { "description": "The timestamp of when the leave request was reviewed.", "type": "string" }, "reviewer": { "description": "The worker who reviewed the leave request.\n\nExpandable field", "properties": { "business_partners": { "description": "Worker's assigned business partners. This field is only populated when explicitly requested via the expand parameter (e.g., ?expand=business_partners). When expanded, returns an empty list ([]) if the worker has no business partners.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiBusinessPartner77b00a069c32" }, "type": "array" }, "business_partners_id": { "description": "Worker's assigned business partners unique identifiers. Returns an empty list ([]) if the worker has no business partners.", "items": { "type": "string" }, "type": "array" }, "citizenship": { "description": "The countries that the worker has citizenship in.", "type": "string" }, "compensation": { "description": "The compensation package for the worker.\n\nExpandable field", "properties": { "annual_compensation": { "description": "The worker's annual compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "annual_salary_equivalent": { "description": "The worker's annual salary equivalent, for insurance purposes. It will be equal to the worker's annual compensation, except for owners that are receiving no cashcompensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "bonus_schedule": { "description": "The worker's bonus schedule.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "hourly_wage": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "id": { "description": "Identifier field", "type": "string" }, "monthly_compensation": { "description": "The worker's monthly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "on_target_commission": { "description": "The worker's on-target commission.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "payment_terms": { "description": "The payment terms for an worker's compensation.", "type": "string" }, "payment_type": { "description": "The payment type for an worker's compensation.", "type": "string" }, "relocation_reimbursement": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "salary_effective_date": { "description": "Salary effective date", "type": "string" }, "signing_bonus": { "description": "The worker's signing bonus.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus": { "description": "The worker's target annual bonus amount.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus_percent": { "anyOf": [ { "description": "The worker's target annual bonus as a percent of annual compensation.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" }, "weekly_compensation": { "description": "The worker's weekly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "worker": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's details.\n\nExpandable field", "type": "object" }, "worker_id": { "description": "The worker's ID.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Compensation", "type": "object" }, "compensation_grade": { "description": "The compensation grade assigned to the worker, if any.", "properties": { "id": { "description": "The compensation grade's unique identifier.", "type": "string" }, "label": { "description": "The compensation grade's label.", "type": "string" } }, "title": "WorkerCompensationGrade", "type": "object" }, "compensation_id": { "description": "The compensation package for the worker.", "type": "string" }, "country": { "description": "The worker's country.", "type": "string" }, "country_fields": { "description": "Country level fields for the worker.", "properties": { "ca": { "description": "Country-wise regional fields for Canada", "properties": { "sin": { "description": "Social Insurance Number (SIN) for Canada employees.", "type": "string" } }, "title": "CanadaFields", "type": "object" }, "nz": { "description": "Country-wise regional fields for New Zealand", "properties": { "ird_number": { "description": "Inland Revenue Department (IRD) number for New Zealand employees.", "type": "string" } }, "title": "NewZealandFields", "type": "object" }, "us": { "description": "Country-wise regional fields for USA", "properties": { "ssn": { "description": "Social Security Number (SSN) for US employees.", "type": "string" } }, "title": "USFields", "type": "object" } }, "title": "CountryFields", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "custom_fields": { "description": "Custom field values defined on the Employee object for this worker\n\nExpandable field", "items": { "additionalProperties": {} }, "type": "array" }, "date_of_birth": { "description": "The worker's date of birth.", "type": "string" }, "department": { "description": "The worker's assigned department.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "department_hierarchy": { "description": "List of departments in the department hierarchy. Refer department_hierarchy_ids for department hierarchy order.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestDepartment" }, "type": "array" }, "department_hierarchy_id": { "description": "The identifier of departments in the department hierarchy ordered from parent department to child department.", "items": { "type": "string" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the department.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestDepartment", "description": "The parent department.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent department.", "type": "string" }, "reference_code": { "description": "Reference code of the department.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Department", "type": "object" }, "department_id": { "description": "The worker's assigned department.", "type": "string" }, "employment_type": { "description": "The worker's employment type.\n\nExpandable field", "properties": { "amount_worked": { "description": "The amount worked for the employment type. * `FULL-TIME`: Full-time is at least 30 hours per week. Full-time workers will typically be eligible for benefits. * `PART-TIME`: Part-time is less than 30 hours per week. These workers may be eligible for benefits, depending on company settings and hours worked. * `TEMPORARY`: These workers are hired on a temporary basis. You can specify how each worker with this employment type will be paid individually.", "type": "string" }, "compensation_time_period": { "description": "The compensation period for the employment type. * `SALARIED`: Employees that are paid a fixed amount per year. * `HOURLY`: Employees that are paid a wage per hour worked.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "label": { "description": "The display label of the employment type.", "type": "string" }, "name": { "description": "The name of the employment type for non-custom employment types.", "type": "string" }, "type": { "description": "The classification of the worker by the company. * `CONTRACTOR`: Contractors are self-employed workers who provide services on a short-term or per-project basis and are not eligible for tax-withholding or benefits. * `EMPLOYEE`: Employees are hired and managed by an employer, work under the employer's direct supervision and control, and are protected by law for wages and employment rights.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "label", "updated_at" ], "title": "CompanyEmploymentType", "type": "object" }, "employment_type_id": { "description": "The worker's employment type.", "type": "string" }, "end_date": { "description": "The end date of the worker.", "type": "string" }, "ethnicity": { "description": "The identified ethnicity of the worker, if specified.", "type": "string" }, "gender": { "description": "The gender of the worker, if specified.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_manager": { "description": "Whether the worker is a manager", "type": "boolean" }, "job_function": { "description": "The worker's job function. When expanded, this field requires `job-functions.read`.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "Displayed name of the job function", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "JobFunction", "type": "object" }, "job_function_id": { "description": "ID of the worker's job function.", "type": "string" }, "legal_entity": { "description": "The worker's associated legal entity.\n\nExpandable field", "properties": { "company": { "description": "The company or organization associated with the legal entity\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "doing_business_as_name": { "description": "The doing business as name for the company.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_entities": { "description": "A list of the company's entities.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestLegalEntity" }, "type": "array" }, "legal_entities_id": { "description": "A list of the company's entities.", "items": { "type": "string" }, "type": "array" }, "legal_name": { "description": "The legal name of the company.", "type": "string" }, "name": { "description": "The name of the company.", "type": "string" }, "parent_legal_entity": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The company's ultimate holding entity.\n\nExpandable field", "type": "object" }, "parent_legal_entity_id": { "description": "The company's ultimate holding entity.", "type": "string" }, "phone": { "description": "The phone number for the company.", "type": "string" }, "physical_address": { "description": "The physical address of the holding entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "primary_email": { "description": "The email address used when registering this company.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "legal_entities", "legal_entities_id", "name", "updated_at" ], "title": "Company", "type": "object" }, "company_id": { "description": "The company or organization associated with the legal entity", "type": "string" }, "country": { "description": "The country the legal entity is based in.", "properties": { "code": { "description": "The code of the country.", "type": "string" } }, "required": [ "code" ], "title": "Country", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "entity_level": { "description": "The legal entity's level in a hierarchy. * `PARENT`: The legal entity is considered the ultimate holding entity. * `SUBSIDIARY`: The legal entity is considered a subsidiary, fully or partially held by another. * `BRANCH`: The legal entity is considered a branch, associated with a parent legal entity.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_name": { "description": "The legal name of the legal entity.", "type": "string" }, "mailing_address": { "description": "The mailing address of the legal entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "management_type": { "description": "The legal entity management type in the case of an employer of record (EOR) or professional employment organization (PEO). * `PEO`: The legal entity is considered a Professional Employment Organization (PEO). * `EOR`: The legal entity is considered an Employer of Record (EOR).", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The parent legal entity.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent legal entity.", "type": "string" }, "physical_address": { "description": "The physical address of the legal entity, if it differs from the mailing address.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "registration_date": { "description": "The registration date of the entity.", "type": "string" }, "tax_identifier": { "description": "The tax identifier for the legal entity.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "LegalEntity", "type": "object" }, "legal_entity_id": { "description": "The worker's associated legal entity.", "type": "string" }, "level": { "description": "The level of the worker.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "description": { "description": "The description of the level.", "type": "string" }, "experience_requirements": { "description": "The experience requirements for the level.", "type": "string" }, "global_level": { "anyOf": [ { "description": "Global level is used to track the seniority of levels. The higher up a level is placed on the page, the more senior and higher-ranked the level. Global level is used in workflows, policies, and reports that use the level attribute (e.g., you can use Level Lookup to set up a workflow that notifies the nearest person in an worker's management chain at or above the specified level).", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the level. Must be unique within the company or organization.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLevel", "description": "The parent level.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent level.", "type": "string" }, "rank": { "anyOf": [ { "description": "The rank of the level within its track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "scope_of_responsibilities": { "description": "The scope of responsibilities for the level.", "type": "string" }, "track": { "description": "The track associated with the level, if it's not a global level.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_default": { "description": "Whether this is the company's default track.", "type": "boolean" }, "name": { "description": "The name of the track. Must be unique within the company or organization.", "type": "string" }, "order": { "anyOf": [ { "description": "The one-based horizontal display order of the track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "start_global_level": { "anyOf": [ { "description": "The highest global level occupied by this track. Empty tracks return null.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Track", "type": "object" }, "track_id": { "description": "The track associated with the level. Required during creation. Include global_level when changing it.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Level", "type": "object" }, "level_id": { "description": "The level of the worker.", "type": "string" }, "location": { "description": "The location that the worker is mapped to for tax purposes. In the case that a worker is remote, the location's type is remote.", "properties": { "type": { "description": "The type of location.", "type": "string" }, "work_location_id": { "description": "The work location, if the worker isn't remote.", "type": "string" } }, "required": [ "type", "work_location_id" ], "title": "WorkerLocation", "type": "object" }, "manager": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's manager.\n\nExpandable field", "type": "object" }, "manager_id": { "description": "The worker's manager.", "type": "string" }, "number": { "anyOf": [ { "description": "The worker's number within the organization.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "original_start_date": { "description": "The worker's earliest start date across their employment history, excluding INIT roles.", "type": "string" }, "overtime_exemption": { "description": "The worker's overtime exemption status.", "type": "string" }, "pay_schedule_id": { "description": "The ID of the pay schedule currently associated with the worker.", "type": "string" }, "personal_email": { "description": "The worker's associated personal email address.", "type": "string" }, "race": { "description": "The identified race of the worker, if specified.", "type": "string" }, "start_date": { "description": "The start date of the worker.", "type": "string" }, "status": { "description": "The worker's status within the organization.", "type": "string" }, "teams": { "description": "The worker's assigned teams.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiTeamcb26bc28f32f" }, "type": "array" }, "teams_id": { "description": "The worker's assigned teams.", "items": { "type": "string" }, "type": "array" }, "termination_details": { "description": "The details of the worker's termination, if applicable.", "properties": { "reason": { "description": "This is a description that will be custom to each Rippling company.", "type": "string" }, "type": { "description": "The termination type indicates whether the termination was voluntary or involuntary.", "type": "string" } }, "title": "TerminationDetails", "type": "object" }, "title": { "description": "The worker's title.", "type": "string" }, "title_effective_date": { "description": "Title effective date", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "user": { "description": "The worker's associated user.\n\nExpandable field", "properties": { "active": { "description": "Whether the user is able to access company resources, typically when they are in actively engaged with the company and not after off-boarding.", "type": "boolean" }, "addresses": { "description": "The user's addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiUserAddressedd59b9ba9a1" }, "type": "array" }, "created_at": { "description": "Record creation date", "type": "string" }, "display_name": { "description": "The display name of the user using either the concatenated preferred given and family name or username depending on availability.", "type": "string" }, "emails": { "description": "The user's email addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiEmail5284c8258dc3" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "locale": { "description": "The User's default location for purposes of localization of currency, date time format, or numerical representations pursuant to RFC5646.", "type": "string" }, "name": { "description": "The user's name.", "properties": { "family_name": { "description": "The legal family name of the user, or last name in most Western languages.", "type": "string" }, "formatted": { "description": "The user's full name.", "type": "string" }, "given_name": { "description": "The given legal name of the user, or first name in most Western languages.", "type": "string" }, "middle_name": { "description": "The middle name(s) of the user.", "type": "string" }, "preferred_family_name": { "description": "The preferred family name, or last name in most Western languages, by the user.", "type": "string" }, "preferred_given_name": { "description": "The preferred given name, or first name in most Western languages, by the user.", "type": "string" } }, "title": "UserName", "type": "object" }, "number": { "description": "The permanent profile number of the user.", "type": "string" }, "phone_numbers": { "description": "The user's phone numbers.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoneNumber12060c61ecf5" }, "type": "array" }, "photos": { "description": "The user's photos.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoto2be7c3ae3f39" }, "type": "array" }, "preferred_language": { "description": "The User's preferred written or spoken language in the same format of the HTTP Accept-Language header, pursuant to Section 5.3.5 of RFC7231.", "type": "string" }, "timezone": { "description": "The User's current time zone in IANA database Olson format", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "username": { "description": "The unique identifier across Rippling used by the User for direct authentication into their associated company. Globally unique.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "User", "type": "object" }, "user_id": { "description": "The worker's associated user.", "type": "string" }, "work_email": { "description": "The worker's associated work email address.", "type": "string" }, "work_schedule": { "additionalProperties": { "$ref": "#/components/schemas/OutputRestApiWorkScheduleDay938f88d94f20" }, "description": "The worker's scheduled working hours for each day of the week.", "type": "object" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Worker", "type": "object" }, "reviewer_id": { "description": "The ID of the worker who reviewed the leave request.", "type": "string" }, "start_date": { "description": "The start date of the leave request.", "type": "string" }, "start_time": { "description": "The start time of the leave request.", "type": "string" }, "status": { "description": "The status of the leave request.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "worker": { "description": "The worker associated with the leave request.\n\nExpandable field", "properties": { "business_partners": { "description": "Worker's assigned business partners. This field is only populated when explicitly requested via the expand parameter (e.g., ?expand=business_partners). When expanded, returns an empty list ([]) if the worker has no business partners.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiBusinessPartner77b00a069c32" }, "type": "array" }, "business_partners_id": { "description": "Worker's assigned business partners unique identifiers. Returns an empty list ([]) if the worker has no business partners.", "items": { "type": "string" }, "type": "array" }, "citizenship": { "description": "The countries that the worker has citizenship in.", "type": "string" }, "compensation": { "description": "The compensation package for the worker.\n\nExpandable field", "properties": { "annual_compensation": { "description": "The worker's annual compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "annual_salary_equivalent": { "description": "The worker's annual salary equivalent, for insurance purposes. It will be equal to the worker's annual compensation, except for owners that are receiving no cashcompensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "bonus_schedule": { "description": "The worker's bonus schedule.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "hourly_wage": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "id": { "description": "Identifier field", "type": "string" }, "monthly_compensation": { "description": "The worker's monthly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "on_target_commission": { "description": "The worker's on-target commission.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "payment_terms": { "description": "The payment terms for an worker's compensation.", "type": "string" }, "payment_type": { "description": "The payment type for an worker's compensation.", "type": "string" }, "relocation_reimbursement": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "salary_effective_date": { "description": "Salary effective date", "type": "string" }, "signing_bonus": { "description": "The worker's signing bonus.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus": { "description": "The worker's target annual bonus amount.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus_percent": { "anyOf": [ { "description": "The worker's target annual bonus as a percent of annual compensation.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" }, "weekly_compensation": { "description": "The worker's weekly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "worker": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's details.\n\nExpandable field", "type": "object" }, "worker_id": { "description": "The worker's ID.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Compensation", "type": "object" }, "compensation_grade": { "description": "The compensation grade assigned to the worker, if any.", "properties": { "id": { "description": "The compensation grade's unique identifier.", "type": "string" }, "label": { "description": "The compensation grade's label.", "type": "string" } }, "title": "WorkerCompensationGrade", "type": "object" }, "compensation_id": { "description": "The compensation package for the worker.", "type": "string" }, "country": { "description": "The worker's country.", "type": "string" }, "country_fields": { "description": "Country level fields for the worker.", "properties": { "ca": { "description": "Country-wise regional fields for Canada", "properties": { "sin": { "description": "Social Insurance Number (SIN) for Canada employees.", "type": "string" } }, "title": "CanadaFields", "type": "object" }, "nz": { "description": "Country-wise regional fields for New Zealand", "properties": { "ird_number": { "description": "Inland Revenue Department (IRD) number for New Zealand employees.", "type": "string" } }, "title": "NewZealandFields", "type": "object" }, "us": { "description": "Country-wise regional fields for USA", "properties": { "ssn": { "description": "Social Security Number (SSN) for US employees.", "type": "string" } }, "title": "USFields", "type": "object" } }, "title": "CountryFields", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "custom_fields": { "description": "Custom field values defined on the Employee object for this worker\n\nExpandable field", "items": { "additionalProperties": {} }, "type": "array" }, "date_of_birth": { "description": "The worker's date of birth.", "type": "string" }, "department": { "description": "The worker's assigned department.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "department_hierarchy": { "description": "List of departments in the department hierarchy. Refer department_hierarchy_ids for department hierarchy order.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestDepartment" }, "type": "array" }, "department_hierarchy_id": { "description": "The identifier of departments in the department hierarchy ordered from parent department to child department.", "items": { "type": "string" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the department.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestDepartment", "description": "The parent department.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent department.", "type": "string" }, "reference_code": { "description": "Reference code of the department.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Department", "type": "object" }, "department_id": { "description": "The worker's assigned department.", "type": "string" }, "employment_type": { "description": "The worker's employment type.\n\nExpandable field", "properties": { "amount_worked": { "description": "The amount worked for the employment type. * `FULL-TIME`: Full-time is at least 30 hours per week. Full-time workers will typically be eligible for benefits. * `PART-TIME`: Part-time is less than 30 hours per week. These workers may be eligible for benefits, depending on company settings and hours worked. * `TEMPORARY`: These workers are hired on a temporary basis. You can specify how each worker with this employment type will be paid individually.", "type": "string" }, "compensation_time_period": { "description": "The compensation period for the employment type. * `SALARIED`: Employees that are paid a fixed amount per year. * `HOURLY`: Employees that are paid a wage per hour worked.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "label": { "description": "The display label of the employment type.", "type": "string" }, "name": { "description": "The name of the employment type for non-custom employment types.", "type": "string" }, "type": { "description": "The classification of the worker by the company. * `CONTRACTOR`: Contractors are self-employed workers who provide services on a short-term or per-project basis and are not eligible for tax-withholding or benefits. * `EMPLOYEE`: Employees are hired and managed by an employer, work under the employer's direct supervision and control, and are protected by law for wages and employment rights.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "label", "updated_at" ], "title": "CompanyEmploymentType", "type": "object" }, "employment_type_id": { "description": "The worker's employment type.", "type": "string" }, "end_date": { "description": "The end date of the worker.", "type": "string" }, "ethnicity": { "description": "The identified ethnicity of the worker, if specified.", "type": "string" }, "gender": { "description": "The gender of the worker, if specified.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_manager": { "description": "Whether the worker is a manager", "type": "boolean" }, "job_function": { "description": "The worker's job function. When expanded, this field requires `job-functions.read`.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "Displayed name of the job function", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "JobFunction", "type": "object" }, "job_function_id": { "description": "ID of the worker's job function.", "type": "string" }, "legal_entity": { "description": "The worker's associated legal entity.\n\nExpandable field", "properties": { "company": { "description": "The company or organization associated with the legal entity\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "doing_business_as_name": { "description": "The doing business as name for the company.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_entities": { "description": "A list of the company's entities.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestLegalEntity" }, "type": "array" }, "legal_entities_id": { "description": "A list of the company's entities.", "items": { "type": "string" }, "type": "array" }, "legal_name": { "description": "The legal name of the company.", "type": "string" }, "name": { "description": "The name of the company.", "type": "string" }, "parent_legal_entity": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The company's ultimate holding entity.\n\nExpandable field", "type": "object" }, "parent_legal_entity_id": { "description": "The company's ultimate holding entity.", "type": "string" }, "phone": { "description": "The phone number for the company.", "type": "string" }, "physical_address": { "description": "The physical address of the holding entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "primary_email": { "description": "The email address used when registering this company.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "legal_entities", "legal_entities_id", "name", "updated_at" ], "title": "Company", "type": "object" }, "company_id": { "description": "The company or organization associated with the legal entity", "type": "string" }, "country": { "description": "The country the legal entity is based in.", "properties": { "code": { "description": "The code of the country.", "type": "string" } }, "required": [ "code" ], "title": "Country", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "entity_level": { "description": "The legal entity's level in a hierarchy. * `PARENT`: The legal entity is considered the ultimate holding entity. * `SUBSIDIARY`: The legal entity is considered a subsidiary, fully or partially held by another. * `BRANCH`: The legal entity is considered a branch, associated with a parent legal entity.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_name": { "description": "The legal name of the legal entity.", "type": "string" }, "mailing_address": { "description": "The mailing address of the legal entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "management_type": { "description": "The legal entity management type in the case of an employer of record (EOR) or professional employment organization (PEO). * `PEO`: The legal entity is considered a Professional Employment Organization (PEO). * `EOR`: The legal entity is considered an Employer of Record (EOR).", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The parent legal entity.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent legal entity.", "type": "string" }, "physical_address": { "description": "The physical address of the legal entity, if it differs from the mailing address.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "registration_date": { "description": "The registration date of the entity.", "type": "string" }, "tax_identifier": { "description": "The tax identifier for the legal entity.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "LegalEntity", "type": "object" }, "legal_entity_id": { "description": "The worker's associated legal entity.", "type": "string" }, "level": { "description": "The level of the worker.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "description": { "description": "The description of the level.", "type": "string" }, "experience_requirements": { "description": "The experience requirements for the level.", "type": "string" }, "global_level": { "anyOf": [ { "description": "Global level is used to track the seniority of levels. The higher up a level is placed on the page, the more senior and higher-ranked the level. Global level is used in workflows, policies, and reports that use the level attribute (e.g., you can use Level Lookup to set up a workflow that notifies the nearest person in an worker's management chain at or above the specified level).", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the level. Must be unique within the company or organization.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLevel", "description": "The parent level.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent level.", "type": "string" }, "rank": { "anyOf": [ { "description": "The rank of the level within its track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "scope_of_responsibilities": { "description": "The scope of responsibilities for the level.", "type": "string" }, "track": { "description": "The track associated with the level, if it's not a global level.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_default": { "description": "Whether this is the company's default track.", "type": "boolean" }, "name": { "description": "The name of the track. Must be unique within the company or organization.", "type": "string" }, "order": { "anyOf": [ { "description": "The one-based horizontal display order of the track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "start_global_level": { "anyOf": [ { "description": "The highest global level occupied by this track. Empty tracks return null.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Track", "type": "object" }, "track_id": { "description": "The track associated with the level. Required during creation. Include global_level when changing it.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Level", "type": "object" }, "level_id": { "description": "The level of the worker.", "type": "string" }, "location": { "description": "The location that the worker is mapped to for tax purposes. In the case that a worker is remote, the location's type is remote.", "properties": { "type": { "description": "The type of location.", "type": "string" }, "work_location_id": { "description": "The work location, if the worker isn't remote.", "type": "string" } }, "required": [ "type", "work_location_id" ], "title": "WorkerLocation", "type": "object" }, "manager": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's manager.\n\nExpandable field", "type": "object" }, "manager_id": { "description": "The worker's manager.", "type": "string" }, "number": { "anyOf": [ { "description": "The worker's number within the organization.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "original_start_date": { "description": "The worker's earliest start date across their employment history, excluding INIT roles.", "type": "string" }, "overtime_exemption": { "description": "The worker's overtime exemption status.", "type": "string" }, "pay_schedule_id": { "description": "The ID of the pay schedule currently associated with the worker.", "type": "string" }, "personal_email": { "description": "The worker's associated personal email address.", "type": "string" }, "race": { "description": "The identified race of the worker, if specified.", "type": "string" }, "start_date": { "description": "The start date of the worker.", "type": "string" }, "status": { "description": "The worker's status within the organization.", "type": "string" }, "teams": { "description": "The worker's assigned teams.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiTeamcb26bc28f32f" }, "type": "array" }, "teams_id": { "description": "The worker's assigned teams.", "items": { "type": "string" }, "type": "array" }, "termination_details": { "description": "The details of the worker's termination, if applicable.", "properties": { "reason": { "description": "This is a description that will be custom to each Rippling company.", "type": "string" }, "type": { "description": "The termination type indicates whether the termination was voluntary or involuntary.", "type": "string" } }, "title": "TerminationDetails", "type": "object" }, "title": { "description": "The worker's title.", "type": "string" }, "title_effective_date": { "description": "Title effective date", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "user": { "description": "The worker's associated user.\n\nExpandable field", "properties": { "active": { "description": "Whether the user is able to access company resources, typically when they are in actively engaged with the company and not after off-boarding.", "type": "boolean" }, "addresses": { "description": "The user's addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiUserAddressedd59b9ba9a1" }, "type": "array" }, "created_at": { "description": "Record creation date", "type": "string" }, "display_name": { "description": "The display name of the user using either the concatenated preferred given and family name or username depending on availability.", "type": "string" }, "emails": { "description": "The user's email addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiEmail5284c8258dc3" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "locale": { "description": "The User's default location for purposes of localization of currency, date time format, or numerical representations pursuant to RFC5646.", "type": "string" }, "name": { "description": "The user's name.", "properties": { "family_name": { "description": "The legal family name of the user, or last name in most Western languages.", "type": "string" }, "formatted": { "description": "The user's full name.", "type": "string" }, "given_name": { "description": "The given legal name of the user, or first name in most Western languages.", "type": "string" }, "middle_name": { "description": "The middle name(s) of the user.", "type": "string" }, "preferred_family_name": { "description": "The preferred family name, or last name in most Western languages, by the user.", "type": "string" }, "preferred_given_name": { "description": "The preferred given name, or first name in most Western languages, by the user.", "type": "string" } }, "title": "UserName", "type": "object" }, "number": { "description": "The permanent profile number of the user.", "type": "string" }, "phone_numbers": { "description": "The user's phone numbers.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoneNumber12060c61ecf5" }, "type": "array" }, "photos": { "description": "The user's photos.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoto2be7c3ae3f39" }, "type": "array" }, "preferred_language": { "description": "The User's preferred written or spoken language in the same format of the HTTP Accept-Language header, pursuant to Section 5.3.5 of RFC7231.", "type": "string" }, "timezone": { "description": "The User's current time zone in IANA database Olson format", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "username": { "description": "The unique identifier across Rippling used by the User for direct authentication into their associated company. Globally unique.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "User", "type": "object" }, "user_id": { "description": "The worker's associated user.", "type": "string" }, "work_email": { "description": "The worker's associated work email address.", "type": "string" }, "work_schedule": { "additionalProperties": { "$ref": "#/components/schemas/OutputRestApiWorkScheduleDay938f88d94f20" }, "description": "The worker's scheduled working hours for each day of the week.", "type": "object" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Worker", "type": "object" }, "worker_id": { "description": "The ID of the worker associated with the leave request.", "type": "string" } }, "required": [ "created_at", "end_date", "id", "start_date", "status", "updated_at", "worker_id" ], "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Retrieve a specific leave request", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "leave-requests.read" ] }, "patch": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/update-leave-requests" }, "operationId": "rippling.rest_api.update_leave_requests", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "id", "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiLeaveRequestUpdateRequestc12d1f2beb2f" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "comments": { "description": "The comments associated with the leave request.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "days_take_off": { "description": "The specific dates taken off and the amount of time taken off for each one.", "items": { "$ref": "#/components/schemas/OutputRestApiDayOff9e4b21f07f8d" }, "type": "array" }, "end_date": { "description": "The end date of the leave request.", "type": "string" }, "end_time": { "description": "The end time of the leave request.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_managed_by_external_system": { "description": "Whether the leave request is managed by an external system.", "type": "boolean" }, "leave_event_id": { "description": "The ID of the leave event associated with the leave request, if any.", "type": "string" }, "leave_policy_id": { "description": "The ID of the leave policy associated with the leave request, either leave_policy_id or leave_type_id must be provided.", "type": "string" }, "leave_type": { "description": "The leave type associated with the leave request.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "description": { "description": "The description of the leave type.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_managed_by_external_system": { "description": "Whether the leave is managed by an external system.", "type": "boolean" }, "is_paid": { "description": "Whether the leave is paid.", "type": "boolean" }, "name": { "description": "The name of the leave type.", "type": "string" }, "type": { "description": "The type of leave.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "is_managed_by_external_system", "is_paid", "name", "type", "updated_at" ], "title": "LeaveType", "type": "object" }, "leave_type_id": { "description": "The ID of the leave type associated with the leave request, either leave_policy_id or leave_type_id must be provided.", "type": "string" }, "number_of_minutes_requested": { "anyOf": [ { "description": "The number of minutes requested for the leave request.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "reason_for_leave": { "description": "The reason for the leave request.", "type": "string" }, "requester": { "description": "The worker who requested the leave request.\n\nExpandable field", "properties": { "business_partners": { "description": "Worker's assigned business partners. This field is only populated when explicitly requested via the expand parameter (e.g., ?expand=business_partners). When expanded, returns an empty list ([]) if the worker has no business partners.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiBusinessPartner77b00a069c32" }, "type": "array" }, "business_partners_id": { "description": "Worker's assigned business partners unique identifiers. Returns an empty list ([]) if the worker has no business partners.", "items": { "type": "string" }, "type": "array" }, "citizenship": { "description": "The countries that the worker has citizenship in.", "type": "string" }, "compensation": { "description": "The compensation package for the worker.\n\nExpandable field", "properties": { "annual_compensation": { "description": "The worker's annual compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "annual_salary_equivalent": { "description": "The worker's annual salary equivalent, for insurance purposes. It will be equal to the worker's annual compensation, except for owners that are receiving no cashcompensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "bonus_schedule": { "description": "The worker's bonus schedule.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "hourly_wage": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "id": { "description": "Identifier field", "type": "string" }, "monthly_compensation": { "description": "The worker's monthly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "on_target_commission": { "description": "The worker's on-target commission.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "payment_terms": { "description": "The payment terms for an worker's compensation.", "type": "string" }, "payment_type": { "description": "The payment type for an worker's compensation.", "type": "string" }, "relocation_reimbursement": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "salary_effective_date": { "description": "Salary effective date", "type": "string" }, "signing_bonus": { "description": "The worker's signing bonus.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus": { "description": "The worker's target annual bonus amount.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus_percent": { "anyOf": [ { "description": "The worker's target annual bonus as a percent of annual compensation.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" }, "weekly_compensation": { "description": "The worker's weekly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "worker": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's details.\n\nExpandable field", "type": "object" }, "worker_id": { "description": "The worker's ID.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Compensation", "type": "object" }, "compensation_grade": { "description": "The compensation grade assigned to the worker, if any.", "properties": { "id": { "description": "The compensation grade's unique identifier.", "type": "string" }, "label": { "description": "The compensation grade's label.", "type": "string" } }, "title": "WorkerCompensationGrade", "type": "object" }, "compensation_id": { "description": "The compensation package for the worker.", "type": "string" }, "country": { "description": "The worker's country.", "type": "string" }, "country_fields": { "description": "Country level fields for the worker.", "properties": { "ca": { "description": "Country-wise regional fields for Canada", "properties": { "sin": { "description": "Social Insurance Number (SIN) for Canada employees.", "type": "string" } }, "title": "CanadaFields", "type": "object" }, "nz": { "description": "Country-wise regional fields for New Zealand", "properties": { "ird_number": { "description": "Inland Revenue Department (IRD) number for New Zealand employees.", "type": "string" } }, "title": "NewZealandFields", "type": "object" }, "us": { "description": "Country-wise regional fields for USA", "properties": { "ssn": { "description": "Social Security Number (SSN) for US employees.", "type": "string" } }, "title": "USFields", "type": "object" } }, "title": "CountryFields", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "custom_fields": { "description": "Custom field values defined on the Employee object for this worker\n\nExpandable field", "items": { "additionalProperties": {} }, "type": "array" }, "date_of_birth": { "description": "The worker's date of birth.", "type": "string" }, "department": { "description": "The worker's assigned department.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "department_hierarchy": { "description": "List of departments in the department hierarchy. Refer department_hierarchy_ids for department hierarchy order.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestDepartment" }, "type": "array" }, "department_hierarchy_id": { "description": "The identifier of departments in the department hierarchy ordered from parent department to child department.", "items": { "type": "string" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the department.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestDepartment", "description": "The parent department.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent department.", "type": "string" }, "reference_code": { "description": "Reference code of the department.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Department", "type": "object" }, "department_id": { "description": "The worker's assigned department.", "type": "string" }, "employment_type": { "description": "The worker's employment type.\n\nExpandable field", "properties": { "amount_worked": { "description": "The amount worked for the employment type. * `FULL-TIME`: Full-time is at least 30 hours per week. Full-time workers will typically be eligible for benefits. * `PART-TIME`: Part-time is less than 30 hours per week. These workers may be eligible for benefits, depending on company settings and hours worked. * `TEMPORARY`: These workers are hired on a temporary basis. You can specify how each worker with this employment type will be paid individually.", "type": "string" }, "compensation_time_period": { "description": "The compensation period for the employment type. * `SALARIED`: Employees that are paid a fixed amount per year. * `HOURLY`: Employees that are paid a wage per hour worked.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "label": { "description": "The display label of the employment type.", "type": "string" }, "name": { "description": "The name of the employment type for non-custom employment types.", "type": "string" }, "type": { "description": "The classification of the worker by the company. * `CONTRACTOR`: Contractors are self-employed workers who provide services on a short-term or per-project basis and are not eligible for tax-withholding or benefits. * `EMPLOYEE`: Employees are hired and managed by an employer, work under the employer's direct supervision and control, and are protected by law for wages and employment rights.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "label", "updated_at" ], "title": "CompanyEmploymentType", "type": "object" }, "employment_type_id": { "description": "The worker's employment type.", "type": "string" }, "end_date": { "description": "The end date of the worker.", "type": "string" }, "ethnicity": { "description": "The identified ethnicity of the worker, if specified.", "type": "string" }, "gender": { "description": "The gender of the worker, if specified.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_manager": { "description": "Whether the worker is a manager", "type": "boolean" }, "job_function": { "description": "The worker's job function. When expanded, this field requires `job-functions.read`.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "Displayed name of the job function", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "JobFunction", "type": "object" }, "job_function_id": { "description": "ID of the worker's job function.", "type": "string" }, "legal_entity": { "description": "The worker's associated legal entity.\n\nExpandable field", "properties": { "company": { "description": "The company or organization associated with the legal entity\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "doing_business_as_name": { "description": "The doing business as name for the company.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_entities": { "description": "A list of the company's entities.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestLegalEntity" }, "type": "array" }, "legal_entities_id": { "description": "A list of the company's entities.", "items": { "type": "string" }, "type": "array" }, "legal_name": { "description": "The legal name of the company.", "type": "string" }, "name": { "description": "The name of the company.", "type": "string" }, "parent_legal_entity": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The company's ultimate holding entity.\n\nExpandable field", "type": "object" }, "parent_legal_entity_id": { "description": "The company's ultimate holding entity.", "type": "string" }, "phone": { "description": "The phone number for the company.", "type": "string" }, "physical_address": { "description": "The physical address of the holding entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "primary_email": { "description": "The email address used when registering this company.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "legal_entities", "legal_entities_id", "name", "updated_at" ], "title": "Company", "type": "object" }, "company_id": { "description": "The company or organization associated with the legal entity", "type": "string" }, "country": { "description": "The country the legal entity is based in.", "properties": { "code": { "description": "The code of the country.", "type": "string" } }, "required": [ "code" ], "title": "Country", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "entity_level": { "description": "The legal entity's level in a hierarchy. * `PARENT`: The legal entity is considered the ultimate holding entity. * `SUBSIDIARY`: The legal entity is considered a subsidiary, fully or partially held by another. * `BRANCH`: The legal entity is considered a branch, associated with a parent legal entity.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_name": { "description": "The legal name of the legal entity.", "type": "string" }, "mailing_address": { "description": "The mailing address of the legal entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "management_type": { "description": "The legal entity management type in the case of an employer of record (EOR) or professional employment organization (PEO). * `PEO`: The legal entity is considered a Professional Employment Organization (PEO). * `EOR`: The legal entity is considered an Employer of Record (EOR).", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The parent legal entity.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent legal entity.", "type": "string" }, "physical_address": { "description": "The physical address of the legal entity, if it differs from the mailing address.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "registration_date": { "description": "The registration date of the entity.", "type": "string" }, "tax_identifier": { "description": "The tax identifier for the legal entity.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "LegalEntity", "type": "object" }, "legal_entity_id": { "description": "The worker's associated legal entity.", "type": "string" }, "level": { "description": "The level of the worker.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "description": { "description": "The description of the level.", "type": "string" }, "experience_requirements": { "description": "The experience requirements for the level.", "type": "string" }, "global_level": { "anyOf": [ { "description": "Global level is used to track the seniority of levels. The higher up a level is placed on the page, the more senior and higher-ranked the level. Global level is used in workflows, policies, and reports that use the level attribute (e.g., you can use Level Lookup to set up a workflow that notifies the nearest person in an worker's management chain at or above the specified level).", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the level. Must be unique within the company or organization.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLevel", "description": "The parent level.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent level.", "type": "string" }, "rank": { "anyOf": [ { "description": "The rank of the level within its track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "scope_of_responsibilities": { "description": "The scope of responsibilities for the level.", "type": "string" }, "track": { "description": "The track associated with the level, if it's not a global level.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_default": { "description": "Whether this is the company's default track.", "type": "boolean" }, "name": { "description": "The name of the track. Must be unique within the company or organization.", "type": "string" }, "order": { "anyOf": [ { "description": "The one-based horizontal display order of the track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "start_global_level": { "anyOf": [ { "description": "The highest global level occupied by this track. Empty tracks return null.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Track", "type": "object" }, "track_id": { "description": "The track associated with the level. Required during creation. Include global_level when changing it.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Level", "type": "object" }, "level_id": { "description": "The level of the worker.", "type": "string" }, "location": { "description": "The location that the worker is mapped to for tax purposes. In the case that a worker is remote, the location's type is remote.", "properties": { "type": { "description": "The type of location.", "type": "string" }, "work_location_id": { "description": "The work location, if the worker isn't remote.", "type": "string" } }, "required": [ "type", "work_location_id" ], "title": "WorkerLocation", "type": "object" }, "manager": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's manager.\n\nExpandable field", "type": "object" }, "manager_id": { "description": "The worker's manager.", "type": "string" }, "number": { "anyOf": [ { "description": "The worker's number within the organization.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "original_start_date": { "description": "The worker's earliest start date across their employment history, excluding INIT roles.", "type": "string" }, "overtime_exemption": { "description": "The worker's overtime exemption status.", "type": "string" }, "pay_schedule_id": { "description": "The ID of the pay schedule currently associated with the worker.", "type": "string" }, "personal_email": { "description": "The worker's associated personal email address.", "type": "string" }, "race": { "description": "The identified race of the worker, if specified.", "type": "string" }, "start_date": { "description": "The start date of the worker.", "type": "string" }, "status": { "description": "The worker's status within the organization.", "type": "string" }, "teams": { "description": "The worker's assigned teams.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiTeamcb26bc28f32f" }, "type": "array" }, "teams_id": { "description": "The worker's assigned teams.", "items": { "type": "string" }, "type": "array" }, "termination_details": { "description": "The details of the worker's termination, if applicable.", "properties": { "reason": { "description": "This is a description that will be custom to each Rippling company.", "type": "string" }, "type": { "description": "The termination type indicates whether the termination was voluntary or involuntary.", "type": "string" } }, "title": "TerminationDetails", "type": "object" }, "title": { "description": "The worker's title.", "type": "string" }, "title_effective_date": { "description": "Title effective date", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "user": { "description": "The worker's associated user.\n\nExpandable field", "properties": { "active": { "description": "Whether the user is able to access company resources, typically when they are in actively engaged with the company and not after off-boarding.", "type": "boolean" }, "addresses": { "description": "The user's addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiUserAddressedd59b9ba9a1" }, "type": "array" }, "created_at": { "description": "Record creation date", "type": "string" }, "display_name": { "description": "The display name of the user using either the concatenated preferred given and family name or username depending on availability.", "type": "string" }, "emails": { "description": "The user's email addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiEmail5284c8258dc3" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "locale": { "description": "The User's default location for purposes of localization of currency, date time format, or numerical representations pursuant to RFC5646.", "type": "string" }, "name": { "description": "The user's name.", "properties": { "family_name": { "description": "The legal family name of the user, or last name in most Western languages.", "type": "string" }, "formatted": { "description": "The user's full name.", "type": "string" }, "given_name": { "description": "The given legal name of the user, or first name in most Western languages.", "type": "string" }, "middle_name": { "description": "The middle name(s) of the user.", "type": "string" }, "preferred_family_name": { "description": "The preferred family name, or last name in most Western languages, by the user.", "type": "string" }, "preferred_given_name": { "description": "The preferred given name, or first name in most Western languages, by the user.", "type": "string" } }, "title": "UserName", "type": "object" }, "number": { "description": "The permanent profile number of the user.", "type": "string" }, "phone_numbers": { "description": "The user's phone numbers.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoneNumber12060c61ecf5" }, "type": "array" }, "photos": { "description": "The user's photos.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoto2be7c3ae3f39" }, "type": "array" }, "preferred_language": { "description": "The User's preferred written or spoken language in the same format of the HTTP Accept-Language header, pursuant to Section 5.3.5 of RFC7231.", "type": "string" }, "timezone": { "description": "The User's current time zone in IANA database Olson format", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "username": { "description": "The unique identifier across Rippling used by the User for direct authentication into their associated company. Globally unique.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "User", "type": "object" }, "user_id": { "description": "The worker's associated user.", "type": "string" }, "work_email": { "description": "The worker's associated work email address.", "type": "string" }, "work_schedule": { "additionalProperties": { "$ref": "#/components/schemas/OutputRestApiWorkScheduleDay938f88d94f20" }, "description": "The worker's scheduled working hours for each day of the week.", "type": "object" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Worker", "type": "object" }, "requester_id": { "description": "The ID of the worker who requested the leave request.", "type": "string" }, "reviewed_at": { "description": "The timestamp of when the leave request was reviewed.", "type": "string" }, "reviewer": { "description": "The worker who reviewed the leave request.\n\nExpandable field", "properties": { "business_partners": { "description": "Worker's assigned business partners. This field is only populated when explicitly requested via the expand parameter (e.g., ?expand=business_partners). When expanded, returns an empty list ([]) if the worker has no business partners.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiBusinessPartner77b00a069c32" }, "type": "array" }, "business_partners_id": { "description": "Worker's assigned business partners unique identifiers. Returns an empty list ([]) if the worker has no business partners.", "items": { "type": "string" }, "type": "array" }, "citizenship": { "description": "The countries that the worker has citizenship in.", "type": "string" }, "compensation": { "description": "The compensation package for the worker.\n\nExpandable field", "properties": { "annual_compensation": { "description": "The worker's annual compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "annual_salary_equivalent": { "description": "The worker's annual salary equivalent, for insurance purposes. It will be equal to the worker's annual compensation, except for owners that are receiving no cashcompensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "bonus_schedule": { "description": "The worker's bonus schedule.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "hourly_wage": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "id": { "description": "Identifier field", "type": "string" }, "monthly_compensation": { "description": "The worker's monthly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "on_target_commission": { "description": "The worker's on-target commission.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "payment_terms": { "description": "The payment terms for an worker's compensation.", "type": "string" }, "payment_type": { "description": "The payment type for an worker's compensation.", "type": "string" }, "relocation_reimbursement": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "salary_effective_date": { "description": "Salary effective date", "type": "string" }, "signing_bonus": { "description": "The worker's signing bonus.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus": { "description": "The worker's target annual bonus amount.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus_percent": { "anyOf": [ { "description": "The worker's target annual bonus as a percent of annual compensation.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" }, "weekly_compensation": { "description": "The worker's weekly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "worker": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's details.\n\nExpandable field", "type": "object" }, "worker_id": { "description": "The worker's ID.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Compensation", "type": "object" }, "compensation_grade": { "description": "The compensation grade assigned to the worker, if any.", "properties": { "id": { "description": "The compensation grade's unique identifier.", "type": "string" }, "label": { "description": "The compensation grade's label.", "type": "string" } }, "title": "WorkerCompensationGrade", "type": "object" }, "compensation_id": { "description": "The compensation package for the worker.", "type": "string" }, "country": { "description": "The worker's country.", "type": "string" }, "country_fields": { "description": "Country level fields for the worker.", "properties": { "ca": { "description": "Country-wise regional fields for Canada", "properties": { "sin": { "description": "Social Insurance Number (SIN) for Canada employees.", "type": "string" } }, "title": "CanadaFields", "type": "object" }, "nz": { "description": "Country-wise regional fields for New Zealand", "properties": { "ird_number": { "description": "Inland Revenue Department (IRD) number for New Zealand employees.", "type": "string" } }, "title": "NewZealandFields", "type": "object" }, "us": { "description": "Country-wise regional fields for USA", "properties": { "ssn": { "description": "Social Security Number (SSN) for US employees.", "type": "string" } }, "title": "USFields", "type": "object" } }, "title": "CountryFields", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "custom_fields": { "description": "Custom field values defined on the Employee object for this worker\n\nExpandable field", "items": { "additionalProperties": {} }, "type": "array" }, "date_of_birth": { "description": "The worker's date of birth.", "type": "string" }, "department": { "description": "The worker's assigned department.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "department_hierarchy": { "description": "List of departments in the department hierarchy. Refer department_hierarchy_ids for department hierarchy order.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestDepartment" }, "type": "array" }, "department_hierarchy_id": { "description": "The identifier of departments in the department hierarchy ordered from parent department to child department.", "items": { "type": "string" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the department.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestDepartment", "description": "The parent department.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent department.", "type": "string" }, "reference_code": { "description": "Reference code of the department.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Department", "type": "object" }, "department_id": { "description": "The worker's assigned department.", "type": "string" }, "employment_type": { "description": "The worker's employment type.\n\nExpandable field", "properties": { "amount_worked": { "description": "The amount worked for the employment type. * `FULL-TIME`: Full-time is at least 30 hours per week. Full-time workers will typically be eligible for benefits. * `PART-TIME`: Part-time is less than 30 hours per week. These workers may be eligible for benefits, depending on company settings and hours worked. * `TEMPORARY`: These workers are hired on a temporary basis. You can specify how each worker with this employment type will be paid individually.", "type": "string" }, "compensation_time_period": { "description": "The compensation period for the employment type. * `SALARIED`: Employees that are paid a fixed amount per year. * `HOURLY`: Employees that are paid a wage per hour worked.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "label": { "description": "The display label of the employment type.", "type": "string" }, "name": { "description": "The name of the employment type for non-custom employment types.", "type": "string" }, "type": { "description": "The classification of the worker by the company. * `CONTRACTOR`: Contractors are self-employed workers who provide services on a short-term or per-project basis and are not eligible for tax-withholding or benefits. * `EMPLOYEE`: Employees are hired and managed by an employer, work under the employer's direct supervision and control, and are protected by law for wages and employment rights.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "label", "updated_at" ], "title": "CompanyEmploymentType", "type": "object" }, "employment_type_id": { "description": "The worker's employment type.", "type": "string" }, "end_date": { "description": "The end date of the worker.", "type": "string" }, "ethnicity": { "description": "The identified ethnicity of the worker, if specified.", "type": "string" }, "gender": { "description": "The gender of the worker, if specified.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_manager": { "description": "Whether the worker is a manager", "type": "boolean" }, "job_function": { "description": "The worker's job function. When expanded, this field requires `job-functions.read`.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "Displayed name of the job function", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "JobFunction", "type": "object" }, "job_function_id": { "description": "ID of the worker's job function.", "type": "string" }, "legal_entity": { "description": "The worker's associated legal entity.\n\nExpandable field", "properties": { "company": { "description": "The company or organization associated with the legal entity\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "doing_business_as_name": { "description": "The doing business as name for the company.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_entities": { "description": "A list of the company's entities.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestLegalEntity" }, "type": "array" }, "legal_entities_id": { "description": "A list of the company's entities.", "items": { "type": "string" }, "type": "array" }, "legal_name": { "description": "The legal name of the company.", "type": "string" }, "name": { "description": "The name of the company.", "type": "string" }, "parent_legal_entity": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The company's ultimate holding entity.\n\nExpandable field", "type": "object" }, "parent_legal_entity_id": { "description": "The company's ultimate holding entity.", "type": "string" }, "phone": { "description": "The phone number for the company.", "type": "string" }, "physical_address": { "description": "The physical address of the holding entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "primary_email": { "description": "The email address used when registering this company.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "legal_entities", "legal_entities_id", "name", "updated_at" ], "title": "Company", "type": "object" }, "company_id": { "description": "The company or organization associated with the legal entity", "type": "string" }, "country": { "description": "The country the legal entity is based in.", "properties": { "code": { "description": "The code of the country.", "type": "string" } }, "required": [ "code" ], "title": "Country", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "entity_level": { "description": "The legal entity's level in a hierarchy. * `PARENT`: The legal entity is considered the ultimate holding entity. * `SUBSIDIARY`: The legal entity is considered a subsidiary, fully or partially held by another. * `BRANCH`: The legal entity is considered a branch, associated with a parent legal entity.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_name": { "description": "The legal name of the legal entity.", "type": "string" }, "mailing_address": { "description": "The mailing address of the legal entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "management_type": { "description": "The legal entity management type in the case of an employer of record (EOR) or professional employment organization (PEO). * `PEO`: The legal entity is considered a Professional Employment Organization (PEO). * `EOR`: The legal entity is considered an Employer of Record (EOR).", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The parent legal entity.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent legal entity.", "type": "string" }, "physical_address": { "description": "The physical address of the legal entity, if it differs from the mailing address.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "registration_date": { "description": "The registration date of the entity.", "type": "string" }, "tax_identifier": { "description": "The tax identifier for the legal entity.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "LegalEntity", "type": "object" }, "legal_entity_id": { "description": "The worker's associated legal entity.", "type": "string" }, "level": { "description": "The level of the worker.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "description": { "description": "The description of the level.", "type": "string" }, "experience_requirements": { "description": "The experience requirements for the level.", "type": "string" }, "global_level": { "anyOf": [ { "description": "Global level is used to track the seniority of levels. The higher up a level is placed on the page, the more senior and higher-ranked the level. Global level is used in workflows, policies, and reports that use the level attribute (e.g., you can use Level Lookup to set up a workflow that notifies the nearest person in an worker's management chain at or above the specified level).", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the level. Must be unique within the company or organization.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLevel", "description": "The parent level.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent level.", "type": "string" }, "rank": { "anyOf": [ { "description": "The rank of the level within its track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "scope_of_responsibilities": { "description": "The scope of responsibilities for the level.", "type": "string" }, "track": { "description": "The track associated with the level, if it's not a global level.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_default": { "description": "Whether this is the company's default track.", "type": "boolean" }, "name": { "description": "The name of the track. Must be unique within the company or organization.", "type": "string" }, "order": { "anyOf": [ { "description": "The one-based horizontal display order of the track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "start_global_level": { "anyOf": [ { "description": "The highest global level occupied by this track. Empty tracks return null.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Track", "type": "object" }, "track_id": { "description": "The track associated with the level. Required during creation. Include global_level when changing it.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Level", "type": "object" }, "level_id": { "description": "The level of the worker.", "type": "string" }, "location": { "description": "The location that the worker is mapped to for tax purposes. In the case that a worker is remote, the location's type is remote.", "properties": { "type": { "description": "The type of location.", "type": "string" }, "work_location_id": { "description": "The work location, if the worker isn't remote.", "type": "string" } }, "required": [ "type", "work_location_id" ], "title": "WorkerLocation", "type": "object" }, "manager": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's manager.\n\nExpandable field", "type": "object" }, "manager_id": { "description": "The worker's manager.", "type": "string" }, "number": { "anyOf": [ { "description": "The worker's number within the organization.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "original_start_date": { "description": "The worker's earliest start date across their employment history, excluding INIT roles.", "type": "string" }, "overtime_exemption": { "description": "The worker's overtime exemption status.", "type": "string" }, "pay_schedule_id": { "description": "The ID of the pay schedule currently associated with the worker.", "type": "string" }, "personal_email": { "description": "The worker's associated personal email address.", "type": "string" }, "race": { "description": "The identified race of the worker, if specified.", "type": "string" }, "start_date": { "description": "The start date of the worker.", "type": "string" }, "status": { "description": "The worker's status within the organization.", "type": "string" }, "teams": { "description": "The worker's assigned teams.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiTeamcb26bc28f32f" }, "type": "array" }, "teams_id": { "description": "The worker's assigned teams.", "items": { "type": "string" }, "type": "array" }, "termination_details": { "description": "The details of the worker's termination, if applicable.", "properties": { "reason": { "description": "This is a description that will be custom to each Rippling company.", "type": "string" }, "type": { "description": "The termination type indicates whether the termination was voluntary or involuntary.", "type": "string" } }, "title": "TerminationDetails", "type": "object" }, "title": { "description": "The worker's title.", "type": "string" }, "title_effective_date": { "description": "Title effective date", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "user": { "description": "The worker's associated user.\n\nExpandable field", "properties": { "active": { "description": "Whether the user is able to access company resources, typically when they are in actively engaged with the company and not after off-boarding.", "type": "boolean" }, "addresses": { "description": "The user's addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiUserAddressedd59b9ba9a1" }, "type": "array" }, "created_at": { "description": "Record creation date", "type": "string" }, "display_name": { "description": "The display name of the user using either the concatenated preferred given and family name or username depending on availability.", "type": "string" }, "emails": { "description": "The user's email addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiEmail5284c8258dc3" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "locale": { "description": "The User's default location for purposes of localization of currency, date time format, or numerical representations pursuant to RFC5646.", "type": "string" }, "name": { "description": "The user's name.", "properties": { "family_name": { "description": "The legal family name of the user, or last name in most Western languages.", "type": "string" }, "formatted": { "description": "The user's full name.", "type": "string" }, "given_name": { "description": "The given legal name of the user, or first name in most Western languages.", "type": "string" }, "middle_name": { "description": "The middle name(s) of the user.", "type": "string" }, "preferred_family_name": { "description": "The preferred family name, or last name in most Western languages, by the user.", "type": "string" }, "preferred_given_name": { "description": "The preferred given name, or first name in most Western languages, by the user.", "type": "string" } }, "title": "UserName", "type": "object" }, "number": { "description": "The permanent profile number of the user.", "type": "string" }, "phone_numbers": { "description": "The user's phone numbers.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoneNumber12060c61ecf5" }, "type": "array" }, "photos": { "description": "The user's photos.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoto2be7c3ae3f39" }, "type": "array" }, "preferred_language": { "description": "The User's preferred written or spoken language in the same format of the HTTP Accept-Language header, pursuant to Section 5.3.5 of RFC7231.", "type": "string" }, "timezone": { "description": "The User's current time zone in IANA database Olson format", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "username": { "description": "The unique identifier across Rippling used by the User for direct authentication into their associated company. Globally unique.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "User", "type": "object" }, "user_id": { "description": "The worker's associated user.", "type": "string" }, "work_email": { "description": "The worker's associated work email address.", "type": "string" }, "work_schedule": { "additionalProperties": { "$ref": "#/components/schemas/OutputRestApiWorkScheduleDay938f88d94f20" }, "description": "The worker's scheduled working hours for each day of the week.", "type": "object" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Worker", "type": "object" }, "reviewer_id": { "description": "The ID of the worker who reviewed the leave request.", "type": "string" }, "start_date": { "description": "The start date of the leave request.", "type": "string" }, "start_time": { "description": "The start time of the leave request.", "type": "string" }, "status": { "description": "The status of the leave request.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "worker": { "description": "The worker associated with the leave request.\n\nExpandable field", "properties": { "business_partners": { "description": "Worker's assigned business partners. This field is only populated when explicitly requested via the expand parameter (e.g., ?expand=business_partners). When expanded, returns an empty list ([]) if the worker has no business partners.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiBusinessPartner77b00a069c32" }, "type": "array" }, "business_partners_id": { "description": "Worker's assigned business partners unique identifiers. Returns an empty list ([]) if the worker has no business partners.", "items": { "type": "string" }, "type": "array" }, "citizenship": { "description": "The countries that the worker has citizenship in.", "type": "string" }, "compensation": { "description": "The compensation package for the worker.\n\nExpandable field", "properties": { "annual_compensation": { "description": "The worker's annual compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "annual_salary_equivalent": { "description": "The worker's annual salary equivalent, for insurance purposes. It will be equal to the worker's annual compensation, except for owners that are receiving no cashcompensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "bonus_schedule": { "description": "The worker's bonus schedule.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "hourly_wage": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "id": { "description": "Identifier field", "type": "string" }, "monthly_compensation": { "description": "The worker's monthly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "on_target_commission": { "description": "The worker's on-target commission.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "payment_terms": { "description": "The payment terms for an worker's compensation.", "type": "string" }, "payment_type": { "description": "The payment type for an worker's compensation.", "type": "string" }, "relocation_reimbursement": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "salary_effective_date": { "description": "Salary effective date", "type": "string" }, "signing_bonus": { "description": "The worker's signing bonus.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus": { "description": "The worker's target annual bonus amount.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus_percent": { "anyOf": [ { "description": "The worker's target annual bonus as a percent of annual compensation.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" }, "weekly_compensation": { "description": "The worker's weekly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "worker": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's details.\n\nExpandable field", "type": "object" }, "worker_id": { "description": "The worker's ID.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Compensation", "type": "object" }, "compensation_grade": { "description": "The compensation grade assigned to the worker, if any.", "properties": { "id": { "description": "The compensation grade's unique identifier.", "type": "string" }, "label": { "description": "The compensation grade's label.", "type": "string" } }, "title": "WorkerCompensationGrade", "type": "object" }, "compensation_id": { "description": "The compensation package for the worker.", "type": "string" }, "country": { "description": "The worker's country.", "type": "string" }, "country_fields": { "description": "Country level fields for the worker.", "properties": { "ca": { "description": "Country-wise regional fields for Canada", "properties": { "sin": { "description": "Social Insurance Number (SIN) for Canada employees.", "type": "string" } }, "title": "CanadaFields", "type": "object" }, "nz": { "description": "Country-wise regional fields for New Zealand", "properties": { "ird_number": { "description": "Inland Revenue Department (IRD) number for New Zealand employees.", "type": "string" } }, "title": "NewZealandFields", "type": "object" }, "us": { "description": "Country-wise regional fields for USA", "properties": { "ssn": { "description": "Social Security Number (SSN) for US employees.", "type": "string" } }, "title": "USFields", "type": "object" } }, "title": "CountryFields", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "custom_fields": { "description": "Custom field values defined on the Employee object for this worker\n\nExpandable field", "items": { "additionalProperties": {} }, "type": "array" }, "date_of_birth": { "description": "The worker's date of birth.", "type": "string" }, "department": { "description": "The worker's assigned department.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "department_hierarchy": { "description": "List of departments in the department hierarchy. Refer department_hierarchy_ids for department hierarchy order.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestDepartment" }, "type": "array" }, "department_hierarchy_id": { "description": "The identifier of departments in the department hierarchy ordered from parent department to child department.", "items": { "type": "string" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the department.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestDepartment", "description": "The parent department.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent department.", "type": "string" }, "reference_code": { "description": "Reference code of the department.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Department", "type": "object" }, "department_id": { "description": "The worker's assigned department.", "type": "string" }, "employment_type": { "description": "The worker's employment type.\n\nExpandable field", "properties": { "amount_worked": { "description": "The amount worked for the employment type. * `FULL-TIME`: Full-time is at least 30 hours per week. Full-time workers will typically be eligible for benefits. * `PART-TIME`: Part-time is less than 30 hours per week. These workers may be eligible for benefits, depending on company settings and hours worked. * `TEMPORARY`: These workers are hired on a temporary basis. You can specify how each worker with this employment type will be paid individually.", "type": "string" }, "compensation_time_period": { "description": "The compensation period for the employment type. * `SALARIED`: Employees that are paid a fixed amount per year. * `HOURLY`: Employees that are paid a wage per hour worked.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "label": { "description": "The display label of the employment type.", "type": "string" }, "name": { "description": "The name of the employment type for non-custom employment types.", "type": "string" }, "type": { "description": "The classification of the worker by the company. * `CONTRACTOR`: Contractors are self-employed workers who provide services on a short-term or per-project basis and are not eligible for tax-withholding or benefits. * `EMPLOYEE`: Employees are hired and managed by an employer, work under the employer's direct supervision and control, and are protected by law for wages and employment rights.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "label", "updated_at" ], "title": "CompanyEmploymentType", "type": "object" }, "employment_type_id": { "description": "The worker's employment type.", "type": "string" }, "end_date": { "description": "The end date of the worker.", "type": "string" }, "ethnicity": { "description": "The identified ethnicity of the worker, if specified.", "type": "string" }, "gender": { "description": "The gender of the worker, if specified.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_manager": { "description": "Whether the worker is a manager", "type": "boolean" }, "job_function": { "description": "The worker's job function. When expanded, this field requires `job-functions.read`.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "Displayed name of the job function", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "JobFunction", "type": "object" }, "job_function_id": { "description": "ID of the worker's job function.", "type": "string" }, "legal_entity": { "description": "The worker's associated legal entity.\n\nExpandable field", "properties": { "company": { "description": "The company or organization associated with the legal entity\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "doing_business_as_name": { "description": "The doing business as name for the company.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_entities": { "description": "A list of the company's entities.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestLegalEntity" }, "type": "array" }, "legal_entities_id": { "description": "A list of the company's entities.", "items": { "type": "string" }, "type": "array" }, "legal_name": { "description": "The legal name of the company.", "type": "string" }, "name": { "description": "The name of the company.", "type": "string" }, "parent_legal_entity": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The company's ultimate holding entity.\n\nExpandable field", "type": "object" }, "parent_legal_entity_id": { "description": "The company's ultimate holding entity.", "type": "string" }, "phone": { "description": "The phone number for the company.", "type": "string" }, "physical_address": { "description": "The physical address of the holding entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "primary_email": { "description": "The email address used when registering this company.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "legal_entities", "legal_entities_id", "name", "updated_at" ], "title": "Company", "type": "object" }, "company_id": { "description": "The company or organization associated with the legal entity", "type": "string" }, "country": { "description": "The country the legal entity is based in.", "properties": { "code": { "description": "The code of the country.", "type": "string" } }, "required": [ "code" ], "title": "Country", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "entity_level": { "description": "The legal entity's level in a hierarchy. * `PARENT`: The legal entity is considered the ultimate holding entity. * `SUBSIDIARY`: The legal entity is considered a subsidiary, fully or partially held by another. * `BRANCH`: The legal entity is considered a branch, associated with a parent legal entity.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_name": { "description": "The legal name of the legal entity.", "type": "string" }, "mailing_address": { "description": "The mailing address of the legal entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "management_type": { "description": "The legal entity management type in the case of an employer of record (EOR) or professional employment organization (PEO). * `PEO`: The legal entity is considered a Professional Employment Organization (PEO). * `EOR`: The legal entity is considered an Employer of Record (EOR).", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The parent legal entity.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent legal entity.", "type": "string" }, "physical_address": { "description": "The physical address of the legal entity, if it differs from the mailing address.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "registration_date": { "description": "The registration date of the entity.", "type": "string" }, "tax_identifier": { "description": "The tax identifier for the legal entity.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "LegalEntity", "type": "object" }, "legal_entity_id": { "description": "The worker's associated legal entity.", "type": "string" }, "level": { "description": "The level of the worker.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "description": { "description": "The description of the level.", "type": "string" }, "experience_requirements": { "description": "The experience requirements for the level.", "type": "string" }, "global_level": { "anyOf": [ { "description": "Global level is used to track the seniority of levels. The higher up a level is placed on the page, the more senior and higher-ranked the level. Global level is used in workflows, policies, and reports that use the level attribute (e.g., you can use Level Lookup to set up a workflow that notifies the nearest person in an worker's management chain at or above the specified level).", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the level. Must be unique within the company or organization.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLevel", "description": "The parent level.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent level.", "type": "string" }, "rank": { "anyOf": [ { "description": "The rank of the level within its track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "scope_of_responsibilities": { "description": "The scope of responsibilities for the level.", "type": "string" }, "track": { "description": "The track associated with the level, if it's not a global level.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_default": { "description": "Whether this is the company's default track.", "type": "boolean" }, "name": { "description": "The name of the track. Must be unique within the company or organization.", "type": "string" }, "order": { "anyOf": [ { "description": "The one-based horizontal display order of the track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "start_global_level": { "anyOf": [ { "description": "The highest global level occupied by this track. Empty tracks return null.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Track", "type": "object" }, "track_id": { "description": "The track associated with the level. Required during creation. Include global_level when changing it.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Level", "type": "object" }, "level_id": { "description": "The level of the worker.", "type": "string" }, "location": { "description": "The location that the worker is mapped to for tax purposes. In the case that a worker is remote, the location's type is remote.", "properties": { "type": { "description": "The type of location.", "type": "string" }, "work_location_id": { "description": "The work location, if the worker isn't remote.", "type": "string" } }, "required": [ "type", "work_location_id" ], "title": "WorkerLocation", "type": "object" }, "manager": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's manager.\n\nExpandable field", "type": "object" }, "manager_id": { "description": "The worker's manager.", "type": "string" }, "number": { "anyOf": [ { "description": "The worker's number within the organization.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "original_start_date": { "description": "The worker's earliest start date across their employment history, excluding INIT roles.", "type": "string" }, "overtime_exemption": { "description": "The worker's overtime exemption status.", "type": "string" }, "pay_schedule_id": { "description": "The ID of the pay schedule currently associated with the worker.", "type": "string" }, "personal_email": { "description": "The worker's associated personal email address.", "type": "string" }, "race": { "description": "The identified race of the worker, if specified.", "type": "string" }, "start_date": { "description": "The start date of the worker.", "type": "string" }, "status": { "description": "The worker's status within the organization.", "type": "string" }, "teams": { "description": "The worker's assigned teams.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiTeamcb26bc28f32f" }, "type": "array" }, "teams_id": { "description": "The worker's assigned teams.", "items": { "type": "string" }, "type": "array" }, "termination_details": { "description": "The details of the worker's termination, if applicable.", "properties": { "reason": { "description": "This is a description that will be custom to each Rippling company.", "type": "string" }, "type": { "description": "The termination type indicates whether the termination was voluntary or involuntary.", "type": "string" } }, "title": "TerminationDetails", "type": "object" }, "title": { "description": "The worker's title.", "type": "string" }, "title_effective_date": { "description": "Title effective date", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "user": { "description": "The worker's associated user.\n\nExpandable field", "properties": { "active": { "description": "Whether the user is able to access company resources, typically when they are in actively engaged with the company and not after off-boarding.", "type": "boolean" }, "addresses": { "description": "The user's addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiUserAddressedd59b9ba9a1" }, "type": "array" }, "created_at": { "description": "Record creation date", "type": "string" }, "display_name": { "description": "The display name of the user using either the concatenated preferred given and family name or username depending on availability.", "type": "string" }, "emails": { "description": "The user's email addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiEmail5284c8258dc3" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "locale": { "description": "The User's default location for purposes of localization of currency, date time format, or numerical representations pursuant to RFC5646.", "type": "string" }, "name": { "description": "The user's name.", "properties": { "family_name": { "description": "The legal family name of the user, or last name in most Western languages.", "type": "string" }, "formatted": { "description": "The user's full name.", "type": "string" }, "given_name": { "description": "The given legal name of the user, or first name in most Western languages.", "type": "string" }, "middle_name": { "description": "The middle name(s) of the user.", "type": "string" }, "preferred_family_name": { "description": "The preferred family name, or last name in most Western languages, by the user.", "type": "string" }, "preferred_given_name": { "description": "The preferred given name, or first name in most Western languages, by the user.", "type": "string" } }, "title": "UserName", "type": "object" }, "number": { "description": "The permanent profile number of the user.", "type": "string" }, "phone_numbers": { "description": "The user's phone numbers.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoneNumber12060c61ecf5" }, "type": "array" }, "photos": { "description": "The user's photos.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoto2be7c3ae3f39" }, "type": "array" }, "preferred_language": { "description": "The User's preferred written or spoken language in the same format of the HTTP Accept-Language header, pursuant to Section 5.3.5 of RFC7231.", "type": "string" }, "timezone": { "description": "The User's current time zone in IANA database Olson format", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "username": { "description": "The unique identifier across Rippling used by the User for direct authentication into their associated company. Globally unique.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "User", "type": "object" }, "user_id": { "description": "The worker's associated user.", "type": "string" }, "work_email": { "description": "The worker's associated work email address.", "type": "string" }, "work_schedule": { "additionalProperties": { "$ref": "#/components/schemas/OutputRestApiWorkScheduleDay938f88d94f20" }, "description": "The worker's scheduled working hours for each day of the week.", "type": "object" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Worker", "type": "object" }, "worker_id": { "description": "The ID of the worker associated with the leave request.", "type": "string" } }, "required": [ "created_at", "end_date", "id", "start_date", "status", "updated_at", "worker_id" ], "title": "LeaveRequest", "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Update a leave request", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "leave-requests.read-write" ] } }, "/leave-types/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/list-leave-types" }, "operationId": "rippling.rest_api.list_leave_types", "parameters": [ { "in": "query", "name": "filter", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 100, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "__meta": { "$ref": "#/components/schemas/OutputRestApiRedactedFields9f7657dc2a2f" }, "next_link": { "description": "A link to the next page of responses.", "format": "uri", "type": "string" }, "results": { "items": { "$ref": "#/components/schemas/OutputRestApiLeaveType6364e802816f" }, "type": "array" } }, "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "List leave types", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "leave-types.read" ] } }, "/leave-types/{id}/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/get-leave-types" }, "operationId": "rippling.rest_api.get_leave_types", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "id", "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "__meta": { "properties": { "redacted_fields": { "items": { "$ref": "#/components/schemas/OutputRestApiRedactedField21788a25ef22" }, "type": "array" } }, "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "description": { "description": "The description of the leave type.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_managed_by_external_system": { "description": "Whether the leave is managed by an external system.", "type": "boolean" }, "is_paid": { "description": "Whether the leave is paid.", "type": "boolean" }, "name": { "description": "The name of the leave type.", "type": "string" }, "type": { "description": "The type of leave.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "is_managed_by_external_system", "is_paid", "name", "type", "updated_at" ], "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Retrieve a specific leave type", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "leave-types.read" ] } }, "/legal-entities/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/list-legal-entities" }, "operationId": "rippling.rest_api.list_legal_entities", "parameters": [ { "in": "query", "name": "expand", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 100, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "__meta": { "$ref": "#/components/schemas/OutputRestApiRedactedFields9f7657dc2a2f" }, "next_link": { "description": "A link to the next page of responses.", "format": "uri", "type": "string" }, "results": { "items": { "$ref": "#/components/schemas/OutputRestApiLegalEntity2a1da2cfa26b" }, "type": "array" } }, "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "List legal entities", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "legal-entities.read" ] } }, "/legal-entities/{id}/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/get-legal-entities" }, "operationId": "rippling.rest_api.get_legal_entities", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "id", "type": "string" } }, { "in": "query", "name": "expand", "required": false, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "__meta": { "properties": { "redacted_fields": { "items": { "$ref": "#/components/schemas/OutputRestApiRedactedField21788a25ef22" }, "type": "array" } }, "type": "object" }, "company": { "description": "The company or organization associated with the legal entity\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "doing_business_as_name": { "description": "The doing business as name for the company.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_entities": { "description": "A list of the company's entities.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestLegalEntity" }, "type": "array" }, "legal_entities_id": { "description": "A list of the company's entities.", "items": { "type": "string" }, "type": "array" }, "legal_name": { "description": "The legal name of the company.", "type": "string" }, "name": { "description": "The name of the company.", "type": "string" }, "parent_legal_entity": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The company's ultimate holding entity.\n\nExpandable field", "type": "object" }, "parent_legal_entity_id": { "description": "The company's ultimate holding entity.", "type": "string" }, "phone": { "description": "The phone number for the company.", "type": "string" }, "physical_address": { "description": "The physical address of the holding entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "primary_email": { "description": "The email address used when registering this company.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "legal_entities", "legal_entities_id", "name", "updated_at" ], "title": "Company", "type": "object" }, "company_id": { "description": "The company or organization associated with the legal entity", "type": "string" }, "country": { "description": "The country the legal entity is based in.", "properties": { "code": { "description": "The code of the country.", "type": "string" } }, "required": [ "code" ], "title": "Country", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "entity_level": { "description": "The legal entity's level in a hierarchy. * `PARENT`: The legal entity is considered the ultimate holding entity. * `SUBSIDIARY`: The legal entity is considered a subsidiary, fully or partially held by another. * `BRANCH`: The legal entity is considered a branch, associated with a parent legal entity.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_name": { "description": "The legal name of the legal entity.", "type": "string" }, "mailing_address": { "description": "The mailing address of the legal entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "management_type": { "description": "The legal entity management type in the case of an employer of record (EOR) or professional employment organization (PEO). * `PEO`: The legal entity is considered a Professional Employment Organization (PEO). * `EOR`: The legal entity is considered an Employer of Record (EOR).", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The parent legal entity.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent legal entity.", "type": "string" }, "physical_address": { "description": "The physical address of the legal entity, if it differs from the mailing address.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "registration_date": { "description": "The registration date of the entity.", "type": "string" }, "tax_identifier": { "description": "The tax identifier for the legal entity.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Retrieve a specific legal entity", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "legal-entities.read" ] } }, "/levels/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/list-levels" }, "operationId": "rippling.rest_api.list_levels", "parameters": [ { "in": "query", "name": "expand", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 100, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "__meta": { "$ref": "#/components/schemas/OutputRestApiRedactedFields9f7657dc2a2f" }, "next_link": { "description": "A link to the next page of responses.", "format": "uri", "type": "string" }, "results": { "items": { "$ref": "#/components/schemas/OutputRestApiLevel7fec16190787" }, "type": "array" } }, "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "List levels", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "levels.read" ] }, "post": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/create-levels" }, "operationId": "rippling.rest_api.create_levels", "parameters": [ { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiLevelRequest3a721d0713b9" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "description": { "description": "The description of the level.", "type": "string" }, "experience_requirements": { "description": "The experience requirements for the level.", "type": "string" }, "global_level": { "anyOf": [ { "description": "Global level is used to track the seniority of levels. The higher up a level is placed on the page, the more senior and higher-ranked the level. Global level is used in workflows, policies, and reports that use the level attribute (e.g., you can use Level Lookup to set up a workflow that notifies the nearest person in an worker's management chain at or above the specified level).", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the level. Must be unique within the company or organization.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLevel", "description": "The parent level.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent level.", "type": "string" }, "rank": { "anyOf": [ { "description": "The rank of the level within its track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "scope_of_responsibilities": { "description": "The scope of responsibilities for the level.", "type": "string" }, "track": { "description": "The track associated with the level, if it's not a global level.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_default": { "description": "Whether this is the company's default track.", "type": "boolean" }, "name": { "description": "The name of the track. Must be unique within the company or organization.", "type": "string" }, "order": { "anyOf": [ { "description": "The one-based horizontal display order of the track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "start_global_level": { "anyOf": [ { "description": "The highest global level occupied by this track. Empty tracks return null.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Track", "type": "object" }, "track_id": { "description": "The track associated with the level. Required during creation. Include global_level when changing it.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Level", "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Create a new level", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "levels.read-write" ] } }, "/levels/{id}/": { "delete": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/delete-levels" }, "operationId": "rippling.rest_api.delete_levels", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "id", "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "204": { "description": "The resource was deleted successfully" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Delete a level", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "levels.read-write" ] }, "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/get-levels" }, "operationId": "rippling.rest_api.get_levels", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "id", "type": "string" } }, { "in": "query", "name": "expand", "required": false, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "__meta": { "properties": { "redacted_fields": { "items": { "$ref": "#/components/schemas/OutputRestApiRedactedField21788a25ef22" }, "type": "array" } }, "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "description": { "description": "The description of the level.", "type": "string" }, "experience_requirements": { "description": "The experience requirements for the level.", "type": "string" }, "global_level": { "anyOf": [ { "description": "Global level is used to track the seniority of levels. The higher up a level is placed on the page, the more senior and higher-ranked the level. Global level is used in workflows, policies, and reports that use the level attribute (e.g., you can use Level Lookup to set up a workflow that notifies the nearest person in an worker's management chain at or above the specified level).", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the level. Must be unique within the company or organization.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLevel", "description": "The parent level.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent level.", "type": "string" }, "rank": { "anyOf": [ { "description": "The rank of the level within its track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "scope_of_responsibilities": { "description": "The scope of responsibilities for the level.", "type": "string" }, "track": { "description": "The track associated with the level, if it's not a global level.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_default": { "description": "Whether this is the company's default track.", "type": "boolean" }, "name": { "description": "The name of the track. Must be unique within the company or organization.", "type": "string" }, "order": { "anyOf": [ { "description": "The one-based horizontal display order of the track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "start_global_level": { "anyOf": [ { "description": "The highest global level occupied by this track. Empty tracks return null.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Track", "type": "object" }, "track_id": { "description": "The track associated with the level. Required during creation. Include global_level when changing it.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Retrieve a specific level", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "levels.read" ] }, "patch": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/update-levels" }, "operationId": "rippling.rest_api.update_levels", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "id", "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiLevelUpdateRequest11eded426378" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "description": { "description": "The description of the level.", "type": "string" }, "experience_requirements": { "description": "The experience requirements for the level.", "type": "string" }, "global_level": { "anyOf": [ { "description": "Global level is used to track the seniority of levels. The higher up a level is placed on the page, the more senior and higher-ranked the level. Global level is used in workflows, policies, and reports that use the level attribute (e.g., you can use Level Lookup to set up a workflow that notifies the nearest person in an worker's management chain at or above the specified level).", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the level. Must be unique within the company or organization.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLevel", "description": "The parent level.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent level.", "type": "string" }, "rank": { "anyOf": [ { "description": "The rank of the level within its track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "scope_of_responsibilities": { "description": "The scope of responsibilities for the level.", "type": "string" }, "track": { "description": "The track associated with the level, if it's not a global level.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_default": { "description": "Whether this is the company's default track.", "type": "boolean" }, "name": { "description": "The name of the track. Must be unique within the company or organization.", "type": "string" }, "order": { "anyOf": [ { "description": "The one-based horizontal display order of the track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "start_global_level": { "anyOf": [ { "description": "The highest global level occupied by this track. Empty tracks return null.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Track", "type": "object" }, "track_id": { "description": "The track associated with the level. Required during creation. Include global_level when changing it.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Level", "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Update a level", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "levels.read-write" ] } }, "/listing-submissions/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/list-listing-submissions" }, "operationId": "rippling.rest_api.list_listing_submissions", "parameters": [ { "in": "query", "name": "listing_id", "required": true, "schema": { "format": "id", "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "__meta": { "$ref": "#/components/schemas/OutputRestApiRedactedFields9f7657dc2a2f" }, "next_link": { "description": "A link to the next page of responses.", "format": "uri", "type": "string" }, "results": { "items": { "$ref": "#/components/schemas/OutputRestApiListingSubmissionDTO44917773da9e" }, "type": "array" } }, "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "List listing submission", "x-rippling-entitlements": [ "Developer_Program" ], "x-rippling-required-scopes": [ "listing-submissions.read" ] } }, "/listing-submissions/{id}/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/get-listing-submissions" }, "operationId": "rippling.rest_api.get_listing_submissions", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "id", "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "__meta": { "properties": { "redacted_fields": { "items": { "$ref": "#/components/schemas/OutputRestApiRedactedField21788a25ef22" }, "type": "array" } }, "type": "object" }, "created_at": { "description": "Creation timestamp.", "type": "string" }, "listing_id": { "description": "The parent listing ID.", "type": "string" }, "notes": { "description": "The latest submitted notes.", "type": "string" }, "status": { "description": "The submission lifecycle status.", "type": "string" }, "submission_id": { "description": "The submitted listing version ID.", "type": "string" }, "updated_at": { "description": "Last update timestamp.", "type": "string" } }, "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Retrieve a specific listing submission", "x-rippling-entitlements": [ "Developer_Program" ], "x-rippling-required-scopes": [ "listing-submissions.read" ] } }, "/listing-transitions/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/list-listing-transitions" }, "operationId": "rippling.rest_api.list_listing_transitions", "parameters": [ { "in": "query", "name": "listing_id", "required": true, "schema": { "format": "id", "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "__meta": { "$ref": "#/components/schemas/OutputRestApiRedactedFields9f7657dc2a2f" }, "next_link": { "description": "A link to the next page of responses.", "format": "uri", "type": "string" }, "results": { "items": { "$ref": "#/components/schemas/OutputRestApiListingTransitionDTO5ffc5dcf7b52" }, "type": "array" } }, "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "List listing transition", "x-rippling-entitlements": [ "Developer_Program" ], "x-rippling-required-scopes": [ "listing-transitions.read" ] } }, "/listing/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/list-listing" }, "operationId": "rippling.rest_api.list_listing", "parameters": [ { "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" } }, { "in": "query", "name": "offset", "required": false, "schema": { "type": "integer" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "__meta": { "$ref": "#/components/schemas/OutputRestApiRedactedFields9f7657dc2a2f" }, "next_link": { "description": "A link to the next page of responses.", "format": "uri", "type": "string" }, "results": { "items": { "$ref": "#/components/schemas/OutputRestApiListingDTO158d299ad06e" }, "type": "array" } }, "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "List listing", "x-rippling-entitlements": [ "Developer_Program" ], "x-rippling-required-scopes": [ "listing.read" ] }, "post": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/create-listing" }, "operationId": "rippling.rest_api.create_listing", "parameters": [ { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiListingDTORequest8ebbbb3d769f" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "created_at": { "description": "Creation timestamp.", "type": "string" }, "draft_status": { "description": "The current draft-cycle slot status.", "type": "string" }, "draft_version": { "description": "The current editable or review listing version.", "properties": { "catalog_binding_id": { "description": "The package ID tied to this listing.", "type": "string" }, "catalog_binding_version_id": { "description": "The package version ID selected by this listing version.", "type": "string" }, "created_at": { "description": "Creation timestamp.", "type": "string" }, "display_name": { "description": "The display name for this version.", "type": "string" }, "id": { "description": "The listing version ID.", "type": "string" }, "latest_submission_notes": { "description": "The latest notes submitted for review.", "type": "string" }, "metadata": { "description": "Listing metadata for this version.", "type": "object" }, "published_at": { "description": "Publish timestamp.", "type": "string" }, "status": { "description": "The lifecycle status for this version.", "type": "string" }, "updated_at": { "description": "Last update timestamp.", "type": "string" }, "version_name": { "description": "The publisher-visible version label.", "type": "string" } }, "title": "ListingVersionDTO", "type": "object" }, "draft_version_id": { "description": "The current draft-cycle version ID.", "type": "string" }, "icon": { "description": "The listing icon URL.", "type": "string" }, "listing_id": { "description": "The listing ID.", "type": "string" }, "name": { "description": "The listing name or display name.", "type": "string" }, "owner_company_id": { "description": "The publisher company ID that owns this listing.", "type": "string" }, "published_or_delisted_version": { "description": "The current published or delisted listing version.", "properties": { "catalog_binding_id": { "description": "The package ID tied to this listing.", "type": "string" }, "catalog_binding_version_id": { "description": "The package version ID selected by this listing version.", "type": "string" }, "created_at": { "description": "Creation timestamp.", "type": "string" }, "display_name": { "description": "The display name for this version.", "type": "string" }, "id": { "description": "The listing version ID.", "type": "string" }, "latest_submission_notes": { "description": "The latest notes submitted for review.", "type": "string" }, "metadata": { "description": "Listing metadata for this version.", "type": "object" }, "published_at": { "description": "Publish timestamp.", "type": "string" }, "status": { "description": "The lifecycle status for this version.", "type": "string" }, "updated_at": { "description": "Last update timestamp.", "type": "string" }, "version_name": { "description": "The publisher-visible version label.", "type": "string" } }, "title": "ListingVersionDTO", "type": "object" }, "published_status": { "description": "The current published slot status.", "type": "string" }, "published_version_id": { "description": "The current published or delisted version ID.", "type": "string" }, "status": { "description": "The listing lifecycle status.", "type": "string" }, "type": { "description": "The listing app type.", "type": "string" }, "updated_at": { "description": "Last update timestamp.", "type": "string" } }, "title": "ListingDTO", "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Create a new listing", "x-rippling-entitlements": [ "Developer_Program" ], "x-rippling-required-scopes": [ "listing.read-write" ] } }, "/listing/{id}/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/get-listing" }, "operationId": "rippling.rest_api.get_listing", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "id", "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "__meta": { "properties": { "redacted_fields": { "items": { "$ref": "#/components/schemas/OutputRestApiRedactedField21788a25ef22" }, "type": "array" } }, "type": "object" }, "created_at": { "description": "Creation timestamp.", "type": "string" }, "draft_status": { "description": "The current draft-cycle slot status.", "type": "string" }, "draft_version": { "description": "The current editable or review listing version.", "properties": { "catalog_binding_id": { "description": "The package ID tied to this listing.", "type": "string" }, "catalog_binding_version_id": { "description": "The package version ID selected by this listing version.", "type": "string" }, "created_at": { "description": "Creation timestamp.", "type": "string" }, "display_name": { "description": "The display name for this version.", "type": "string" }, "id": { "description": "The listing version ID.", "type": "string" }, "latest_submission_notes": { "description": "The latest notes submitted for review.", "type": "string" }, "metadata": { "description": "Listing metadata for this version.", "type": "object" }, "published_at": { "description": "Publish timestamp.", "type": "string" }, "status": { "description": "The lifecycle status for this version.", "type": "string" }, "updated_at": { "description": "Last update timestamp.", "type": "string" }, "version_name": { "description": "The publisher-visible version label.", "type": "string" } }, "title": "ListingVersionDTO", "type": "object" }, "draft_version_id": { "description": "The current draft-cycle version ID.", "type": "string" }, "icon": { "description": "The listing icon URL.", "type": "string" }, "listing_id": { "description": "The listing ID.", "type": "string" }, "name": { "description": "The listing name or display name.", "type": "string" }, "owner_company_id": { "description": "The publisher company ID that owns this listing.", "type": "string" }, "published_or_delisted_version": { "description": "The current published or delisted listing version.", "properties": { "catalog_binding_id": { "description": "The package ID tied to this listing.", "type": "string" }, "catalog_binding_version_id": { "description": "The package version ID selected by this listing version.", "type": "string" }, "created_at": { "description": "Creation timestamp.", "type": "string" }, "display_name": { "description": "The display name for this version.", "type": "string" }, "id": { "description": "The listing version ID.", "type": "string" }, "latest_submission_notes": { "description": "The latest notes submitted for review.", "type": "string" }, "metadata": { "description": "Listing metadata for this version.", "type": "object" }, "published_at": { "description": "Publish timestamp.", "type": "string" }, "status": { "description": "The lifecycle status for this version.", "type": "string" }, "updated_at": { "description": "Last update timestamp.", "type": "string" }, "version_name": { "description": "The publisher-visible version label.", "type": "string" } }, "title": "ListingVersionDTO", "type": "object" }, "published_status": { "description": "The current published slot status.", "type": "string" }, "published_version_id": { "description": "The current published or delisted version ID.", "type": "string" }, "status": { "description": "The listing lifecycle status.", "type": "string" }, "type": { "description": "The listing app type.", "type": "string" }, "updated_at": { "description": "Last update timestamp.", "type": "string" } }, "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Retrieve a specific listing", "x-rippling-entitlements": [ "Developer_Program" ], "x-rippling-required-scopes": [ "listing.read" ] }, "patch": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/update-listing" }, "operationId": "rippling.rest_api.update_listing", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "id", "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiListingDTORequest8ebbbb3d769f" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "created_at": { "description": "Creation timestamp.", "type": "string" }, "draft_status": { "description": "The current draft-cycle slot status.", "type": "string" }, "draft_version": { "description": "The current editable or review listing version.", "properties": { "catalog_binding_id": { "description": "The package ID tied to this listing.", "type": "string" }, "catalog_binding_version_id": { "description": "The package version ID selected by this listing version.", "type": "string" }, "created_at": { "description": "Creation timestamp.", "type": "string" }, "display_name": { "description": "The display name for this version.", "type": "string" }, "id": { "description": "The listing version ID.", "type": "string" }, "latest_submission_notes": { "description": "The latest notes submitted for review.", "type": "string" }, "metadata": { "description": "Listing metadata for this version.", "type": "object" }, "published_at": { "description": "Publish timestamp.", "type": "string" }, "status": { "description": "The lifecycle status for this version.", "type": "string" }, "updated_at": { "description": "Last update timestamp.", "type": "string" }, "version_name": { "description": "The publisher-visible version label.", "type": "string" } }, "title": "ListingVersionDTO", "type": "object" }, "draft_version_id": { "description": "The current draft-cycle version ID.", "type": "string" }, "icon": { "description": "The listing icon URL.", "type": "string" }, "listing_id": { "description": "The listing ID.", "type": "string" }, "name": { "description": "The listing name or display name.", "type": "string" }, "owner_company_id": { "description": "The publisher company ID that owns this listing.", "type": "string" }, "published_or_delisted_version": { "description": "The current published or delisted listing version.", "properties": { "catalog_binding_id": { "description": "The package ID tied to this listing.", "type": "string" }, "catalog_binding_version_id": { "description": "The package version ID selected by this listing version.", "type": "string" }, "created_at": { "description": "Creation timestamp.", "type": "string" }, "display_name": { "description": "The display name for this version.", "type": "string" }, "id": { "description": "The listing version ID.", "type": "string" }, "latest_submission_notes": { "description": "The latest notes submitted for review.", "type": "string" }, "metadata": { "description": "Listing metadata for this version.", "type": "object" }, "published_at": { "description": "Publish timestamp.", "type": "string" }, "status": { "description": "The lifecycle status for this version.", "type": "string" }, "updated_at": { "description": "Last update timestamp.", "type": "string" }, "version_name": { "description": "The publisher-visible version label.", "type": "string" } }, "title": "ListingVersionDTO", "type": "object" }, "published_status": { "description": "The current published slot status.", "type": "string" }, "published_version_id": { "description": "The current published or delisted version ID.", "type": "string" }, "status": { "description": "The listing lifecycle status.", "type": "string" }, "type": { "description": "The listing app type.", "type": "string" }, "updated_at": { "description": "Last update timestamp.", "type": "string" } }, "title": "ListingDTO", "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Update a listing", "x-rippling-entitlements": [ "Developer_Program" ], "x-rippling-required-scopes": [ "listing.read-write" ] } }, "/listing/{listing_id}/delist/": { "post": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/delist-listing" }, "operationId": "rippling.rest_api.delist_listing", "parameters": [ { "in": "path", "name": "listing_id", "required": true, "schema": { "format": "id", "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "notes": { "description": "Optional notes to record with the transition.", "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OutputRestApiListingDTO158d299ad06e" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Delist listing", "x-rippling-entitlements": [ "Developer_Program" ], "x-rippling-required-scopes": [ "listing.read-write" ] } }, "/listing/{listing_id}/publish/": { "post": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/publish-listing" }, "operationId": "rippling.rest_api.publish_listing", "parameters": [ { "in": "path", "name": "listing_id", "required": true, "schema": { "format": "id", "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "notes": { "description": "Optional notes to record with the transition.", "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OutputRestApiListingDTO158d299ad06e" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Publish listing", "x-rippling-entitlements": [ "Developer_Program" ], "x-rippling-required-scopes": [ "listing.read-write" ] } }, "/listing/{listing_id}/resubmit/": { "post": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/resubmit-listing" }, "operationId": "rippling.rest_api.resubmit_listing", "parameters": [ { "in": "path", "name": "listing_id", "required": true, "schema": { "format": "id", "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "notes": { "description": "Optional notes to record with the transition.", "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OutputRestApiListingDTO158d299ad06e" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Resubmit listing", "x-rippling-entitlements": [ "Developer_Program" ], "x-rippling-required-scopes": [ "listing.read-write" ] } }, "/listing/{listing_id}/submit/": { "post": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/submit-listing" }, "operationId": "rippling.rest_api.submit_listing", "parameters": [ { "in": "path", "name": "listing_id", "required": true, "schema": { "format": "id", "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "notes": { "description": "Optional notes to record with the transition.", "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OutputRestApiListingDTO158d299ad06e" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Submit listing", "x-rippling-entitlements": [ "Developer_Program" ], "x-rippling-required-scopes": [ "listing.read-write" ] } }, "/listing/{listing_id}/withdraw/": { "post": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/withdraw-listing" }, "operationId": "rippling.rest_api.withdraw_listing", "parameters": [ { "in": "path", "name": "listing_id", "required": true, "schema": { "format": "id", "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "notes": { "description": "Optional notes to record with the transition.", "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OutputRestApiListingDTO158d299ad06e" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Withdraw listing", "x-rippling-entitlements": [ "Developer_Program" ], "x-rippling-required-scopes": [ "listing.read-write" ] } }, "/location-factors/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/list-location-factors" }, "operationId": "rippling.rest_api.list_location_factors", "parameters": [ { "in": "query", "name": "order_by", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 100, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "__meta": { "$ref": "#/components/schemas/OutputRestApiRedactedFields9f7657dc2a2f" }, "next_link": { "description": "A link to the next page of responses.", "format": "uri", "type": "string" }, "results": { "items": { "$ref": "#/components/schemas/OutputRestApiLocationFactoref8b04003273" }, "type": "array" } }, "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "List location factors", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "location-factors.read" ] } }, "/location-factors/{id}/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/get-location-factors" }, "operationId": "rippling.rest_api.get_location_factors", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "id", "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "__meta": { "properties": { "redacted_fields": { "items": { "$ref": "#/components/schemas/OutputRestApiRedactedField21788a25ef22" }, "type": "array" } }, "type": "object" }, "adjustment_factor": { "anyOf": [ { "description": "Compensation adjustment percentage", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "country": { "description": "Country information set to the country code", "properties": { "code": { "description": "The code of the country.", "type": "string" } }, "required": [ "code" ], "title": "Country", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "display_name": { "description": "Human-readable name for the location factor", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "labour_bucket": { "description": "The labor market category (e.g., \"Engineering\", \"Marketing\", \"Sales\")", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Retrieve a specific location factor", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "location-factors.read" ] } }, "/metadata/deploy/": { "post": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/deploy-metadata-components" }, "operationId": "rippling.rest_api.deploy_metadata_components", "parameters": [ { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiMetadataComponentsRequestab024a9897a3" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OutputRestApiMetadataDeployResponse35168315e63e" } } }, "description": "Metadata deployment result" }, "400": { "description": "Invalid metadata component or request", "x-rippling-source-response": { "content": { "application/json": { "schema": { "properties": { "error": { "additionalProperties": true, "description": "A validation, dependency, permission, or deployment issue.", "properties": { "cause": { "description": "Lower-level cause associated with the issue, when available.", "nullable": true, "type": "string" }, "code": { "description": "Stable machine-readable issue code.", "type": "string" }, "component_type": { "description": "Component type associated with the issue, when available.", "nullable": true, "type": "string" }, "message": { "description": "Human-readable remediation message.", "type": "string" } }, "required": [ "code", "message" ], "title": "MetadataIssue", "type": "object" }, "installations": { "description": "Per-component deployment results.", "items": { "additionalProperties": true, "properties": { "identifier": { "additionalProperties": true, "description": "Installed component identifier.", "type": "object" }, "navigation_target": { "allOf": [ { "properties": { "target_type": { "description": "Type of UI target.", "type": "string" }, "title": { "description": "Display title for the navigation target.", "type": "string" }, "url": { "description": "Relative URL for the installed component.", "type": "string" } }, "required": [ "url", "title", "target_type" ], "title": "MetadataDeployNavigationTarget", "type": "object" } ], "description": "Navigation target for the installed component, when available.", "nullable": true }, "result": { "additionalProperties": true, "description": "Type-specific install result.", "type": "object" }, "status": { "description": "Per-component install result.", "enum": [ "SUCCESS", "FAILED", "SKIPPED_ALREADY_EXISTS", "UPDATED", "SKIPPED_NO_CHANGES" ], "type": "string" }, "type": { "description": "Metadata component type.", "type": "string" } }, "required": [ "type", "identifier", "status" ], "title": "MetadataComponentInstallation", "type": "object" }, "type": "array" }, "success": { "description": "Whether the package deployment completed.", "type": "boolean" } }, "required": [ "success", "installations" ], "title": "MetadataDeployResponse", "type": "object" } } }, "description": "Invalid metadata component or request" } }, "403": { "description": "Insufficient permissions for deployment", "x-rippling-source-response": { "content": { "application/json": { "schema": { "properties": { "error": { "additionalProperties": true, "description": "A validation, dependency, permission, or deployment issue.", "properties": { "cause": { "description": "Lower-level cause associated with the issue, when available.", "nullable": true, "type": "string" }, "code": { "description": "Stable machine-readable issue code.", "type": "string" }, "component_type": { "description": "Component type associated with the issue, when available.", "nullable": true, "type": "string" }, "message": { "description": "Human-readable remediation message.", "type": "string" } }, "required": [ "code", "message" ], "title": "MetadataIssue", "type": "object" }, "installations": { "description": "Per-component deployment results.", "items": { "additionalProperties": true, "properties": { "identifier": { "additionalProperties": true, "description": "Installed component identifier.", "type": "object" }, "navigation_target": { "allOf": [ { "properties": { "target_type": { "description": "Type of UI target.", "type": "string" }, "title": { "description": "Display title for the navigation target.", "type": "string" }, "url": { "description": "Relative URL for the installed component.", "type": "string" } }, "required": [ "url", "title", "target_type" ], "title": "MetadataDeployNavigationTarget", "type": "object" } ], "description": "Navigation target for the installed component, when available.", "nullable": true }, "result": { "additionalProperties": true, "description": "Type-specific install result.", "type": "object" }, "status": { "description": "Per-component install result.", "enum": [ "SUCCESS", "FAILED", "SKIPPED_ALREADY_EXISTS", "UPDATED", "SKIPPED_NO_CHANGES" ], "type": "string" }, "type": { "description": "Metadata component type.", "type": "string" } }, "required": [ "type", "identifier", "status" ], "title": "MetadataComponentInstallation", "type": "object" }, "type": "array" }, "success": { "description": "Whether the package deployment completed.", "type": "boolean" } }, "required": [ "success", "installations" ], "title": "MetadataDeployResponse", "type": "object" } } }, "description": "Insufficient permissions for deployment" } }, "404": { "description": "Metadata component type or dependency not found", "x-rippling-source-response": { "content": { "application/json": { "schema": { "properties": { "error": { "additionalProperties": true, "description": "A validation, dependency, permission, or deployment issue.", "properties": { "cause": { "description": "Lower-level cause associated with the issue, when available.", "nullable": true, "type": "string" }, "code": { "description": "Stable machine-readable issue code.", "type": "string" }, "component_type": { "description": "Component type associated with the issue, when available.", "nullable": true, "type": "string" }, "message": { "description": "Human-readable remediation message.", "type": "string" } }, "required": [ "code", "message" ], "title": "MetadataIssue", "type": "object" }, "installations": { "description": "Per-component deployment results.", "items": { "additionalProperties": true, "properties": { "identifier": { "additionalProperties": true, "description": "Installed component identifier.", "type": "object" }, "navigation_target": { "allOf": [ { "properties": { "target_type": { "description": "Type of UI target.", "type": "string" }, "title": { "description": "Display title for the navigation target.", "type": "string" }, "url": { "description": "Relative URL for the installed component.", "type": "string" } }, "required": [ "url", "title", "target_type" ], "title": "MetadataDeployNavigationTarget", "type": "object" } ], "description": "Navigation target for the installed component, when available.", "nullable": true }, "result": { "additionalProperties": true, "description": "Type-specific install result.", "type": "object" }, "status": { "description": "Per-component install result.", "enum": [ "SUCCESS", "FAILED", "SKIPPED_ALREADY_EXISTS", "UPDATED", "SKIPPED_NO_CHANGES" ], "type": "string" }, "type": { "description": "Metadata component type.", "type": "string" } }, "required": [ "type", "identifier", "status" ], "title": "MetadataComponentInstallation", "type": "object" }, "type": "array" }, "success": { "description": "Whether the package deployment completed.", "type": "boolean" } }, "required": [ "success", "installations" ], "title": "MetadataDeployResponse", "type": "object" } } }, "description": "Metadata component type or dependency not found" } }, "500": { "description": "One or more metadata components could not be installed", "x-rippling-source-response": { "content": { "application/json": { "schema": { "properties": { "error": { "additionalProperties": true, "description": "A validation, dependency, permission, or deployment issue.", "properties": { "cause": { "description": "Lower-level cause associated with the issue, when available.", "nullable": true, "type": "string" }, "code": { "description": "Stable machine-readable issue code.", "type": "string" }, "component_type": { "description": "Component type associated with the issue, when available.", "nullable": true, "type": "string" }, "message": { "description": "Human-readable remediation message.", "type": "string" } }, "required": [ "code", "message" ], "title": "MetadataIssue", "type": "object" }, "installations": { "description": "Per-component deployment results.", "items": { "additionalProperties": true, "properties": { "identifier": { "additionalProperties": true, "description": "Installed component identifier.", "type": "object" }, "navigation_target": { "allOf": [ { "properties": { "target_type": { "description": "Type of UI target.", "type": "string" }, "title": { "description": "Display title for the navigation target.", "type": "string" }, "url": { "description": "Relative URL for the installed component.", "type": "string" } }, "required": [ "url", "title", "target_type" ], "title": "MetadataDeployNavigationTarget", "type": "object" } ], "description": "Navigation target for the installed component, when available.", "nullable": true }, "result": { "additionalProperties": true, "description": "Type-specific install result.", "type": "object" }, "status": { "description": "Per-component install result.", "enum": [ "SUCCESS", "FAILED", "SKIPPED_ALREADY_EXISTS", "UPDATED", "SKIPPED_NO_CHANGES" ], "type": "string" }, "type": { "description": "Metadata component type.", "type": "string" } }, "required": [ "type", "identifier", "status" ], "title": "MetadataComponentInstallation", "type": "object" }, "type": "array" }, "success": { "description": "Whether the package deployment completed.", "type": "boolean" } }, "required": [ "success", "installations" ], "title": "MetadataDeployResponse", "type": "object" } } }, "description": "One or more metadata components could not be installed" } } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Deploy a metadata component package", "x-rippling-entitlements": [ "Metadata_Platform_API" ], "x-rippling-required-scopes": [ "metadata.read-write" ] } }, "/metadata/deployment-runs/": { "post": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/create-metadata-deployment-run" }, "operationId": "rippling.rest_api.create_metadata_deployment_run", "parameters": [ { "in": "header", "name": "Idempotency-Key", "required": false, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiMetadataComponentsRequestab024a9897a3" } } }, "required": true }, "responses": { "202": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "created_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "error": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ] }, "expires_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "finished_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "id": { "description": "Metadata run id.", "type": "string" }, "progress": { "additionalProperties": true, "type": "object" }, "result": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ] }, "retry_after_ms": { "anyOf": [ { "description": "Suggested client polling delay in milliseconds.", "minimum": 0, "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "started_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "status": { "type": "string" }, "terminal": { "description": "Whether the run has reached a terminal status.", "type": "boolean" }, "type": { "type": "string" }, "updated_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "progress", "retry_after_ms", "status", "terminal", "type" ], "type": "object" } } }, "description": "Metadata run status and result." }, "400": { "description": "Invalid metadata component or request", "x-rippling-source-response": { "content": { "application/json": { "schema": { "properties": { "error": { "additionalProperties": true, "description": "A validation, dependency, permission, or deployment issue.", "properties": { "cause": { "description": "Lower-level cause associated with the issue, when available.", "nullable": true, "type": "string" }, "code": { "description": "Stable machine-readable issue code.", "type": "string" }, "component_type": { "description": "Component type associated with the issue, when available.", "nullable": true, "type": "string" }, "message": { "description": "Human-readable remediation message.", "type": "string" } }, "required": [ "code", "message" ], "title": "MetadataIssue", "type": "object" } }, "required": [ "error" ], "title": "MetadataErrorResponse", "type": "object" } } }, "description": "Invalid metadata component or request" } }, "409": { "description": "A conflicting idempotency key or active deployment already exists.", "x-rippling-source-response": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object" } } }, "description": "A conflicting idempotency key or active deployment already exists." } }, "500": { "description": "The metadata run could not be queued.", "x-rippling-source-response": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object" } } }, "description": "The metadata run could not be queued." } } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Start an async metadata deployment run", "x-rippling-entitlements": [ "Metadata_Platform_API" ], "x-rippling-required-scopes": [ "metadata.read-write" ] } }, "/metadata/deployment-runs/{run_id}/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/get-metadata-deployment-run" }, "operationId": "rippling.rest_api.get_metadata_deployment_run", "parameters": [ { "in": "path", "name": "run_id", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "created_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "error": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ] }, "expires_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "finished_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "id": { "description": "Metadata run id.", "type": "string" }, "progress": { "additionalProperties": true, "type": "object" }, "result": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ] }, "retry_after_ms": { "anyOf": [ { "description": "Suggested client polling delay in milliseconds.", "minimum": 0, "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "started_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "status": { "type": "string" }, "terminal": { "description": "Whether the run has reached a terminal status.", "type": "boolean" }, "type": { "type": "string" }, "updated_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "progress", "retry_after_ms", "status", "terminal", "type" ], "type": "object" } } }, "description": "Metadata run status and result." }, "404": { "description": "The metadata run was not found or has expired.", "x-rippling-source-response": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object" } } }, "description": "The metadata run was not found or has expired." } } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Get async metadata deployment run status", "x-rippling-entitlements": [ "Metadata_Platform_API" ], "x-rippling-required-scopes": [ "metadata.read" ] } }, "/metadata/extract/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/extract-metadata-components" }, "operationId": "rippling.rest_api.extract_metadata_components", "parameters": [ { "in": "query", "name": "q", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "limit", "required": false, "schema": { "minimum": 1, "type": "integer" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OutputRestApiMetadataExtractResponsedc528867e38a" } } }, "description": "Extracted metadata package" }, "400": { "description": "Invalid metadata component or request", "x-rippling-source-response": { "content": { "application/json": { "schema": { "properties": { "error": { "additionalProperties": true, "description": "A validation, dependency, permission, or deployment issue.", "properties": { "cause": { "description": "Lower-level cause associated with the issue, when available.", "nullable": true, "type": "string" }, "code": { "description": "Stable machine-readable issue code.", "type": "string" }, "component_type": { "description": "Component type associated with the issue, when available.", "nullable": true, "type": "string" }, "message": { "description": "Human-readable remediation message.", "type": "string" } }, "required": [ "code", "message" ], "title": "MetadataIssue", "type": "object" } }, "required": [ "error" ], "title": "MetadataErrorResponse", "type": "object" } } }, "description": "Invalid metadata component or request" } }, "500": { "description": "Unable to extract metadata components", "x-rippling-source-response": { "content": { "application/json": { "schema": { "properties": { "error": { "additionalProperties": true, "description": "A validation, dependency, permission, or deployment issue.", "properties": { "cause": { "description": "Lower-level cause associated with the issue, when available.", "nullable": true, "type": "string" }, "code": { "description": "Stable machine-readable issue code.", "type": "string" }, "component_type": { "description": "Component type associated with the issue, when available.", "nullable": true, "type": "string" }, "message": { "description": "Human-readable remediation message.", "type": "string" } }, "required": [ "code", "message" ], "title": "MetadataIssue", "type": "object" } }, "required": [ "error" ], "title": "MetadataErrorResponse", "type": "object" } } }, "description": "Unable to extract metadata components" } } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Extract existing metadata components", "x-rippling-entitlements": [ "Metadata_Platform_API" ], "x-rippling-required-scopes": [ "metadata.read" ] }, "post": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/extract-metadata-components-by-identifiers" }, "operationId": "rippling.rest_api.extract_metadata_components_by_identifiers", "parameters": [ { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiMetadataExtractByIdentifiersRequest4075425d83d1" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OutputRestApiMetadataExtractByIdentifiersResponse67d1c02dc278" } } }, "description": "Extracted metadata package" }, "400": { "description": "Invalid metadata identifiers", "x-rippling-source-response": { "content": { "application/json": { "schema": { "properties": { "error": { "additionalProperties": true, "description": "A validation, dependency, permission, or deployment issue.", "properties": { "cause": { "description": "Lower-level cause associated with the issue, when available.", "nullable": true, "type": "string" }, "code": { "description": "Stable machine-readable issue code.", "type": "string" }, "component_type": { "description": "Component type associated with the issue, when available.", "nullable": true, "type": "string" }, "message": { "description": "Human-readable remediation message.", "type": "string" } }, "required": [ "code", "message" ], "title": "MetadataIssue", "type": "object" } }, "required": [ "error" ], "title": "MetadataErrorResponse", "type": "object" } } }, "description": "Invalid metadata identifiers" } }, "403": { "description": "Requested metadata component cannot be read", "x-rippling-source-response": { "content": { "application/json": { "schema": { "properties": { "error": { "additionalProperties": true, "description": "A validation, dependency, permission, or deployment issue.", "properties": { "cause": { "description": "Lower-level cause associated with the issue, when available.", "nullable": true, "type": "string" }, "code": { "description": "Stable machine-readable issue code.", "type": "string" }, "component_type": { "description": "Component type associated with the issue, when available.", "nullable": true, "type": "string" }, "message": { "description": "Human-readable remediation message.", "type": "string" } }, "required": [ "code", "message" ], "title": "MetadataIssue", "type": "object" } }, "required": [ "error" ], "title": "MetadataErrorResponse", "type": "object" } } }, "description": "Requested metadata component cannot be read" } }, "404": { "description": "Metadata component type or dependency not found", "x-rippling-source-response": { "content": { "application/json": { "schema": { "properties": { "error": { "additionalProperties": true, "description": "A validation, dependency, permission, or deployment issue.", "properties": { "cause": { "description": "Lower-level cause associated with the issue, when available.", "nullable": true, "type": "string" }, "code": { "description": "Stable machine-readable issue code.", "type": "string" }, "component_type": { "description": "Component type associated with the issue, when available.", "nullable": true, "type": "string" }, "message": { "description": "Human-readable remediation message.", "type": "string" } }, "required": [ "code", "message" ], "title": "MetadataIssue", "type": "object" } }, "required": [ "error" ], "title": "MetadataErrorResponse", "type": "object" } } }, "description": "Metadata component type or dependency not found" } } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Extract metadata components by identifier", "x-rippling-entitlements": [ "Metadata_Platform_API" ], "x-rippling-required-scopes": [ "metadata.read" ] } }, "/metadata/schema/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/get-metadata-schema" }, "operationId": "rippling.rest_api.get_metadata_schema", "parameters": [ { "in": "query", "name": "type", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OutputRestApiMetadataTypeSchema11511d8b37c8" } } }, "description": "Metadata component schema" }, "400": { "description": "Invalid metadata component or request", "x-rippling-source-response": { "content": { "application/json": { "schema": { "properties": { "error": { "additionalProperties": true, "description": "A validation, dependency, permission, or deployment issue.", "properties": { "cause": { "description": "Lower-level cause associated with the issue, when available.", "nullable": true, "type": "string" }, "code": { "description": "Stable machine-readable issue code.", "type": "string" }, "component_type": { "description": "Component type associated with the issue, when available.", "nullable": true, "type": "string" }, "message": { "description": "Human-readable remediation message.", "type": "string" } }, "required": [ "code", "message" ], "title": "MetadataIssue", "type": "object" } }, "required": [ "error" ], "title": "MetadataErrorResponse", "type": "object" } } }, "description": "Invalid metadata component or request" } }, "404": { "description": "Metadata component type not found", "x-rippling-source-response": { "content": { "application/json": { "schema": { "properties": { "error": { "additionalProperties": true, "description": "A validation, dependency, permission, or deployment issue.", "properties": { "cause": { "description": "Lower-level cause associated with the issue, when available.", "nullable": true, "type": "string" }, "code": { "description": "Stable machine-readable issue code.", "type": "string" }, "component_type": { "description": "Component type associated with the issue, when available.", "nullable": true, "type": "string" }, "message": { "description": "Human-readable remediation message.", "type": "string" } }, "required": [ "code", "message" ], "title": "MetadataIssue", "type": "object" } }, "required": [ "error" ], "title": "MetadataErrorResponse", "type": "object" } } }, "description": "Metadata component type not found" } } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Get a metadata schema", "x-rippling-entitlements": [ "Metadata_Platform_API" ], "x-rippling-required-scopes": [ "metadata.read" ] } }, "/metadata/types/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/list-metadata-types" }, "operationId": "rippling.rest_api.list_metadata_types", "parameters": [ { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OutputRestApiMetadataTypesResponseadffc1eb594f" } } }, "description": "Supported metadata component types" }, "400": { "description": "Invalid metadata component or request", "x-rippling-source-response": { "content": { "application/json": { "schema": { "properties": { "error": { "additionalProperties": true, "description": "A validation, dependency, permission, or deployment issue.", "properties": { "cause": { "description": "Lower-level cause associated with the issue, when available.", "nullable": true, "type": "string" }, "code": { "description": "Stable machine-readable issue code.", "type": "string" }, "component_type": { "description": "Component type associated with the issue, when available.", "nullable": true, "type": "string" }, "message": { "description": "Human-readable remediation message.", "type": "string" } }, "required": [ "code", "message" ], "title": "MetadataIssue", "type": "object" } }, "required": [ "error" ], "title": "MetadataErrorResponse", "type": "object" } } }, "description": "Invalid metadata component or request" } } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "List supported metadata types", "x-rippling-entitlements": [ "Metadata_Platform_API" ], "x-rippling-required-scopes": [ "metadata.read" ] } }, "/metadata/validate/": { "post": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/validate-metadata-components" }, "operationId": "rippling.rest_api.validate_metadata_components", "parameters": [ { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiMetadataComponentsRequestab024a9897a3" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OutputRestApiMetadataValidationResponse02e9eb214b0a" } } }, "description": "Metadata validation result" }, "400": { "description": "Invalid metadata component or request", "x-rippling-source-response": { "content": { "application/json": { "schema": { "oneOf": [ { "required": [ "valid", "results", "errors" ], "title": "MetadataValidationResponse", "type": "object" }, { "required": [ "error" ], "title": "MetadataErrorResponse", "type": "object" } ] } } }, "description": "Invalid metadata component or request" } }, "404": { "description": "Metadata component type or dependency not found", "x-rippling-source-response": { "content": { "application/json": { "schema": { "properties": { "error": { "additionalProperties": true, "description": "A validation, dependency, permission, or deployment issue.", "properties": { "cause": { "description": "Lower-level cause associated with the issue, when available.", "nullable": true, "type": "string" }, "code": { "description": "Stable machine-readable issue code.", "type": "string" }, "component_type": { "description": "Component type associated with the issue, when available.", "nullable": true, "type": "string" }, "message": { "description": "Human-readable remediation message.", "type": "string" } }, "required": [ "code", "message" ], "title": "MetadataIssue", "type": "object" } }, "required": [ "error" ], "title": "MetadataErrorResponse", "type": "object" } } }, "description": "Metadata component type or dependency not found" } } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Validate metadata components", "x-rippling-entitlements": [ "Metadata_Platform_API" ], "x-rippling-required-scopes": [ "metadata.read-write" ] } }, "/metadata/validation-runs/": { "post": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/create-metadata-validation-run" }, "operationId": "rippling.rest_api.create_metadata_validation_run", "parameters": [ { "in": "header", "name": "Idempotency-Key", "required": false, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiMetadataComponentsRequestab024a9897a3" } } }, "required": true }, "responses": { "202": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "created_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "error": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ] }, "expires_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "finished_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "id": { "description": "Metadata run id.", "type": "string" }, "progress": { "additionalProperties": true, "type": "object" }, "result": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ] }, "retry_after_ms": { "anyOf": [ { "description": "Suggested client polling delay in milliseconds.", "minimum": 0, "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "started_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "status": { "type": "string" }, "terminal": { "description": "Whether the run has reached a terminal status.", "type": "boolean" }, "type": { "type": "string" }, "updated_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "progress", "retry_after_ms", "status", "terminal", "type" ], "type": "object" } } }, "description": "Metadata run status and result." }, "400": { "description": "Invalid metadata component or request", "x-rippling-source-response": { "content": { "application/json": { "schema": { "properties": { "error": { "additionalProperties": true, "description": "A validation, dependency, permission, or deployment issue.", "properties": { "cause": { "description": "Lower-level cause associated with the issue, when available.", "nullable": true, "type": "string" }, "code": { "description": "Stable machine-readable issue code.", "type": "string" }, "component_type": { "description": "Component type associated with the issue, when available.", "nullable": true, "type": "string" }, "message": { "description": "Human-readable remediation message.", "type": "string" } }, "required": [ "code", "message" ], "title": "MetadataIssue", "type": "object" } }, "required": [ "error" ], "title": "MetadataErrorResponse", "type": "object" } } }, "description": "Invalid metadata component or request" } }, "409": { "description": "A conflicting idempotency key or active deployment already exists.", "x-rippling-source-response": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object" } } }, "description": "A conflicting idempotency key or active deployment already exists." } }, "500": { "description": "The metadata run could not be queued.", "x-rippling-source-response": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object" } } }, "description": "The metadata run could not be queued." } } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Start an async metadata validation run", "x-rippling-entitlements": [ "Metadata_Platform_API" ], "x-rippling-required-scopes": [ "metadata.read-write" ] } }, "/metadata/validation-runs/{run_id}/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/get-metadata-validation-run" }, "operationId": "rippling.rest_api.get_metadata_validation_run", "parameters": [ { "in": "path", "name": "run_id", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "created_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "error": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ] }, "expires_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "finished_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "id": { "description": "Metadata run id.", "type": "string" }, "progress": { "additionalProperties": true, "type": "object" }, "result": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ] }, "retry_after_ms": { "anyOf": [ { "description": "Suggested client polling delay in milliseconds.", "minimum": 0, "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "started_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "status": { "type": "string" }, "terminal": { "description": "Whether the run has reached a terminal status.", "type": "boolean" }, "type": { "type": "string" }, "updated_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "progress", "retry_after_ms", "status", "terminal", "type" ], "type": "object" } } }, "description": "Metadata run status and result." }, "404": { "description": "The metadata run was not found or has expired.", "x-rippling-source-response": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object" } } }, "description": "The metadata run was not found or has expired." } } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Get async metadata validation run status", "x-rippling-entitlements": [ "Metadata_Platform_API" ], "x-rippling-required-scopes": [ "metadata.read" ] } }, "/object-categories/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/list-object-categories" }, "operationId": "rippling.rest_api.list_object_categories", "parameters": [ { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 100, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "next_link": { "description": "A link to the next page of responses.", "format": "uri", "type": "string" }, "results": { "items": { "$ref": "#/components/schemas/OutputRestApiObjectCategoryd94265f21b42" }, "type": "array" } }, "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "List object categories", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "custom-objects.read", "custom-objects.read-write", "custom-objects.read-write.owner" ] }, "post": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/create-object-categories" }, "operationId": "rippling.rest_api.create_object_categories", "parameters": [ { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "description": { "description": "A description of the category.", "type": "string" }, "name": { "description": "The name of the category.", "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "description": { "description": "The description of the Custom Category", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the Custom Category", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "ObjectCategory", "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Create a new object category", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "custom-objects.read-write.owner" ] } }, "/object-categories/{id}/": { "delete": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/delete-object-categories" }, "operationId": "rippling.rest_api.delete_object_categories", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "204": { "description": "The resource was deleted successfully" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Delete an object category", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "custom-objects.read-write", "custom-objects.read-write.owner" ] }, "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/get-object-categories" }, "operationId": "rippling.rest_api.get_object_categories", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "description": { "description": "The description of the Custom Category", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the Custom Category", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "ObjectCategory", "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Retrieve a specific object category", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "custom-objects.read", "custom-objects.read-write", "custom-objects.read-write.owner" ] }, "patch": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/update-object-categories" }, "operationId": "rippling.rest_api.update_object_categories", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "description": { "description": "A description of the category.", "type": "string" }, "name": { "description": "The name of the category.", "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "description": { "description": "The description of the Custom Category", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the Custom Category", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "ObjectCategory", "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Update an object category", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "custom-objects.read-write", "custom-objects.read-write.owner" ] } }, "/package-installs/": { "post": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/install-package-installs" }, "operationId": "rippling.rest_api.install_package_installs", "parameters": [ { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "version_id": { "description": "The published package version to install.", "type": "string" } }, "required": [ "version_id" ], "type": "object" } } }, "required": false }, "responses": { "202": { "content": { "application/json": { "schema": { "description": "Async package installation tracker for subscriber companies.", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "error_message": { "description": "Error message when installation failed", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "installation_record_id": { "description": "Installation record ID when installation completes", "type": "string" }, "package_version_id": { "description": "The package version being installed", "type": "string" }, "post_install_landing_component": { "description": "Component to open after installation completes", "type": "object" }, "progress": { "description": "Installation progress entries", "items": { "additionalProperties": {} }, "type": "array" }, "status": { "description": "Installation status (IN_PROGRESS, COMPLETE, or FAILED)", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "PackageInstallationTracker", "type": "object" } } }, "description": "Installation accepted" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Start a package install", "x-rippling-entitlements": [ "Unity_Packages_V2_Platform_API" ], "x-rippling-required-scopes": [ "packages-install.read-write" ] } }, "/package-installs/{tracker_id}/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/get-package-installs" }, "operationId": "rippling.rest_api.get_package_installs", "parameters": [ { "in": "path", "name": "tracker_id", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "Async package installation tracker for subscriber companies.", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "error_message": { "description": "Error message when installation failed", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "installation_record_id": { "description": "Installation record ID when installation completes", "type": "string" }, "package_version_id": { "description": "The package version being installed", "type": "string" }, "post_install_landing_component": { "description": "Component to open after installation completes", "type": "object" }, "progress": { "description": "Installation progress entries", "items": { "additionalProperties": {} }, "type": "array" }, "status": { "description": "Installation status (IN_PROGRESS, COMPLETE, or FAILED)", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "PackageInstallationTracker", "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Retrieve a package install", "x-rippling-entitlements": [ "Unity_Packages_V2_Platform_API" ], "x-rippling-required-scopes": [ "packages-install.read-write" ] } }, "/package-managed-installs/": { "post": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/install-package-managed-installs" }, "operationId": "rippling.rest_api.install_package_managed_installs", "parameters": [ { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "install_key": { "description": "The install key for this managed package install.", "type": "string" }, "package_key": { "description": "The package key of the managed package to install.", "type": "string" }, "version_id": { "description": "The published package version to install.", "type": "string" } }, "required": [ "install_key", "package_key", "version_id" ], "type": "object" } } }, "required": false }, "responses": { "202": { "content": { "application/json": { "schema": { "description": "Living managed package install in a subscriber company.", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "install_key": { "description": "The install key of the managed package install", "type": "string" }, "installed_version_id": { "description": "The published package version currently installed or being installed", "type": "string" }, "package_key": { "description": "The package key of the managed package", "type": "string" }, "post_install_landing_component": { "description": "Component to open after installation completes", "type": "object" }, "progress": { "description": "Installation progress entries", "items": { "additionalProperties": {} }, "type": "array" }, "status": { "description": "Managed install status (INSTALLING, UPDATING, UNINSTALLING, ACTIVE, ACTIVE_WITH_WARNINGS, UNINSTALLED, FAILED, or UNINSTALL_FAILED)", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "ManagedPackageInstallation", "type": "object" } } }, "description": "Managed installation accepted" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Start a managed package install", "x-rippling-entitlements": [ "Unity_Packages_V2_Platform_API" ], "x-rippling-required-scopes": [ "packages-install.read-write" ] } }, "/package-managed-installs/{install_id}/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/get-package-managed-installs" }, "operationId": "rippling.rest_api.get_package_managed_installs", "parameters": [ { "in": "path", "name": "install_id", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "Living managed package install in a subscriber company.", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "install_key": { "description": "The install key of the managed package install", "type": "string" }, "installed_version_id": { "description": "The published package version currently installed or being installed", "type": "string" }, "package_key": { "description": "The package key of the managed package", "type": "string" }, "post_install_landing_component": { "description": "Component to open after installation completes", "type": "object" }, "progress": { "description": "Installation progress entries", "items": { "additionalProperties": {} }, "type": "array" }, "status": { "description": "Managed install status (INSTALLING, UPDATING, UNINSTALLING, ACTIVE, ACTIVE_WITH_WARNINGS, UNINSTALLED, FAILED, or UNINSTALL_FAILED)", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "ManagedPackageInstallation", "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Retrieve a managed package install", "x-rippling-entitlements": [ "Unity_Packages_V2_Platform_API" ], "x-rippling-required-scopes": [ "packages-install.read-write" ] } }, "/package-sandbox-links/": { "post": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/create-package-sandbox-links" }, "operationId": "rippling.rest_api.create_package_sandbox_links", "parameters": [ { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiPackageSandboxLinkRequeste6847f01192a" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/OutputRestApiPackageSandboxLink33c28a65c482" }, { "$ref": "#/components/schemas/OutputRestApiPackageSandboxLink33c28a65c482" } ] } } }, "description": "Link completed" }, "202": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/OutputRestApiPackageSandboxLink33c28a65c482" }, { "$ref": "#/components/schemas/OutputRestApiPackageSandboxLink33c28a65c482" } ] } } }, "description": "Link accepted" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Create a package sandbox link", "x-rippling-entitlements": [ "Unity_Packages_V2_Platform_API" ], "x-rippling-required-scopes": [ "packages.read-write" ] } }, "/package-sandbox-links/{tracker_id}/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/get-package-sandbox-links" }, "operationId": "rippling.rest_api.get_package_sandbox_links", "parameters": [ { "in": "path", "name": "tracker_id", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OutputRestApiPackageSandboxLink33c28a65c482" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Retrieve a package sandbox link", "x-rippling-entitlements": [ "Unity_Packages_V2_Platform_API" ], "x-rippling-required-scopes": [ "packages.read-write" ] } }, "/package-uninstalls/": { "post": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/uninstall-package-uninstalls" }, "operationId": "rippling.rest_api.uninstall_package_uninstalls", "parameters": [ { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "install_key": { "description": "The install key of the managed package install to uninstall.", "type": "string" }, "package_key": { "description": "The package key of the managed package to uninstall.", "type": "string" } }, "required": [ "install_key", "package_key" ], "type": "object" } } }, "required": false }, "responses": { "202": { "content": { "application/json": { "schema": { "description": "Async managed package uninstall tracker for subscriber companies.", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "error_message": { "description": "Error message when uninstallation failed", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "install_key": { "description": "The install key of the managed package install", "type": "string" }, "installed_version_id": { "description": "The installed package version being uninstalled", "type": "string" }, "managed_install_id": { "description": "The managed package install being uninstalled", "type": "string" }, "package_key": { "description": "The package key of the managed package", "type": "string" }, "status": { "description": "Uninstallation status (IN_PROGRESS, COMPLETE, or FAILED)", "type": "string" }, "uninstall_plan": { "description": "Uninstall plan snapshot when available", "type": "object" }, "uninstalled_components": { "description": "Components uninstalled so far", "items": { "additionalProperties": {} }, "type": "array" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "PackageUninstallationTracker", "type": "object" } } }, "description": "Uninstallation accepted" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Start a package uninstall", "x-rippling-entitlements": [ "Unity_Packages_V2_Platform_API" ], "x-rippling-required-scopes": [ "packages-install.read-write" ] } }, "/package-uninstalls/{tracker_id}/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/get-package-uninstalls" }, "operationId": "rippling.rest_api.get_package_uninstalls", "parameters": [ { "in": "path", "name": "tracker_id", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "Async managed package uninstall tracker for subscriber companies.", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "error_message": { "description": "Error message when uninstallation failed", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "install_key": { "description": "The install key of the managed package install", "type": "string" }, "installed_version_id": { "description": "The installed package version being uninstalled", "type": "string" }, "managed_install_id": { "description": "The managed package install being uninstalled", "type": "string" }, "package_key": { "description": "The package key of the managed package", "type": "string" }, "status": { "description": "Uninstallation status (IN_PROGRESS, COMPLETE, or FAILED)", "type": "string" }, "uninstall_plan": { "description": "Uninstall plan snapshot when available", "type": "object" }, "uninstalled_components": { "description": "Components uninstalled so far", "items": { "additionalProperties": {} }, "type": "array" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "PackageUninstallationTracker", "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Retrieve a package uninstall", "x-rippling-entitlements": [ "Unity_Packages_V2_Platform_API" ], "x-rippling-required-scopes": [ "packages-install.read-write" ] } }, "/package-upgrades/": { "post": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/upgrade-package-upgrades" }, "operationId": "rippling.rest_api.upgrade_package_upgrades", "parameters": [ { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "install_key": { "description": "The install key of the managed package install to upgrade.", "type": "string" }, "package_key": { "description": "The package key of the managed package to upgrade.", "type": "string" }, "version_id": { "description": "The published package version to upgrade to.", "type": "string" } }, "required": [ "install_key", "package_key", "version_id" ], "type": "object" } } }, "required": false }, "responses": { "202": { "content": { "application/json": { "schema": { "description": "Async managed package upgrade tracker for subscriber companies.", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "error_message": { "description": "Error message when upgrade failed", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "install_key": { "description": "The install key of the managed package install", "type": "string" }, "new_version_id": { "description": "The published package version being upgraded to", "type": "string" }, "old_version_id": { "description": "The currently installed package version being upgraded from", "type": "string" }, "package_key": { "description": "The package key of the managed package", "type": "string" }, "post_install_landing_component": { "description": "Component to open after upgrade completes", "type": "object" }, "status": { "description": "Upgrade status (IN_PROGRESS, COMPLETE, or FAILED)", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "upgrade_plan": { "description": "Upgrade plan snapshot when available", "type": "object" }, "upgraded_components": { "description": "Components upgraded so far", "items": { "additionalProperties": {} }, "type": "array" } }, "required": [ "created_at", "id", "updated_at" ], "title": "PackageUpgradeTracker", "type": "object" } } }, "description": "Upgrade accepted" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Start a package upgrade", "x-rippling-entitlements": [ "Unity_Packages_V2_Platform_API" ], "x-rippling-required-scopes": [ "packages-install.read-write" ] } }, "/package-upgrades/{tracker_id}/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/get-package-upgrades" }, "operationId": "rippling.rest_api.get_package_upgrades", "parameters": [ { "in": "path", "name": "tracker_id", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "Async managed package upgrade tracker for subscriber companies.", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "error_message": { "description": "Error message when upgrade failed", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "install_key": { "description": "The install key of the managed package install", "type": "string" }, "new_version_id": { "description": "The published package version being upgraded to", "type": "string" }, "old_version_id": { "description": "The currently installed package version being upgraded from", "type": "string" }, "package_key": { "description": "The package key of the managed package", "type": "string" }, "post_install_landing_component": { "description": "Component to open after upgrade completes", "type": "object" }, "status": { "description": "Upgrade status (IN_PROGRESS, COMPLETE, or FAILED)", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "upgrade_plan": { "description": "Upgrade plan snapshot when available", "type": "object" }, "upgraded_components": { "description": "Components upgraded so far", "items": { "additionalProperties": {} }, "type": "array" } }, "required": [ "created_at", "id", "updated_at" ], "title": "PackageUpgradeTracker", "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Retrieve a package upgrade", "x-rippling-entitlements": [ "Unity_Packages_V2_Platform_API" ], "x-rippling-required-scopes": [ "packages-install.read-write" ] } }, "/package-version-component-updates/": { "post": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/update-package-version-component-updates" }, "operationId": "rippling.rest_api.update_package_version_component_updates", "parameters": [ { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "action": { "description": "The update action to perform.", "enum": [ "ADD", "REMOVE", "REFRESH" ], "type": "string" }, "is_preview_mode": { "default": false, "description": "When true, compute the component diff without persisting the version. When false, apply and save the changes. Same tracker contract in both modes.", "type": "boolean" }, "nodes": { "description": "Component identifiers required for ADD and REMOVE.", "items": { "type": "object" }, "type": "array" }, "version_id": { "description": "The draft package version to update.", "type": "string" } }, "required": [ "action", "version_id" ], "type": "object" } } }, "required": false }, "responses": { "202": { "content": { "application/json": { "schema": { "description": "Async package version component-update tracker for publisher companies.", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "error_message": { "description": "Error message when the update failed", "type": "string" }, "extraction_result": { "description": "Diff of added, removed, and updated nodes when status is COMPLETE. In preview mode this is what would change; in apply mode this is what did change. Null while the update is in progress.", "type": "object" }, "id": { "description": "Identifier field", "type": "string" }, "package_version_id": { "description": "The package version being updated", "type": "string" }, "status": { "description": "Update status (IN_PROGRESS, COMPLETE, or FAILED)", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "PackageVersionUpdateTracker", "type": "object" } } }, "description": "Update accepted" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Start a package version component update", "x-rippling-entitlements": [ "Unity_Packages_V2_Platform_API" ], "x-rippling-required-scopes": [ "packages.read-write" ] } }, "/package-version-component-updates/{tracker_id}/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/get-package-version-component-updates" }, "operationId": "rippling.rest_api.get_package_version_component_updates", "parameters": [ { "in": "path", "name": "tracker_id", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "Async package version component-update tracker for publisher companies.", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "error_message": { "description": "Error message when the update failed", "type": "string" }, "extraction_result": { "description": "Diff of added, removed, and updated nodes when status is COMPLETE. In preview mode this is what would change; in apply mode this is what did change. Null while the update is in progress.", "type": "object" }, "id": { "description": "Identifier field", "type": "string" }, "package_version_id": { "description": "The package version being updated", "type": "string" }, "status": { "description": "Update status (IN_PROGRESS, COMPLETE, or FAILED)", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "PackageVersionUpdateTracker", "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Retrieve a package version component update", "x-rippling-entitlements": [ "Unity_Packages_V2_Platform_API" ], "x-rippling-required-scopes": [ "packages.read-write" ] } }, "/package-versions/{version_id}/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/get-package-versions" }, "operationId": "rippling.rest_api.get_package_versions", "parameters": [ { "in": "path", "name": "version_id", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OutputRestApiPackageVersion8e4a198e8bf8" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Get a package version", "x-rippling-entitlements": [], "x-rippling-required-scopes": [ "packages.read" ] }, "patch": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/update-package-versions" }, "operationId": "rippling.rest_api.update_package_versions", "parameters": [ { "in": "path", "name": "version_id", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "description": { "description": "The new description for the draft package version.", "type": "string" } }, "required": [ "description" ], "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "components": { "description": "Components included in this package version", "items": { "additionalProperties": {} }, "type": "array" }, "created_at": { "description": "Record creation date", "type": "string" }, "description": { "description": "The description of the package version", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_published": { "description": "Whether this package version has been published", "type": "boolean" }, "package_display_name": { "description": "The display name of the parent package", "type": "string" }, "package_id": { "description": "The ID of the parent package", "type": "string" }, "package_key": { "description": "The package key of the parent package", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "version_number": { "description": "The semantic version number for this package version", "type": "string" } }, "required": [ "created_at", "id", "updated_at", "version_number" ], "title": "PackageVersion", "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Update a package version", "x-rippling-entitlements": [ "Unity_Packages_V2_Platform_API" ], "x-rippling-required-scopes": [ "packages.read-write" ] } }, "/package-versions/{version_id}/publish/": { "post": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/publish-package-versions" }, "operationId": "rippling.rest_api.publish_package_versions", "parameters": [ { "in": "path", "name": "version_id", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OutputRestApiPackageVersion8e4a198e8bf8" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Publish a package version", "x-rippling-entitlements": [], "x-rippling-required-scopes": [ "packages.read-write" ] } }, "/packages/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/list-packages" }, "operationId": "rippling.rest_api.list_packages", "parameters": [ { "in": "query", "name": "filter", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 100, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "__meta": { "$ref": "#/components/schemas/OutputRestApiRedactedFields9f7657dc2a2f" }, "next_link": { "description": "A link to the next page of responses.", "format": "uri", "type": "string" }, "results": { "items": { "$ref": "#/components/schemas/OutputRestApiPackagef98f6a60f6b1" }, "type": "array" } }, "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "List packages", "x-rippling-entitlements": [ "Unity_Packages_V2_Platform_API" ], "x-rippling-required-scopes": [ "packages.read" ] }, "post": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/create-packages" }, "operationId": "rippling.rest_api.create_packages", "parameters": [ { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiPackageRequest131ebb92b650" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "description": { "description": "The description of the package", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "latest_version_id": { "description": "The ID of the latest package version, if any", "type": "string" }, "latest_version_number": { "description": "The version number of the latest package version, if any", "type": "string" }, "package_display_name": { "description": "The display name of the package", "type": "string" }, "package_key": { "description": "The unique package key within the publisher company", "type": "string" }, "package_type": { "description": "The package type", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "package_display_name", "package_key", "package_type", "updated_at" ], "title": "Package", "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Create a new package", "x-rippling-entitlements": [ "Unity_Packages_V2_Platform_API" ], "x-rippling-required-scopes": [ "packages.read-write" ] } }, "/packages/{package_key}/": { "delete": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/delete-packages" }, "operationId": "rippling.rest_api.delete_packages", "parameters": [ { "in": "path", "name": "package_key", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "204": { "description": "The resource was deleted successfully" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Delete a package", "x-rippling-entitlements": [ "Unity_Packages_V2_Platform_API" ], "x-rippling-required-scopes": [ "packages.read-write" ] }, "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/get-packages" }, "operationId": "rippling.rest_api.get_packages", "parameters": [ { "in": "path", "name": "package_key", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "__meta": { "properties": { "redacted_fields": { "items": { "$ref": "#/components/schemas/OutputRestApiRedactedField21788a25ef22" }, "type": "array" } }, "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "description": { "description": "The description of the package", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "latest_version_id": { "description": "The ID of the latest package version, if any", "type": "string" }, "latest_version_number": { "description": "The version number of the latest package version, if any", "type": "string" }, "package_display_name": { "description": "The display name of the package", "type": "string" }, "package_key": { "description": "The unique package key within the publisher company", "type": "string" }, "package_type": { "description": "The package type", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "package_display_name", "package_key", "package_type", "updated_at" ], "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Retrieve a specific package", "x-rippling-entitlements": [ "Unity_Packages_V2_Platform_API" ], "x-rippling-required-scopes": [ "packages.read" ] }, "patch": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/update-packages" }, "operationId": "rippling.rest_api.update_packages", "parameters": [ { "in": "path", "name": "package_key", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiPackageRequest131ebb92b650" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "description": { "description": "The description of the package", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "latest_version_id": { "description": "The ID of the latest package version, if any", "type": "string" }, "latest_version_number": { "description": "The version number of the latest package version, if any", "type": "string" }, "package_display_name": { "description": "The display name of the package", "type": "string" }, "package_key": { "description": "The unique package key within the publisher company", "type": "string" }, "package_type": { "description": "The package type", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "package_display_name", "package_key", "package_type", "updated_at" ], "title": "Package", "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Update a package", "x-rippling-entitlements": [ "Unity_Packages_V2_Platform_API" ], "x-rippling-required-scopes": [ "packages.read-write" ] } }, "/packages/{package_key}/available-upgrades/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/list-available-package-upgrades" }, "operationId": "rippling.rest_api.list_available_package_upgrades", "parameters": [ { "in": "path", "name": "package_key", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "install_key", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "results": { "items": { "properties": { "description": { "type": "string" }, "id": { "type": "string" }, "version_number": { "type": "string" } }, "type": "object" }, "type": "array" } }, "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "List package versions available for upgrade", "x-rippling-entitlements": [ "Unity_Packages_V2_Platform_API" ], "x-rippling-required-scopes": [ "packages-install.read", "packages-install.read-write" ] } }, "/packages/{package_key}/next-versions/": { "post": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/create-next-package-versions" }, "operationId": "rippling.rest_api.create_next_package_versions", "parameters": [ { "in": "path", "name": "package_key", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "description": { "description": "Optional description for the new draft.", "type": "string" }, "version_number": { "description": "The version number for the new unpublished draft.", "type": "string" } }, "required": [ "version_number" ], "type": "object" } } }, "required": false }, "responses": { "201": { "content": { "application/json": { "schema": { "description": "", "properties": { "components": { "description": "Components included in this package version", "items": { "additionalProperties": {} }, "type": "array" }, "created_at": { "description": "Record creation date", "type": "string" }, "description": { "description": "The description of the package version", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_published": { "description": "Whether this package version has been published", "type": "boolean" }, "package_display_name": { "description": "The display name of the parent package", "type": "string" }, "package_id": { "description": "The ID of the parent package", "type": "string" }, "package_key": { "description": "The package key of the parent package", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "version_number": { "description": "The semantic version number for this package version", "type": "string" } }, "required": [ "created_at", "id", "updated_at", "version_number" ], "title": "PackageVersion", "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Create a package version from a published version", "x-rippling-entitlements": [ "Unity_Packages_V2_Platform_API" ], "x-rippling-required-scopes": [ "packages.read-write" ] } }, "/packages/{package_key}/versions/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/list-package-versions" }, "operationId": "rippling.rest_api.list_package_versions", "parameters": [ { "in": "path", "name": "package_key", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 100, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "next_link": { "anyOf": [ { "format": "uri", "type": "string" }, { "type": "null" } ] }, "results": { "items": { "$ref": "#/components/schemas/OutputRestApiPackageVersion8e4a198e8bf8" }, "type": "array" } }, "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "List package versions", "x-rippling-entitlements": [], "x-rippling-required-scopes": [ "packages.read" ] }, "post": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/create-package-versions" }, "operationId": "rippling.rest_api.create_package_versions", "parameters": [ { "in": "path", "name": "package_key", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiPackageVersionRequest4d6cb484e0e4" } } }, "required": false }, "responses": { "201": { "content": { "application/json": { "schema": { "description": "", "properties": { "components": { "description": "Components included in this package version", "items": { "additionalProperties": {} }, "type": "array" }, "created_at": { "description": "Record creation date", "type": "string" }, "description": { "description": "The description of the package version", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_published": { "description": "Whether this package version has been published", "type": "boolean" }, "package_display_name": { "description": "The display name of the parent package", "type": "string" }, "package_id": { "description": "The ID of the parent package", "type": "string" }, "package_key": { "description": "The package key of the parent package", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "version_number": { "description": "The semantic version number for this package version", "type": "string" } }, "required": [ "created_at", "id", "updated_at", "version_number" ], "title": "PackageVersion", "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Create a new package version", "x-rippling-entitlements": [ "Unity_Packages_V2_Platform_API" ], "x-rippling-required-scopes": [ "packages.read-write" ] } }, "/payroll-payment-mode-changes/": { "post": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/create-payroll-payment-mode-changes" }, "operationId": "rippling.rest_api.create_payroll_payment_mode_changes", "parameters": [ { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiPaymentModeChangeRequest0db884401aa6" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OutputRestApiPaymentModeChangeResponsef326e4f5c1c2" } } }, "description": "Successful response" }, "400": { "description": "Invalid request.", "x-rippling-source-response": { "content": { "application/json": { "schema": { "description": "", "properties": { "errors": { "description": "All request validation or authorization errors detected before any payment mode is written. The array lets callers correct every reported issue before retrying the request.", "items": { "description": "", "properties": { "code": { "description": "Machine-readable request error code. INVALID_REQUEST, MISSING_REQUIRED_FIELD, INVALID_PAYMENT_MODE, and REQUEST_TOO_LARGE are terminal until the request is corrected; PERMISSION_DENIED is terminal until the caller has the required authorization.", "enum": [ "INVALID_REQUEST", "MISSING_REQUIRED_FIELD", "INVALID_PAYMENT_MODE", "REQUEST_TOO_LARGE", "PERMISSION_DENIED" ], "type": "string" }, "message": { "description": "Human-readable error message.", "type": "string" } }, "title": "PaymentModeChangeRequestError", "type": "object", "x-rippling-expandable-fields": [] }, "type": "array" } }, "title": "PaymentModeChangeRequestErrorResponse", "type": "object", "x-rippling-expandable-fields": [] } } }, "description": "Invalid request." } }, "403": { "description": "Permission denied.", "x-rippling-source-response": { "content": { "application/json": { "schema": { "description": "", "properties": { "errors": { "description": "All request validation or authorization errors detected before any payment mode is written. The array lets callers correct every reported issue before retrying the request.", "items": { "description": "", "properties": { "code": { "description": "Machine-readable request error code. INVALID_REQUEST, MISSING_REQUIRED_FIELD, INVALID_PAYMENT_MODE, and REQUEST_TOO_LARGE are terminal until the request is corrected; PERMISSION_DENIED is terminal until the caller has the required authorization.", "enum": [ "INVALID_REQUEST", "MISSING_REQUIRED_FIELD", "INVALID_PAYMENT_MODE", "REQUEST_TOO_LARGE", "PERMISSION_DENIED" ], "type": "string" }, "message": { "description": "Human-readable error message.", "type": "string" } }, "title": "PaymentModeChangeRequestError", "type": "object", "x-rippling-expandable-fields": [] }, "type": "array" } }, "title": "PaymentModeChangeRequestErrorResponse", "type": "object", "x-rippling-expandable-fields": [] } } }, "description": "Permission denied." } } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Create a new payroll payment mode change", "x-rippling-entitlements": [ "Internal_Testing" ], "x-rippling-required-scopes": [ "payroll-payment-mode-changes.read-write" ] } }, "/payroll-runs/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/list-payroll-runs" }, "operationId": "rippling.rest_api.list_payroll_runs", "parameters": [ { "in": "query", "name": "order_by", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 100, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "__meta": { "$ref": "#/components/schemas/OutputRestApiRedactedFields9f7657dc2a2f" }, "next_link": { "description": "A link to the next page of responses.", "format": "uri", "type": "string" }, "results": { "items": { "$ref": "#/components/schemas/OutputRestApiPayrollRun7ba294474a8d" }, "type": "array" } }, "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "List payroll-runs", "x-rippling-entitlements": [ "Global_Payroll" ], "x-rippling-required-scopes": [ "payroll-runs.read" ] } }, "/payroll-runs/off-cycle/": { "post": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/create-payroll-runs-off-cycle" }, "operationId": "rippling.rest_api.create_payroll_runs_off_cycle", "parameters": [ { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "description": "Opaque native JSON: the provider publishes a response-shaped request model. Input fields are not verified. Internal_Testing entitlement required. Never retry automatically.", "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "errors": { "description": "One error per unconfirmed run creation. Empty on full success; reconcile before retrying.", "items": { "$ref": "#/components/schemas/OutputRestApiOffCycleRunCreationErrorResponse8b03ff00877f" }, "type": "array" }, "runs": { "description": "Confirmed created draft runs. Empty when no creation could be confirmed.", "items": { "$ref": "#/components/schemas/OutputRestApiOffCycleRunCreationRunResponsec6339ffa1191" }, "type": "array" }, "status": { "description": "SUCCESS, PARTIAL_SUCCESS, or FAILED. FAILED means no run creation was confirmed.", "type": "string" } }, "required": [ "errors", "runs", "status" ], "title": "OffCycleRunCreationResponse", "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Create a new off-cycle payroll run", "x-rippling-entitlements": [ "Internal_Testing" ], "x-rippling-required-scopes": [ "payroll-runs/off-cycle.read-write" ] } }, "/payroll-runs/{id}/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/get-payroll-runs" }, "operationId": "rippling.rest_api.get_payroll_runs", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "id", "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "__meta": { "properties": { "redacted_fields": { "items": { "$ref": "#/components/schemas/OutputRestApiRedactedField21788a25ef22" }, "type": "array" } }, "type": "object" }, "approval_deadline": { "description": "Deadline for approving the payroll run.", "type": "string" }, "approved_at": { "description": "Timestamp when the run was approved.", "type": "string" }, "check_date": { "description": "Date the paycheck is issued.", "type": "string" }, "company_entity_id": { "description": "Identifier linking this payroll run to the company's legal entity in the HRIS system.", "type": "string" }, "country_code": { "description": "ISO country code where the payroll run applies.", "type": "string" }, "debit_date": { "description": "Date funds are debited from the company's account.", "type": "string" }, "id": { "description": "Unique identifier for the payroll run.", "type": "string" }, "lock_deadline": { "description": "Deadline after which the run is locked for changes.", "type": "string" }, "paid_at": { "description": "Timestamp when the run was marked as paid.", "type": "string" }, "pay_period": { "description": "Pay period details for this run.", "properties": { "end_date": { "description": "End date of the pay period.", "type": "string" }, "pay_frequency": { "description": "Pay frequency for this period (e.g. BI_WEEKLY, SEMI_MONTHLY, MONTHLY, WEEKLY).", "type": "string" }, "start_date": { "description": "Start date of the pay period.", "type": "string" } }, "title": "PayrollRunPayPeriod", "type": "object" }, "payment_type": { "description": "Payment method used (e.g. WIRE, ACH).", "type": "string" }, "run_state": { "description": "Current state of the run (e.g. DRAFT, PAID, APPROVED).", "type": "string" }, "run_type": { "description": "Type of the run (e.g. REGULAR, OFF_CYCLE, CORRECTION).", "type": "string" }, "title": { "description": "Human-readable title of the payroll run.", "type": "string" } }, "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Retrieve a specific payroll-run", "x-rippling-entitlements": [ "Global_Payroll" ], "x-rippling-required-scopes": [ "payroll-runs.read" ] } }, "/payroll-runs/{run_id}/worker-payroll-records/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/list-worker-payroll-records" }, "operationId": "rippling.rest_api.list_worker_payroll_records", "parameters": [ { "in": "path", "name": "run_id", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "filter", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 100, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "next_link": { "description": "A link to the next page of responses.", "format": "uri", "type": "string" }, "results": { "items": { "$ref": "#/components/schemas/OutputRestApiWorkerPayrollRecord108387f3da0a" }, "type": "array" } }, "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "List worker-payroll-records", "x-rippling-entitlements": [ "Global_Payroll" ], "x-rippling-required-scopes": [ "worker-payroll-records.read" ] } }, "/permissions/permission-profiles/{profile_id}/membership/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/membership-permissions-permission-profiles" }, "operationId": "rippling.rest_api.membership_permissions_permission_profiles", "parameters": [ { "in": "path", "name": "profile_id", "required": true, "schema": { "format": "id", "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OutputRestApiPermissionProfileMembership8c7335914139" } } }, "description": "Check the authenticated caller's live assignment to an active permission profile, not its data-access grants." } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Check the authenticated caller's live assignment to an active permission profile, not its data-access grants.", "x-rippling-entitlements": [ "Internal_Testing" ], "x-rippling-required-scopes": [ "permission-profiles.read" ] } }, "/platform-capabilities/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/list-platform-capabilities" }, "operationId": "rippling.rest_api.list_platform_capabilities", "parameters": [ { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "__meta": { "$ref": "#/components/schemas/OutputRestApiRedactedFields9f7657dc2a2f" }, "next_link": { "description": "A link to the next page of responses.", "format": "uri", "type": "string" }, "results": { "items": { "$ref": "#/components/schemas/OutputRestApiPlatformCapabilityModel82ad48d1caa0" }, "type": "array" } }, "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "List platform capabilities", "x-rippling-entitlements": [ "Platform_Capabilities_API" ], "x-rippling-required-scopes": [ "platform-capabilities.read" ] } }, "/record-detail-reference-options/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/list-custom-object-record-detail-reference-options" }, "operationId": "rippling.rest_api.list_custom_object_record_detail_reference_options", "parameters": [ { "in": "query", "name": "object_api_name", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "record_id", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "field_api_name", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "expand", "required": false, "schema": { "enum": [ "user" ], "type": "string" } }, { "in": "query", "name": "search", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "next_link": { "anyOf": [ { "description": "Link to the next page, or null.", "format": "uri", "type": "string" }, { "type": "null" } ] }, "results": { "items": { "anyOf": [ { "$ref": "#/components/schemas/OutputRestApiWorker78c309103fe1" }, { "$ref": "#/components/schemas/OutputRestApiCustomObjectDataRow46b111ba0ddb" } ] }, "type": "array" } }, "required": [ "next_link", "results" ], "type": "object" } } }, "description": "Successful response" }, "400": { "description": "Invalid Custom Object, record, or field identifier, invalid expand path or cursor, or search is unavailable for the reference target. Correct the named input; restart from the first page if the cursor is invalid.", "x-rippling-source-response": { "description": "Invalid Custom Object, record, or field identifier, invalid expand path or cursor, or search is unavailable for the reference target. Correct the named input; restart from the first page if the cursor is invalid." } }, "403": { "description": "Source record write scope and update authorization, an editable field and unlocked record, and target read authorization are required. Worker targets additionally require workers.read or workers.read-write. Expanding Worker.user additionally requires users.read. Obtain the missing access before retrying.", "x-rippling-source-response": { "description": "Source record write scope and update authorization, an editable field and unlocked record, and target read authorization are required. Worker targets additionally require workers.read or workers.read-write. Expanding Worker.user additionally requires users.read. Obtain the missing access before retrying." } }, "404": { "description": "Record, field, or section is unavailable.", "x-rippling-source-response": { "description": "Record, field, or section is unavailable." } } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "List record detail reference options", "x-rippling-entitlements": [ "Internal_Testing" ], "x-rippling-required-scopes": [ "custom-object-records.read-write", "custom-objects.read-write.owner" ] } }, "/record-detail-related-records/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/list-custom-object-record-detail-related-records" }, "operationId": "rippling.rest_api.list_custom_object_record_detail_related_records", "parameters": [ { "in": "query", "name": "object_api_name", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "record_id", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "section_id", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "layout_api_name", "required": false, "schema": { "default": "default", "type": "string" } }, { "in": "query", "name": "expand", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 25, "maximum": 100, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "next_link": { "anyOf": [ { "description": "Link to the next page, or null.", "format": "uri", "type": "string" }, { "type": "null" } ] }, "results": { "items": { "$ref": "#/components/schemas/OutputRestApiRelatedRecordbb98d854728b" }, "type": "array" } }, "required": [ "next_link", "results" ], "type": "object" } } }, "description": "Successful response" }, "400": { "description": "Invalid Custom Object or record identifier, layout API name, expand path, limit, or cursor. Correct the named input; restart from the first page if the cursor is invalid.", "x-rippling-source-response": { "description": "Invalid Custom Object or record identifier, layout API name, expand path, limit, or cursor. Correct the named input; restart from the first page if the cursor is invalid." } }, "403": { "description": "Record read scope, token object authorization, and resource permissions are required for both the parent and related Custom Objects. Obtain the missing access before retrying.", "x-rippling-source-response": { "description": "Record read scope, token object authorization, and resource permissions are required for both the parent and related Custom Objects. Obtain the missing access before retrying." } }, "404": { "description": "Record, field, or section is unavailable.", "x-rippling-source-response": { "description": "Record, field, or section is unavailable." } } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "List record detail related records", "x-rippling-entitlements": [ "Internal_Testing" ], "x-rippling-required-scopes": [ "custom-object-records.read", "custom-object-records.read-write", "custom-objects.read-write.owner" ] } }, "/record-details/{record_id}/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/get-custom-object-record-detail" }, "operationId": "rippling.rest_api.get_custom_object_record_detail", "parameters": [ { "in": "path", "name": "record_id", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "object_api_name", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "layout_api_name", "required": false, "schema": { "default": "default", "type": "string" } }, { "in": "query", "name": "expand", "required": false, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OutputRestApiRecordDetail6a8b7442b05d" } } }, "description": "Successful response" }, "400": { "description": "Invalid Custom Object or record identifier, layout API name, or expand path. Correct the named input before retrying.", "x-rippling-source-response": { "description": "Invalid Custom Object or record identifier, layout API name, or expand path. Correct the named input before retrying." } }, "403": { "description": "Record read scope, token object authorization, and resource permissions are required. Obtain the missing access before retrying.", "x-rippling-source-response": { "description": "Record read scope, token object authorization, and resource permissions are required. Obtain the missing access before retrying." } }, "404": { "description": "Record, field, or section is unavailable.", "x-rippling-source-response": { "description": "Record, field, or section is unavailable." } } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Retrieve record details", "x-rippling-entitlements": [ "Internal_Testing" ], "x-rippling-required-scopes": [ "custom-object-records.read", "custom-object-records.read-write", "custom-objects.read-write.owner" ] } }, "/reimbursements/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/list-reimbursements" }, "operationId": "rippling.rest_api.list_reimbursements", "parameters": [ { "in": "query", "name": "filter", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 100, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "__meta": { "$ref": "#/components/schemas/OutputRestApiRedactedFields9f7657dc2a2f" }, "next_link": { "description": "A link to the next page of responses.", "format": "uri", "type": "string" }, "results": { "items": { "$ref": "#/components/schemas/OutputRestApiExpenseRequestd79b415064a3" }, "type": "array" } }, "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "List reimbursements", "x-rippling-entitlements": [ "Internal_Testing" ], "x-rippling-required-scopes": [ "reimbursements.read" ] } }, "/reimbursements/{id}/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/get-reimbursements" }, "operationId": "rippling.rest_api.get_reimbursements", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "id", "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "__meta": { "properties": { "redacted_fields": { "items": { "$ref": "#/components/schemas/OutputRestApiRedactedField21788a25ef22" }, "type": "array" } }, "type": "object" }, "accounting_date": { "description": "Date the transaction is booked in the accounting system, as an ISO 8601 date (YYYY-MM-DD).", "type": "string" }, "approval_status": { "description": "Approval status of the transaction. `DRAFT`: not submitted for approval. `PENDING`: awaiting required information or submission before approval. `REQUESTED`: submitted and awaiting approval. `APPROVED`: approved. `REJECTED`: rejected. `FINALIZED`: finalized for payment. `ACTIONED`: payment or reimbursement completed. `CANCELLED`: cancelled. `FAILED`: payment failed. Null for card authorizations.", "type": "string" }, "attachments": { "description": "URLs of other attached files.", "items": { "type": "string" }, "type": "array" }, "company_amount": { "description": "Amount in the company's headquarters currency. The `value` is a decimal string.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "distance": { "anyOf": [ { "description": "Trip length in mileage_rate.units. Null except on mileage reimbursements.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "end_location": { "description": "End of a mileage trip. Null except on mileage reimbursements.", "properties": { "address": { "description": "Address of this point. Null when the point has no address.", "type": "string" }, "coordinates": { "description": "Latitude and longitude of this point, in decimal degrees. Null when the point has no coordinates.", "properties": { "latitude": { "anyOf": [ { "description": "Latitude of this point, in decimal degrees.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "longitude": { "anyOf": [ { "description": "Longitude of this point, in decimal degrees.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "MileageCoordinate", "type": "object" } }, "title": "MileageLocation", "type": "object" }, "entity_id": { "description": "ID of the legal entity the transaction belongs to. Use it with `/company-legal-entities/{id}/`.", "type": "string" }, "gl_sync_state": { "description": "State of the sync to the accounting system. `NOT_FINALIZED`: not ready for accounting review. `FOR_REVIEW`: ready for accounting review. `PENDING_SYNC`: sync is in progress. `SYNCED`: synced to the accounting system. `ERROR`: sync failed. `DO_NOT_SYNC`: marked to be excluded from sync. `EXPORTED`: exported for accounting. `NOT_SYNCABLE`: this record cannot be synced. `AUTO_SYNC`: ready to be synced automatically. Null when no sync state is set.", "type": "string" }, "gl_vendor": { "description": "Vendor in the connected accounting system.", "properties": { "gl_vendor_id": { "description": "ID of the vendor in the accounting system.", "type": "string" }, "id": { "description": "ID of the accounting vendor in Rippling.", "type": "string" }, "name": { "description": "Name of the vendor in the accounting system.", "type": "string" } }, "title": "GLVendor", "type": "object" }, "id": { "description": "Identifier field", "type": "string" }, "line_items": { "description": "Category splits of the transaction amount.", "items": { "$ref": "#/components/schemas/OutputRestApiLineItem8d6adc67985a" }, "type": "array" }, "memo": { "description": "Memo entered on the transaction.", "type": "string" }, "merchant_amount": { "description": "Amount charged by the merchant, in the merchant currency. The `value` is a decimal string.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "mileage_rate": { "description": "Company mileage rate. Null except on mileage reimbursements.", "properties": { "id": { "description": "Company mileage rate ID.", "type": "string" }, "name": { "description": "Company-defined label for this mileage rate, such as the rate used for a country or vehicle type.", "type": "string" }, "rate": { "description": "Amount per distance unit. The `value` is a decimal string.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "units": { "description": "Distance unit, mi or km.", "type": "string" } }, "title": "MileageRate", "type": "object" }, "payout_amount": { "description": "Amount credited to the worker. The `value` is a decimal string.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "payout_date": { "description": "Date the worker is paid, as an ISO 8601 date (YYYY-MM-DD). Null before a run is assigned.", "type": "string" }, "payout_method": { "description": "How the worker is paid. `NOT_SET`: no payout run is assigned. `US_PAYROLL`: assigned to a US payroll run. `GLOBAL_PAYROLL`: assigned to a global payroll run. `DIRECT_DEPOSIT`: assigned to a direct deposit run. `EOR`: assigned to an employer-of-record payroll run. `MANUAL`: marked paid outside a run. If a payout method override is set, it is returned.", "type": "string" }, "per_diem_line_items": { "description": "Per diem sub-rate rows. Null except on per diem reimbursements.", "items": { "$ref": "#/components/schemas/OutputRestApiPerDiemLineItemd5ece60cf2c4" }, "type": "array" }, "per_diem_rate": { "description": "Per diem rate for the trip. Null except on per diem reimbursements.", "properties": { "country": { "description": "Country this per diem rate applies to, as an ISO 3166-1 alpha-2 code. Example: US.", "type": "string" }, "currency": { "description": "Currency of the per diem rate, as an ISO 4217 code. Example: USD.", "type": "string" }, "destination_name": { "description": "Place this per diem rate applies to, such as a city.", "type": "string" }, "id": { "description": "Per diem rate ID.", "type": "string" } }, "title": "PerDiemRate", "type": "object" }, "receipt": { "description": "URL of the receipt file.", "type": "string" }, "start_location": { "description": "Start of a mileage trip. Null except on mileage reimbursements.", "properties": { "address": { "description": "Address of this point. Null when the point has no address.", "type": "string" }, "coordinates": { "description": "Latitude and longitude of this point, in decimal degrees. Null when the point has no coordinates.", "properties": { "latitude": { "anyOf": [ { "description": "Latitude of this point, in decimal degrees.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "longitude": { "anyOf": [ { "description": "Longitude of this point, in decimal degrees.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "MileageCoordinate", "type": "object" } }, "title": "MileageLocation", "type": "object" }, "transaction_date": { "description": "When the purchase or authorization happened, as an ISO 8601 date-time in UTC.", "type": "string" }, "transaction_type": { "description": "`REIMBURSEMENT`: an expense the worker paid and the company pays back. `MILEAGE_REIMBURSEMENT`: payback for distance driven. `PER_DIEM_REIMBURSEMENT`: payback for a daily travel allowance. This decides which mileage or per diem fields are set.", "type": "string" }, "trip_end_date": { "description": "Per diem trip end date, as an ISO 8601 date (YYYY-MM-DD). Null except on per diem reimbursements.", "type": "string" }, "trip_start_date": { "description": "Per diem trip start date, as an ISO 8601 date (YYYY-MM-DD). Null except on per diem reimbursements.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "vendor": { "description": "Vendor the purchase was made from.", "properties": { "id": { "description": "ID of the vendor.", "type": "string" }, "name": { "description": "Name of the vendor.", "type": "string" } }, "title": "Vendor", "type": "object" }, "waypoints": { "description": "List of intermediate stops during the trip, for mileage reimbursements. Null except on mileage reimbursements.", "items": { "$ref": "#/components/schemas/OutputRestApiMileageLocationa042563f5468" }, "type": "array" }, "worker_id": { "description": "ID of the worker who made the transaction. Use it with `/workers/{id}/`.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Retrieve a specific reimbursement", "x-rippling-entitlements": [ "Internal_Testing" ], "x-rippling-required-scopes": [ "reimbursements.read" ] } }, "/report-runs/": { "post": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/trigger-report-runs" }, "operationId": "rippling.rest_api.trigger_report_runs", "parameters": [ { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiReportRunPostRequest8e2cda9e195a" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "id": { "description": "The ID of this run", "type": "string" }, "report_id": { "description": "The ID of the report associated with this run", "type": "string" }, "result": { "description": "Report data, available once the run is complete", "properties": { "expires_at": { "description": "The expiry time of the execution", "type": "string" }, "file_url": { "description": "The presigned file url", "type": "string" }, "output_type": { "description": "The type of the output file", "type": "string" } }, "required": [ "expires_at", "file_url", "output_type" ], "title": "ReportData", "type": "object" }, "status": { "description": "Report run status", "type": "string" } }, "required": [ "id", "report_id", "status" ], "title": "ReportRun", "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Trigger a report run", "x-rippling-entitlements": [ "Reports_API" ], "x-rippling-required-scopes": [ "report-runs.read-write" ] } }, "/report-runs/{run_id}/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/get-report-runs" }, "operationId": "rippling.rest_api.get_report_runs", "parameters": [ { "in": "path", "name": "run_id", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "__meta": { "properties": { "redacted_fields": { "items": { "$ref": "#/components/schemas/OutputRestApiRedactedField21788a25ef22" }, "type": "array" } }, "type": "object" }, "id": { "description": "The ID of this run", "type": "string" }, "report_id": { "description": "The ID of the report associated with this run", "type": "string" }, "result": { "description": "Report data, available once the run is complete", "properties": { "expires_at": { "description": "The expiry time of the execution", "type": "string" }, "file_url": { "description": "The presigned file url", "type": "string" }, "output_type": { "description": "The type of the output file", "type": "string" } }, "required": [ "expires_at", "file_url", "output_type" ], "title": "ReportData", "type": "object" }, "status": { "description": "Report run status", "type": "string" } }, "required": [ "id", "report_id", "status" ], "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Retrieve a report run", "x-rippling-entitlements": [ "Reports_API" ], "x-rippling-required-scopes": [ "report-runs.read" ] } }, "/reports/{id}/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/get-reports" }, "operationId": "rippling.rest_api.get_reports", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "A report definition including its output fields and saved filters", "properties": { "created_at": { "description": "Record creation date", "format": "date-time", "type": "string" }, "id": { "description": "Unique identifier of the report", "type": "string" }, "name": { "description": "Display name of the report", "type": "string" }, "output_fields": { "description": "Attributes (columns) in the report output, with field_id and field_name", "items": { "$ref": "#/components/schemas/OutputRestApiOutputField9899f3bb9150" }, "type": "array" }, "saved_filters": { "description": "Filters currently saved on the report", "items": { "$ref": "#/components/schemas/OutputRestApiSavedFilter1a953728ee2c" }, "type": "array" }, "updated_at": { "description": "Record update date", "format": "date-time", "type": "string" } }, "required": [ "created_at", "id", "name", "output_fields", "saved_filters", "updated_at" ], "title": "Report", "type": "object" } } }, "description": "A specific report" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Retrieve a report", "x-rippling-entitlements": [ "Reports_API" ], "x-rippling-required-scopes": [ "reports.read" ] } }, "/reports/{report_id}/available-filters/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/get-reports-available-filters" }, "operationId": "rippling.rest_api.get_reports_available_filters", "parameters": [ { "in": "path", "name": "report_id", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "Response for GET /reports/{report_id}/available-filters", "properties": { "data": { "description": "List of filterable fields with their supported operators", "items": { "$ref": "#/components/schemas/OutputRestApiFilterableField82dc32b097e4" }, "type": "array" } }, "required": [ "data" ], "title": "AvailableFilters", "type": "object" } } }, "description": "Available filters for the report" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "List available filters for a report", "x-rippling-entitlements": [ "Reports_API" ], "x-rippling-required-scopes": [ "reports.read" ] } }, "/sandboxes/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/list-sandboxes" }, "operationId": "rippling.rest_api.list_sandboxes", "parameters": [ { "in": "query", "name": "filter", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 100, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "__meta": { "$ref": "#/components/schemas/OutputRestApiRedactedFields9f7657dc2a2f" }, "next_link": { "description": "A link to the next page of responses.", "format": "uri", "type": "string" }, "results": { "items": { "$ref": "#/components/schemas/OutputRestApiSandbox7b89bdaf4d00" }, "type": "array" } }, "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "List sandboxes", "x-rippling-entitlements": [ "Developer_Base" ], "x-rippling-required-scopes": [ "sandboxes.read" ] }, "post": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/create-sandboxes" }, "operationId": "rippling.rest_api.create_sandboxes", "parameters": [ { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiSandboxRequestce3f5dcd4394" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "config_override": { "description": "Type-specific sandbox configuration. Optional for developer sandboxes.", "properties": { "custom_objects": { "description": "Custom objects copied into the sandbox.", "properties": { "co_api_names": { "description": "Custom object API names copied into the sandbox.", "items": { "type": "string" }, "type": "array" } }, "title": "CustomObjectsConfig", "type": "object" }, "developer": { "description": "Required for developer sandboxes and omitted for full-data sandboxes.", "properties": { "company_size": { "description": "Seed company size for the developer sandbox. MEDIUM is the supported value for new sandboxes. SMALL is retained for existing sandboxes only and is not supported on create.", "type": "string" } }, "required": [ "company_size" ], "title": "DeveloperConfig", "type": "object" }, "general_notifications": { "description": "General outbound notification controls.", "properties": { "email": { "description": "Email notification configuration.", "properties": { "allowed_users": { "description": "Users allowed to receive outbound messages.", "items": { "type": "string" }, "type": "array" }, "outbound_behavior": { "description": "Whether outbound messages are allowed or suppressed.", "type": "string" } }, "required": [ "outbound_behavior" ], "title": "ChannelConfig", "type": "object" }, "push_notifications": { "description": "Push notification configuration.", "properties": { "allowed_users": { "description": "Users allowed to receive outbound messages.", "items": { "type": "string" }, "type": "array" }, "outbound_behavior": { "description": "Whether outbound messages are allowed or suppressed.", "type": "string" } }, "required": [ "outbound_behavior" ], "title": "ChannelConfig", "type": "object" }, "slack": { "description": "Slack notification configuration.", "properties": { "allowed_public_channels": { "description": "Public channels allowed to receive outbound messages.", "items": { "type": "string" }, "type": "array" }, "allowed_users": { "description": "Users allowed to receive outbound messages.", "items": { "type": "string" }, "type": "array" }, "outbound_behavior": { "description": "Whether outbound messages are allowed or suppressed.", "type": "string" } }, "required": [ "outbound_behavior" ], "title": "PublicChannelConfig", "type": "object" }, "sms": { "description": "SMS notification configuration.", "properties": { "allowed_users": { "description": "Users allowed to receive outbound messages.", "items": { "type": "string" }, "type": "array" }, "outbound_behavior": { "description": "Whether outbound messages are allowed or suppressed.", "type": "string" } }, "required": [ "outbound_behavior" ], "title": "ChannelConfig", "type": "object" }, "teams": { "description": "Microsoft Teams notification configuration.", "properties": { "allowed_public_channels": { "description": "Public channels allowed to receive outbound messages.", "items": { "type": "string" }, "type": "array" }, "allowed_users": { "description": "Users allowed to receive outbound messages.", "items": { "type": "string" }, "type": "array" }, "outbound_behavior": { "description": "Whether outbound messages are allowed or suppressed.", "type": "string" } }, "required": [ "outbound_behavior" ], "title": "PublicChannelConfig", "type": "object" } }, "required": [ "email", "push_notifications", "sms" ], "title": "GeneralNotificationsConfig", "type": "object" }, "integrations": { "description": "Required for connected full-data sandboxes.", "properties": { "is_risk_acknowledged": { "description": "Confirms acceptance of the risks of connected third-party integrations.", "type": "boolean" } }, "required": [ "is_risk_acknowledged" ], "title": "IntegrationsConfig", "type": "object" }, "sandbox_mode": { "description": "Required for full-data sandboxes. Developer sandboxes default to CONNECTED.", "type": "string" }, "workflow_webhooks": { "description": "Workflow webhook controls.", "properties": { "allowed_ips": { "description": "IP addresses allowed to receive workflow webhooks.", "items": { "type": "string" }, "type": "array" }, "allowlisted_webhook_urls": { "description": "Webhook URLs allowed in the sandbox.", "items": { "type": "string" }, "type": "array" }, "outbound_behavior": { "description": "Whether workflow webhook traffic is allowed or suppressed.", "type": "string" } }, "title": "WorkflowWebhookConfig", "type": "object" } }, "title": "SandboxConfig", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "description": { "description": "Optional sandbox description.", "type": "string" }, "handle": { "description": "Server-generated sandbox handle.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "Display name of the sandbox.", "type": "string" }, "status": { "description": "Current lifecycle status.", "type": "string" }, "type": { "description": "Sandbox type: developer or full data.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "type", "updated_at" ], "title": "Sandbox", "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Create a new sandbox", "x-rippling-entitlements": [ "Developer_Base" ], "x-rippling-required-scopes": [ "sandboxes.read-write" ] } }, "/sandboxes/{id}/": { "delete": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/delete-sandboxes" }, "operationId": "rippling.rest_api.delete_sandboxes", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "id", "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "204": { "description": "The resource was deleted successfully" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Delete a sandbox", "x-rippling-entitlements": [ "Developer_Base" ], "x-rippling-required-scopes": [ "sandboxes.read-write" ] }, "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/get-sandboxes" }, "operationId": "rippling.rest_api.get_sandboxes", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "id", "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "__meta": { "properties": { "redacted_fields": { "items": { "$ref": "#/components/schemas/OutputRestApiRedactedField21788a25ef22" }, "type": "array" } }, "type": "object" }, "config_override": { "description": "Type-specific sandbox configuration. Optional for developer sandboxes.", "properties": { "custom_objects": { "description": "Custom objects copied into the sandbox.", "properties": { "co_api_names": { "description": "Custom object API names copied into the sandbox.", "items": { "type": "string" }, "type": "array" } }, "title": "CustomObjectsConfig", "type": "object" }, "developer": { "description": "Required for developer sandboxes and omitted for full-data sandboxes.", "properties": { "company_size": { "description": "Seed company size for the developer sandbox. MEDIUM is the supported value for new sandboxes. SMALL is retained for existing sandboxes only and is not supported on create.", "type": "string" } }, "required": [ "company_size" ], "title": "DeveloperConfig", "type": "object" }, "general_notifications": { "description": "General outbound notification controls.", "properties": { "email": { "description": "Email notification configuration.", "properties": { "allowed_users": { "description": "Users allowed to receive outbound messages.", "items": { "type": "string" }, "type": "array" }, "outbound_behavior": { "description": "Whether outbound messages are allowed or suppressed.", "type": "string" } }, "required": [ "outbound_behavior" ], "title": "ChannelConfig", "type": "object" }, "push_notifications": { "description": "Push notification configuration.", "properties": { "allowed_users": { "description": "Users allowed to receive outbound messages.", "items": { "type": "string" }, "type": "array" }, "outbound_behavior": { "description": "Whether outbound messages are allowed or suppressed.", "type": "string" } }, "required": [ "outbound_behavior" ], "title": "ChannelConfig", "type": "object" }, "slack": { "description": "Slack notification configuration.", "properties": { "allowed_public_channels": { "description": "Public channels allowed to receive outbound messages.", "items": { "type": "string" }, "type": "array" }, "allowed_users": { "description": "Users allowed to receive outbound messages.", "items": { "type": "string" }, "type": "array" }, "outbound_behavior": { "description": "Whether outbound messages are allowed or suppressed.", "type": "string" } }, "required": [ "outbound_behavior" ], "title": "PublicChannelConfig", "type": "object" }, "sms": { "description": "SMS notification configuration.", "properties": { "allowed_users": { "description": "Users allowed to receive outbound messages.", "items": { "type": "string" }, "type": "array" }, "outbound_behavior": { "description": "Whether outbound messages are allowed or suppressed.", "type": "string" } }, "required": [ "outbound_behavior" ], "title": "ChannelConfig", "type": "object" }, "teams": { "description": "Microsoft Teams notification configuration.", "properties": { "allowed_public_channels": { "description": "Public channels allowed to receive outbound messages.", "items": { "type": "string" }, "type": "array" }, "allowed_users": { "description": "Users allowed to receive outbound messages.", "items": { "type": "string" }, "type": "array" }, "outbound_behavior": { "description": "Whether outbound messages are allowed or suppressed.", "type": "string" } }, "required": [ "outbound_behavior" ], "title": "PublicChannelConfig", "type": "object" } }, "required": [ "email", "push_notifications", "sms" ], "title": "GeneralNotificationsConfig", "type": "object" }, "integrations": { "description": "Required for connected full-data sandboxes.", "properties": { "is_risk_acknowledged": { "description": "Confirms acceptance of the risks of connected third-party integrations.", "type": "boolean" } }, "required": [ "is_risk_acknowledged" ], "title": "IntegrationsConfig", "type": "object" }, "sandbox_mode": { "description": "Required for full-data sandboxes. Developer sandboxes default to CONNECTED.", "type": "string" }, "workflow_webhooks": { "description": "Workflow webhook controls.", "properties": { "allowed_ips": { "description": "IP addresses allowed to receive workflow webhooks.", "items": { "type": "string" }, "type": "array" }, "allowlisted_webhook_urls": { "description": "Webhook URLs allowed in the sandbox.", "items": { "type": "string" }, "type": "array" }, "outbound_behavior": { "description": "Whether workflow webhook traffic is allowed or suppressed.", "type": "string" } }, "title": "WorkflowWebhookConfig", "type": "object" } }, "title": "SandboxConfig", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "description": { "description": "Optional sandbox description.", "type": "string" }, "handle": { "description": "Server-generated sandbox handle.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "Display name of the sandbox.", "type": "string" }, "status": { "description": "Current lifecycle status.", "type": "string" }, "type": { "description": "Sandbox type: developer or full data.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "type", "updated_at" ], "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Retrieve a specific sandbox", "x-rippling-entitlements": [ "Developer_Base" ], "x-rippling-required-scopes": [ "sandboxes.read" ] } }, "/sandboxes/{id}/developer-sandbox-entry-roles/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/developer-sandbox-entry-roles-sandboxes" }, "operationId": "rippling.rest_api.developer_sandbox_entry_roles_sandboxes", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "id", "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OutputRestApiDeveloperSandboxEntryRole4ff07d6e5910" } } }, "description": "Get the company and administrator role used to enter a developer sandbox." } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Get the company and administrator role used to enter a developer sandbox.", "x-rippling-entitlements": [ "Developer_Base" ], "x-rippling-required-scopes": [ "sandboxes.read" ] } }, "/scheduled-job-assignments/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/list-scheduled-job-assignments" }, "operationId": "rippling.rest_api.list_scheduled_job_assignments", "parameters": [ { "in": "query", "name": "order_by", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 100, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "__meta": { "$ref": "#/components/schemas/OutputRestApiRedactedFields9f7657dc2a2f" }, "next_link": { "description": "A link to the next page of responses.", "format": "uri", "type": "string" }, "results": { "items": { "$ref": "#/components/schemas/OutputRestApiScheduledJobAssignment3f875c1b8e55" }, "type": "array" } }, "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "List scheduled job assignments", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "scheduled-job-assignments.read" ] } }, "/scheduled-job-assignments/{id}/": { "delete": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/delete-scheduled-job-assignments" }, "operationId": "rippling.rest_api.delete_scheduled_job_assignments", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "id", "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "204": { "description": "The resource was deleted successfully" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Delete a scheduled job assignment", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "scheduled-job-assignments.read-write" ] }, "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/get-scheduled-job-assignments" }, "operationId": "rippling.rest_api.get_scheduled_job_assignments", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "id", "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "__meta": { "properties": { "redacted_fields": { "items": { "$ref": "#/components/schemas/OutputRestApiRedactedField21788a25ef22" }, "type": "array" } }, "type": "object" }, "change_type": { "description": "Type of scheduled change: ASSIGN or UNASSIGN.", "type": "string" }, "changed_by_id": { "description": "The ID of the role that created this scheduled change.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "effective_from": { "description": "When the scheduled change will be applied (ISO 8601).", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "job_code_id": { "description": "The ID of the job code.", "type": "string" }, "job_code_name": { "description": "Display name of the job code.", "type": "string" }, "job_dimension_id": { "description": "The ID of the job dimension.", "type": "string" }, "job_dimension_name": { "description": "Display name of the job dimension.", "type": "string" }, "pay_rate": { "anyOf": [ { "description": "New pay rate value, if the change includes a pay rate.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "reason": { "description": "Reason provided when the scheduled change was created.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "worker_id": { "description": "The ID of the worker (role) the scheduled changes target.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Retrieve a specific scheduled job assignment", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "scheduled-job-assignments.read" ] } }, "/schedules/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/list-schedules" }, "operationId": "rippling.rest_api.list_schedules", "parameters": [ { "in": "query", "name": "expand", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 100, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "__meta": { "$ref": "#/components/schemas/OutputRestApiRedactedFields9f7657dc2a2f" }, "next_link": { "description": "A link to the next page of responses.", "format": "uri", "type": "string" }, "results": { "items": { "$ref": "#/components/schemas/OutputRestApiSchedule22a5141801cb" }, "type": "array" } }, "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "List schedules", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "schedules.read" ] }, "post": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/create-schedules" }, "operationId": "rippling.rest_api.create_schedules", "parameters": [ { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiScheduleRequestae792d0b2001" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "can_edit": { "description": "Whether the requesting role can edit the schedule.", "type": "boolean" }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "managers": { "description": "The managers of the schedule.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiWorker75ef4092b644" }, "type": "array" }, "managers_id": { "description": "The IDs of the managers of the schedule.", "items": { "type": "string" }, "type": "array" }, "members": { "description": "The members of the schedule.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiWorker75ef4092b644" }, "type": "array" }, "members_id": { "description": "The IDs of the members of the schedule.", "items": { "type": "string" }, "type": "array" }, "name": { "description": "The name of the schedule.", "type": "string" }, "observers": { "description": "The observers of the schedule.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiWorker75ef4092b644" }, "type": "array" }, "observers_id": { "description": "The IDs of the observers of the schedule.", "items": { "type": "string" }, "type": "array" }, "settings": { "description": "The settings of the schedule.", "properties": { "timezone": { "description": "The IANA timezone identifier for the schedule (e.g., 'America/New_York'). Accepted values are defined by the tz database, listed here: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones", "type": "string" } }, "title": "ScheduleSettings", "type": "object" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Schedule", "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Create a new schedule", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "schedules.read-write" ] } }, "/schedules/{id}/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/get-schedules" }, "operationId": "rippling.rest_api.get_schedules", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "id", "type": "string" } }, { "in": "query", "name": "expand", "required": false, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "__meta": { "properties": { "redacted_fields": { "items": { "$ref": "#/components/schemas/OutputRestApiRedactedField21788a25ef22" }, "type": "array" } }, "type": "object" }, "can_edit": { "description": "Whether the requesting role can edit the schedule.", "type": "boolean" }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "managers": { "description": "The managers of the schedule.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiWorker75ef4092b644" }, "type": "array" }, "managers_id": { "description": "The IDs of the managers of the schedule.", "items": { "type": "string" }, "type": "array" }, "members": { "description": "The members of the schedule.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiWorker75ef4092b644" }, "type": "array" }, "members_id": { "description": "The IDs of the members of the schedule.", "items": { "type": "string" }, "type": "array" }, "name": { "description": "The name of the schedule.", "type": "string" }, "observers": { "description": "The observers of the schedule.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiWorker75ef4092b644" }, "type": "array" }, "observers_id": { "description": "The IDs of the observers of the schedule.", "items": { "type": "string" }, "type": "array" }, "settings": { "description": "The settings of the schedule.", "properties": { "timezone": { "description": "The IANA timezone identifier for the schedule (e.g., 'America/New_York'). Accepted values are defined by the tz database, listed here: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones", "type": "string" } }, "title": "ScheduleSettings", "type": "object" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Retrieve a specific schedule", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "schedules.read" ] }, "patch": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/update-schedules" }, "operationId": "rippling.rest_api.update_schedules", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "id", "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiScheduleUpdateRequest93873d368ab1" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "can_edit": { "description": "Whether the requesting role can edit the schedule.", "type": "boolean" }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "managers": { "description": "The managers of the schedule.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiWorker75ef4092b644" }, "type": "array" }, "managers_id": { "description": "The IDs of the managers of the schedule.", "items": { "type": "string" }, "type": "array" }, "members": { "description": "The members of the schedule.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiWorker75ef4092b644" }, "type": "array" }, "members_id": { "description": "The IDs of the members of the schedule.", "items": { "type": "string" }, "type": "array" }, "name": { "description": "The name of the schedule.", "type": "string" }, "observers": { "description": "The observers of the schedule.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiWorker75ef4092b644" }, "type": "array" }, "observers_id": { "description": "The IDs of the observers of the schedule.", "items": { "type": "string" }, "type": "array" }, "settings": { "description": "The settings of the schedule.", "properties": { "timezone": { "description": "The IANA timezone identifier for the schedule (e.g., 'America/New_York'). Accepted values are defined by the tz database, listed here: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones", "type": "string" } }, "title": "ScheduleSettings", "type": "object" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Schedule", "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Update a schedule", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "schedules.read-write" ] } }, "/shift-inputs/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/list-shift-inputs" }, "operationId": "rippling.rest_api.list_shift_inputs", "parameters": [ { "in": "query", "name": "filter", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "expand", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 100, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "__meta": { "$ref": "#/components/schemas/OutputRestApiRedactedFields9f7657dc2a2f" }, "next_link": { "description": "A link to the next page of responses.", "format": "uri", "type": "string" }, "results": { "items": { "$ref": "#/components/schemas/OutputRestApiShiftInput68722b7ca765" }, "type": "array" } }, "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "List shift inputs", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "shift-inputs.read" ] }, "post": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/create-shift-inputs" }, "operationId": "rippling.rest_api.create_shift_inputs", "parameters": [ { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiShiftInputRequest5a68b9e7a5a3" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "country_code": { "description": "Two letter string designating country code which the shift input is associated.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "creator": { "description": "The creator associated with the shift input.\n\nExpandable field", "properties": { "business_partners": { "description": "Worker's assigned business partners. This field is only populated when explicitly requested via the expand parameter (e.g., ?expand=business_partners). When expanded, returns an empty list ([]) if the worker has no business partners.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiBusinessPartner77b00a069c32" }, "type": "array" }, "business_partners_id": { "description": "Worker's assigned business partners unique identifiers. Returns an empty list ([]) if the worker has no business partners.", "items": { "type": "string" }, "type": "array" }, "citizenship": { "description": "The countries that the worker has citizenship in.", "type": "string" }, "compensation": { "description": "The compensation package for the worker.\n\nExpandable field", "properties": { "annual_compensation": { "description": "The worker's annual compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "annual_salary_equivalent": { "description": "The worker's annual salary equivalent, for insurance purposes. It will be equal to the worker's annual compensation, except for owners that are receiving no cashcompensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "bonus_schedule": { "description": "The worker's bonus schedule.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "hourly_wage": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "id": { "description": "Identifier field", "type": "string" }, "monthly_compensation": { "description": "The worker's monthly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "on_target_commission": { "description": "The worker's on-target commission.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "payment_terms": { "description": "The payment terms for an worker's compensation.", "type": "string" }, "payment_type": { "description": "The payment type for an worker's compensation.", "type": "string" }, "relocation_reimbursement": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "salary_effective_date": { "description": "Salary effective date", "type": "string" }, "signing_bonus": { "description": "The worker's signing bonus.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus": { "description": "The worker's target annual bonus amount.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus_percent": { "anyOf": [ { "description": "The worker's target annual bonus as a percent of annual compensation.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" }, "weekly_compensation": { "description": "The worker's weekly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "worker": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's details.\n\nExpandable field", "type": "object" }, "worker_id": { "description": "The worker's ID.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Compensation", "type": "object" }, "compensation_grade": { "description": "The compensation grade assigned to the worker, if any.", "properties": { "id": { "description": "The compensation grade's unique identifier.", "type": "string" }, "label": { "description": "The compensation grade's label.", "type": "string" } }, "title": "WorkerCompensationGrade", "type": "object" }, "compensation_id": { "description": "The compensation package for the worker.", "type": "string" }, "country": { "description": "The worker's country.", "type": "string" }, "country_fields": { "description": "Country level fields for the worker.", "properties": { "ca": { "description": "Country-wise regional fields for Canada", "properties": { "sin": { "description": "Social Insurance Number (SIN) for Canada employees.", "type": "string" } }, "title": "CanadaFields", "type": "object" }, "nz": { "description": "Country-wise regional fields for New Zealand", "properties": { "ird_number": { "description": "Inland Revenue Department (IRD) number for New Zealand employees.", "type": "string" } }, "title": "NewZealandFields", "type": "object" }, "us": { "description": "Country-wise regional fields for USA", "properties": { "ssn": { "description": "Social Security Number (SSN) for US employees.", "type": "string" } }, "title": "USFields", "type": "object" } }, "title": "CountryFields", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "custom_fields": { "description": "Custom field values defined on the Employee object for this worker\n\nExpandable field", "items": { "additionalProperties": {} }, "type": "array" }, "date_of_birth": { "description": "The worker's date of birth.", "type": "string" }, "department": { "description": "The worker's assigned department.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "department_hierarchy": { "description": "List of departments in the department hierarchy. Refer department_hierarchy_ids for department hierarchy order.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestDepartment" }, "type": "array" }, "department_hierarchy_id": { "description": "The identifier of departments in the department hierarchy ordered from parent department to child department.", "items": { "type": "string" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the department.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestDepartment", "description": "The parent department.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent department.", "type": "string" }, "reference_code": { "description": "Reference code of the department.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Department", "type": "object" }, "department_id": { "description": "The worker's assigned department.", "type": "string" }, "employment_type": { "description": "The worker's employment type.\n\nExpandable field", "properties": { "amount_worked": { "description": "The amount worked for the employment type. * `FULL-TIME`: Full-time is at least 30 hours per week. Full-time workers will typically be eligible for benefits. * `PART-TIME`: Part-time is less than 30 hours per week. These workers may be eligible for benefits, depending on company settings and hours worked. * `TEMPORARY`: These workers are hired on a temporary basis. You can specify how each worker with this employment type will be paid individually.", "type": "string" }, "compensation_time_period": { "description": "The compensation period for the employment type. * `SALARIED`: Employees that are paid a fixed amount per year. * `HOURLY`: Employees that are paid a wage per hour worked.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "label": { "description": "The display label of the employment type.", "type": "string" }, "name": { "description": "The name of the employment type for non-custom employment types.", "type": "string" }, "type": { "description": "The classification of the worker by the company. * `CONTRACTOR`: Contractors are self-employed workers who provide services on a short-term or per-project basis and are not eligible for tax-withholding or benefits. * `EMPLOYEE`: Employees are hired and managed by an employer, work under the employer's direct supervision and control, and are protected by law for wages and employment rights.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "label", "updated_at" ], "title": "CompanyEmploymentType", "type": "object" }, "employment_type_id": { "description": "The worker's employment type.", "type": "string" }, "end_date": { "description": "The end date of the worker.", "type": "string" }, "ethnicity": { "description": "The identified ethnicity of the worker, if specified.", "type": "string" }, "gender": { "description": "The gender of the worker, if specified.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_manager": { "description": "Whether the worker is a manager", "type": "boolean" }, "job_function": { "description": "The worker's job function. When expanded, this field requires `job-functions.read`.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "Displayed name of the job function", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "JobFunction", "type": "object" }, "job_function_id": { "description": "ID of the worker's job function.", "type": "string" }, "legal_entity": { "description": "The worker's associated legal entity.\n\nExpandable field", "properties": { "company": { "description": "The company or organization associated with the legal entity\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "doing_business_as_name": { "description": "The doing business as name for the company.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_entities": { "description": "A list of the company's entities.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestLegalEntity" }, "type": "array" }, "legal_entities_id": { "description": "A list of the company's entities.", "items": { "type": "string" }, "type": "array" }, "legal_name": { "description": "The legal name of the company.", "type": "string" }, "name": { "description": "The name of the company.", "type": "string" }, "parent_legal_entity": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The company's ultimate holding entity.\n\nExpandable field", "type": "object" }, "parent_legal_entity_id": { "description": "The company's ultimate holding entity.", "type": "string" }, "phone": { "description": "The phone number for the company.", "type": "string" }, "physical_address": { "description": "The physical address of the holding entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "primary_email": { "description": "The email address used when registering this company.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "legal_entities", "legal_entities_id", "name", "updated_at" ], "title": "Company", "type": "object" }, "company_id": { "description": "The company or organization associated with the legal entity", "type": "string" }, "country": { "description": "The country the legal entity is based in.", "properties": { "code": { "description": "The code of the country.", "type": "string" } }, "required": [ "code" ], "title": "Country", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "entity_level": { "description": "The legal entity's level in a hierarchy. * `PARENT`: The legal entity is considered the ultimate holding entity. * `SUBSIDIARY`: The legal entity is considered a subsidiary, fully or partially held by another. * `BRANCH`: The legal entity is considered a branch, associated with a parent legal entity.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_name": { "description": "The legal name of the legal entity.", "type": "string" }, "mailing_address": { "description": "The mailing address of the legal entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "management_type": { "description": "The legal entity management type in the case of an employer of record (EOR) or professional employment organization (PEO). * `PEO`: The legal entity is considered a Professional Employment Organization (PEO). * `EOR`: The legal entity is considered an Employer of Record (EOR).", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The parent legal entity.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent legal entity.", "type": "string" }, "physical_address": { "description": "The physical address of the legal entity, if it differs from the mailing address.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "registration_date": { "description": "The registration date of the entity.", "type": "string" }, "tax_identifier": { "description": "The tax identifier for the legal entity.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "LegalEntity", "type": "object" }, "legal_entity_id": { "description": "The worker's associated legal entity.", "type": "string" }, "level": { "description": "The level of the worker.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "description": { "description": "The description of the level.", "type": "string" }, "experience_requirements": { "description": "The experience requirements for the level.", "type": "string" }, "global_level": { "anyOf": [ { "description": "Global level is used to track the seniority of levels. The higher up a level is placed on the page, the more senior and higher-ranked the level. Global level is used in workflows, policies, and reports that use the level attribute (e.g., you can use Level Lookup to set up a workflow that notifies the nearest person in an worker's management chain at or above the specified level).", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the level. Must be unique within the company or organization.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLevel", "description": "The parent level.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent level.", "type": "string" }, "rank": { "anyOf": [ { "description": "The rank of the level within its track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "scope_of_responsibilities": { "description": "The scope of responsibilities for the level.", "type": "string" }, "track": { "description": "The track associated with the level, if it's not a global level.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_default": { "description": "Whether this is the company's default track.", "type": "boolean" }, "name": { "description": "The name of the track. Must be unique within the company or organization.", "type": "string" }, "order": { "anyOf": [ { "description": "The one-based horizontal display order of the track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "start_global_level": { "anyOf": [ { "description": "The highest global level occupied by this track. Empty tracks return null.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Track", "type": "object" }, "track_id": { "description": "The track associated with the level. Required during creation. Include global_level when changing it.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Level", "type": "object" }, "level_id": { "description": "The level of the worker.", "type": "string" }, "location": { "description": "The location that the worker is mapped to for tax purposes. In the case that a worker is remote, the location's type is remote.", "properties": { "type": { "description": "The type of location.", "type": "string" }, "work_location_id": { "description": "The work location, if the worker isn't remote.", "type": "string" } }, "required": [ "type", "work_location_id" ], "title": "WorkerLocation", "type": "object" }, "manager": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's manager.\n\nExpandable field", "type": "object" }, "manager_id": { "description": "The worker's manager.", "type": "string" }, "number": { "anyOf": [ { "description": "The worker's number within the organization.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "original_start_date": { "description": "The worker's earliest start date across their employment history, excluding INIT roles.", "type": "string" }, "overtime_exemption": { "description": "The worker's overtime exemption status.", "type": "string" }, "pay_schedule_id": { "description": "The ID of the pay schedule currently associated with the worker.", "type": "string" }, "personal_email": { "description": "The worker's associated personal email address.", "type": "string" }, "race": { "description": "The identified race of the worker, if specified.", "type": "string" }, "start_date": { "description": "The start date of the worker.", "type": "string" }, "status": { "description": "The worker's status within the organization.", "type": "string" }, "teams": { "description": "The worker's assigned teams.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiTeamcb26bc28f32f" }, "type": "array" }, "teams_id": { "description": "The worker's assigned teams.", "items": { "type": "string" }, "type": "array" }, "termination_details": { "description": "The details of the worker's termination, if applicable.", "properties": { "reason": { "description": "This is a description that will be custom to each Rippling company.", "type": "string" }, "type": { "description": "The termination type indicates whether the termination was voluntary or involuntary.", "type": "string" } }, "title": "TerminationDetails", "type": "object" }, "title": { "description": "The worker's title.", "type": "string" }, "title_effective_date": { "description": "Title effective date", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "user": { "description": "The worker's associated user.\n\nExpandable field", "properties": { "active": { "description": "Whether the user is able to access company resources, typically when they are in actively engaged with the company and not after off-boarding.", "type": "boolean" }, "addresses": { "description": "The user's addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiUserAddressedd59b9ba9a1" }, "type": "array" }, "created_at": { "description": "Record creation date", "type": "string" }, "display_name": { "description": "The display name of the user using either the concatenated preferred given and family name or username depending on availability.", "type": "string" }, "emails": { "description": "The user's email addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiEmail5284c8258dc3" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "locale": { "description": "The User's default location for purposes of localization of currency, date time format, or numerical representations pursuant to RFC5646.", "type": "string" }, "name": { "description": "The user's name.", "properties": { "family_name": { "description": "The legal family name of the user, or last name in most Western languages.", "type": "string" }, "formatted": { "description": "The user's full name.", "type": "string" }, "given_name": { "description": "The given legal name of the user, or first name in most Western languages.", "type": "string" }, "middle_name": { "description": "The middle name(s) of the user.", "type": "string" }, "preferred_family_name": { "description": "The preferred family name, or last name in most Western languages, by the user.", "type": "string" }, "preferred_given_name": { "description": "The preferred given name, or first name in most Western languages, by the user.", "type": "string" } }, "title": "UserName", "type": "object" }, "number": { "description": "The permanent profile number of the user.", "type": "string" }, "phone_numbers": { "description": "The user's phone numbers.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoneNumber12060c61ecf5" }, "type": "array" }, "photos": { "description": "The user's photos.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoto2be7c3ae3f39" }, "type": "array" }, "preferred_language": { "description": "The User's preferred written or spoken language in the same format of the HTTP Accept-Language header, pursuant to Section 5.3.5 of RFC7231.", "type": "string" }, "timezone": { "description": "The User's current time zone in IANA database Olson format", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "username": { "description": "The unique identifier across Rippling used by the User for direct authentication into their associated company. Globally unique.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "User", "type": "object" }, "user_id": { "description": "The worker's associated user.", "type": "string" }, "work_email": { "description": "The worker's associated work email address.", "type": "string" }, "work_schedule": { "additionalProperties": { "$ref": "#/components/schemas/OutputRestApiWorkScheduleDay938f88d94f20" }, "description": "The worker's scheduled working hours for each day of the week.", "type": "object" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Worker", "type": "object" }, "creator_id": { "description": "The creator id associated with the shift input.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "managed_by": { "description": "The party that manages this shift input", "type": "string" }, "name": { "description": "Name of the shift unit.", "type": "string" }, "prompt": { "description": "Prompt for the shift unit.", "type": "string" }, "type": { "description": "Type of shift unit.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "country_code", "created_at", "id", "name", "prompt", "type", "updated_at" ], "title": "ShiftInput", "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Create a new shift input", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "shift-inputs.read-write" ] } }, "/shift-inputs/{id}/": { "delete": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/delete-shift-inputs" }, "operationId": "rippling.rest_api.delete_shift_inputs", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "id", "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "204": { "description": "The resource was deleted successfully" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Delete a shift input", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "shift-inputs.read-write" ] }, "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/get-shift-inputs" }, "operationId": "rippling.rest_api.get_shift_inputs", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "id", "type": "string" } }, { "in": "query", "name": "expand", "required": false, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "__meta": { "properties": { "redacted_fields": { "items": { "$ref": "#/components/schemas/OutputRestApiRedactedField21788a25ef22" }, "type": "array" } }, "type": "object" }, "country_code": { "description": "Two letter string designating country code which the shift input is associated.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "creator": { "description": "The creator associated with the shift input.\n\nExpandable field", "properties": { "business_partners": { "description": "Worker's assigned business partners. This field is only populated when explicitly requested via the expand parameter (e.g., ?expand=business_partners). When expanded, returns an empty list ([]) if the worker has no business partners.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiBusinessPartner77b00a069c32" }, "type": "array" }, "business_partners_id": { "description": "Worker's assigned business partners unique identifiers. Returns an empty list ([]) if the worker has no business partners.", "items": { "type": "string" }, "type": "array" }, "citizenship": { "description": "The countries that the worker has citizenship in.", "type": "string" }, "compensation": { "description": "The compensation package for the worker.\n\nExpandable field", "properties": { "annual_compensation": { "description": "The worker's annual compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "annual_salary_equivalent": { "description": "The worker's annual salary equivalent, for insurance purposes. It will be equal to the worker's annual compensation, except for owners that are receiving no cashcompensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "bonus_schedule": { "description": "The worker's bonus schedule.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "hourly_wage": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "id": { "description": "Identifier field", "type": "string" }, "monthly_compensation": { "description": "The worker's monthly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "on_target_commission": { "description": "The worker's on-target commission.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "payment_terms": { "description": "The payment terms for an worker's compensation.", "type": "string" }, "payment_type": { "description": "The payment type for an worker's compensation.", "type": "string" }, "relocation_reimbursement": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "salary_effective_date": { "description": "Salary effective date", "type": "string" }, "signing_bonus": { "description": "The worker's signing bonus.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus": { "description": "The worker's target annual bonus amount.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus_percent": { "anyOf": [ { "description": "The worker's target annual bonus as a percent of annual compensation.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" }, "weekly_compensation": { "description": "The worker's weekly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "worker": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's details.\n\nExpandable field", "type": "object" }, "worker_id": { "description": "The worker's ID.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Compensation", "type": "object" }, "compensation_grade": { "description": "The compensation grade assigned to the worker, if any.", "properties": { "id": { "description": "The compensation grade's unique identifier.", "type": "string" }, "label": { "description": "The compensation grade's label.", "type": "string" } }, "title": "WorkerCompensationGrade", "type": "object" }, "compensation_id": { "description": "The compensation package for the worker.", "type": "string" }, "country": { "description": "The worker's country.", "type": "string" }, "country_fields": { "description": "Country level fields for the worker.", "properties": { "ca": { "description": "Country-wise regional fields for Canada", "properties": { "sin": { "description": "Social Insurance Number (SIN) for Canada employees.", "type": "string" } }, "title": "CanadaFields", "type": "object" }, "nz": { "description": "Country-wise regional fields for New Zealand", "properties": { "ird_number": { "description": "Inland Revenue Department (IRD) number for New Zealand employees.", "type": "string" } }, "title": "NewZealandFields", "type": "object" }, "us": { "description": "Country-wise regional fields for USA", "properties": { "ssn": { "description": "Social Security Number (SSN) for US employees.", "type": "string" } }, "title": "USFields", "type": "object" } }, "title": "CountryFields", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "custom_fields": { "description": "Custom field values defined on the Employee object for this worker\n\nExpandable field", "items": { "additionalProperties": {} }, "type": "array" }, "date_of_birth": { "description": "The worker's date of birth.", "type": "string" }, "department": { "description": "The worker's assigned department.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "department_hierarchy": { "description": "List of departments in the department hierarchy. Refer department_hierarchy_ids for department hierarchy order.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestDepartment" }, "type": "array" }, "department_hierarchy_id": { "description": "The identifier of departments in the department hierarchy ordered from parent department to child department.", "items": { "type": "string" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the department.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestDepartment", "description": "The parent department.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent department.", "type": "string" }, "reference_code": { "description": "Reference code of the department.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Department", "type": "object" }, "department_id": { "description": "The worker's assigned department.", "type": "string" }, "employment_type": { "description": "The worker's employment type.\n\nExpandable field", "properties": { "amount_worked": { "description": "The amount worked for the employment type. * `FULL-TIME`: Full-time is at least 30 hours per week. Full-time workers will typically be eligible for benefits. * `PART-TIME`: Part-time is less than 30 hours per week. These workers may be eligible for benefits, depending on company settings and hours worked. * `TEMPORARY`: These workers are hired on a temporary basis. You can specify how each worker with this employment type will be paid individually.", "type": "string" }, "compensation_time_period": { "description": "The compensation period for the employment type. * `SALARIED`: Employees that are paid a fixed amount per year. * `HOURLY`: Employees that are paid a wage per hour worked.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "label": { "description": "The display label of the employment type.", "type": "string" }, "name": { "description": "The name of the employment type for non-custom employment types.", "type": "string" }, "type": { "description": "The classification of the worker by the company. * `CONTRACTOR`: Contractors are self-employed workers who provide services on a short-term or per-project basis and are not eligible for tax-withholding or benefits. * `EMPLOYEE`: Employees are hired and managed by an employer, work under the employer's direct supervision and control, and are protected by law for wages and employment rights.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "label", "updated_at" ], "title": "CompanyEmploymentType", "type": "object" }, "employment_type_id": { "description": "The worker's employment type.", "type": "string" }, "end_date": { "description": "The end date of the worker.", "type": "string" }, "ethnicity": { "description": "The identified ethnicity of the worker, if specified.", "type": "string" }, "gender": { "description": "The gender of the worker, if specified.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_manager": { "description": "Whether the worker is a manager", "type": "boolean" }, "job_function": { "description": "The worker's job function. When expanded, this field requires `job-functions.read`.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "Displayed name of the job function", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "JobFunction", "type": "object" }, "job_function_id": { "description": "ID of the worker's job function.", "type": "string" }, "legal_entity": { "description": "The worker's associated legal entity.\n\nExpandable field", "properties": { "company": { "description": "The company or organization associated with the legal entity\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "doing_business_as_name": { "description": "The doing business as name for the company.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_entities": { "description": "A list of the company's entities.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestLegalEntity" }, "type": "array" }, "legal_entities_id": { "description": "A list of the company's entities.", "items": { "type": "string" }, "type": "array" }, "legal_name": { "description": "The legal name of the company.", "type": "string" }, "name": { "description": "The name of the company.", "type": "string" }, "parent_legal_entity": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The company's ultimate holding entity.\n\nExpandable field", "type": "object" }, "parent_legal_entity_id": { "description": "The company's ultimate holding entity.", "type": "string" }, "phone": { "description": "The phone number for the company.", "type": "string" }, "physical_address": { "description": "The physical address of the holding entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "primary_email": { "description": "The email address used when registering this company.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "legal_entities", "legal_entities_id", "name", "updated_at" ], "title": "Company", "type": "object" }, "company_id": { "description": "The company or organization associated with the legal entity", "type": "string" }, "country": { "description": "The country the legal entity is based in.", "properties": { "code": { "description": "The code of the country.", "type": "string" } }, "required": [ "code" ], "title": "Country", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "entity_level": { "description": "The legal entity's level in a hierarchy. * `PARENT`: The legal entity is considered the ultimate holding entity. * `SUBSIDIARY`: The legal entity is considered a subsidiary, fully or partially held by another. * `BRANCH`: The legal entity is considered a branch, associated with a parent legal entity.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_name": { "description": "The legal name of the legal entity.", "type": "string" }, "mailing_address": { "description": "The mailing address of the legal entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "management_type": { "description": "The legal entity management type in the case of an employer of record (EOR) or professional employment organization (PEO). * `PEO`: The legal entity is considered a Professional Employment Organization (PEO). * `EOR`: The legal entity is considered an Employer of Record (EOR).", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The parent legal entity.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent legal entity.", "type": "string" }, "physical_address": { "description": "The physical address of the legal entity, if it differs from the mailing address.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "registration_date": { "description": "The registration date of the entity.", "type": "string" }, "tax_identifier": { "description": "The tax identifier for the legal entity.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "LegalEntity", "type": "object" }, "legal_entity_id": { "description": "The worker's associated legal entity.", "type": "string" }, "level": { "description": "The level of the worker.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "description": { "description": "The description of the level.", "type": "string" }, "experience_requirements": { "description": "The experience requirements for the level.", "type": "string" }, "global_level": { "anyOf": [ { "description": "Global level is used to track the seniority of levels. The higher up a level is placed on the page, the more senior and higher-ranked the level. Global level is used in workflows, policies, and reports that use the level attribute (e.g., you can use Level Lookup to set up a workflow that notifies the nearest person in an worker's management chain at or above the specified level).", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the level. Must be unique within the company or organization.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLevel", "description": "The parent level.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent level.", "type": "string" }, "rank": { "anyOf": [ { "description": "The rank of the level within its track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "scope_of_responsibilities": { "description": "The scope of responsibilities for the level.", "type": "string" }, "track": { "description": "The track associated with the level, if it's not a global level.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_default": { "description": "Whether this is the company's default track.", "type": "boolean" }, "name": { "description": "The name of the track. Must be unique within the company or organization.", "type": "string" }, "order": { "anyOf": [ { "description": "The one-based horizontal display order of the track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "start_global_level": { "anyOf": [ { "description": "The highest global level occupied by this track. Empty tracks return null.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Track", "type": "object" }, "track_id": { "description": "The track associated with the level. Required during creation. Include global_level when changing it.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Level", "type": "object" }, "level_id": { "description": "The level of the worker.", "type": "string" }, "location": { "description": "The location that the worker is mapped to for tax purposes. In the case that a worker is remote, the location's type is remote.", "properties": { "type": { "description": "The type of location.", "type": "string" }, "work_location_id": { "description": "The work location, if the worker isn't remote.", "type": "string" } }, "required": [ "type", "work_location_id" ], "title": "WorkerLocation", "type": "object" }, "manager": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's manager.\n\nExpandable field", "type": "object" }, "manager_id": { "description": "The worker's manager.", "type": "string" }, "number": { "anyOf": [ { "description": "The worker's number within the organization.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "original_start_date": { "description": "The worker's earliest start date across their employment history, excluding INIT roles.", "type": "string" }, "overtime_exemption": { "description": "The worker's overtime exemption status.", "type": "string" }, "pay_schedule_id": { "description": "The ID of the pay schedule currently associated with the worker.", "type": "string" }, "personal_email": { "description": "The worker's associated personal email address.", "type": "string" }, "race": { "description": "The identified race of the worker, if specified.", "type": "string" }, "start_date": { "description": "The start date of the worker.", "type": "string" }, "status": { "description": "The worker's status within the organization.", "type": "string" }, "teams": { "description": "The worker's assigned teams.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiTeamcb26bc28f32f" }, "type": "array" }, "teams_id": { "description": "The worker's assigned teams.", "items": { "type": "string" }, "type": "array" }, "termination_details": { "description": "The details of the worker's termination, if applicable.", "properties": { "reason": { "description": "This is a description that will be custom to each Rippling company.", "type": "string" }, "type": { "description": "The termination type indicates whether the termination was voluntary or involuntary.", "type": "string" } }, "title": "TerminationDetails", "type": "object" }, "title": { "description": "The worker's title.", "type": "string" }, "title_effective_date": { "description": "Title effective date", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "user": { "description": "The worker's associated user.\n\nExpandable field", "properties": { "active": { "description": "Whether the user is able to access company resources, typically when they are in actively engaged with the company and not after off-boarding.", "type": "boolean" }, "addresses": { "description": "The user's addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiUserAddressedd59b9ba9a1" }, "type": "array" }, "created_at": { "description": "Record creation date", "type": "string" }, "display_name": { "description": "The display name of the user using either the concatenated preferred given and family name or username depending on availability.", "type": "string" }, "emails": { "description": "The user's email addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiEmail5284c8258dc3" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "locale": { "description": "The User's default location for purposes of localization of currency, date time format, or numerical representations pursuant to RFC5646.", "type": "string" }, "name": { "description": "The user's name.", "properties": { "family_name": { "description": "The legal family name of the user, or last name in most Western languages.", "type": "string" }, "formatted": { "description": "The user's full name.", "type": "string" }, "given_name": { "description": "The given legal name of the user, or first name in most Western languages.", "type": "string" }, "middle_name": { "description": "The middle name(s) of the user.", "type": "string" }, "preferred_family_name": { "description": "The preferred family name, or last name in most Western languages, by the user.", "type": "string" }, "preferred_given_name": { "description": "The preferred given name, or first name in most Western languages, by the user.", "type": "string" } }, "title": "UserName", "type": "object" }, "number": { "description": "The permanent profile number of the user.", "type": "string" }, "phone_numbers": { "description": "The user's phone numbers.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoneNumber12060c61ecf5" }, "type": "array" }, "photos": { "description": "The user's photos.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoto2be7c3ae3f39" }, "type": "array" }, "preferred_language": { "description": "The User's preferred written or spoken language in the same format of the HTTP Accept-Language header, pursuant to Section 5.3.5 of RFC7231.", "type": "string" }, "timezone": { "description": "The User's current time zone in IANA database Olson format", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "username": { "description": "The unique identifier across Rippling used by the User for direct authentication into their associated company. Globally unique.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "User", "type": "object" }, "user_id": { "description": "The worker's associated user.", "type": "string" }, "work_email": { "description": "The worker's associated work email address.", "type": "string" }, "work_schedule": { "additionalProperties": { "$ref": "#/components/schemas/OutputRestApiWorkScheduleDay938f88d94f20" }, "description": "The worker's scheduled working hours for each day of the week.", "type": "object" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Worker", "type": "object" }, "creator_id": { "description": "The creator id associated with the shift input.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "managed_by": { "description": "The party that manages this shift input", "type": "string" }, "name": { "description": "Name of the shift unit.", "type": "string" }, "prompt": { "description": "Prompt for the shift unit.", "type": "string" }, "type": { "description": "Type of shift unit.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "country_code", "created_at", "id", "name", "prompt", "type", "updated_at" ], "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Retrieve a specific shift input", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "shift-inputs.read" ] }, "patch": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/update-shift-inputs" }, "operationId": "rippling.rest_api.update_shift_inputs", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "id", "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiShiftInputUpdateRequestb4370b191230" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "country_code": { "description": "Two letter string designating country code which the shift input is associated.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "creator": { "description": "The creator associated with the shift input.\n\nExpandable field", "properties": { "business_partners": { "description": "Worker's assigned business partners. This field is only populated when explicitly requested via the expand parameter (e.g., ?expand=business_partners). When expanded, returns an empty list ([]) if the worker has no business partners.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiBusinessPartner77b00a069c32" }, "type": "array" }, "business_partners_id": { "description": "Worker's assigned business partners unique identifiers. Returns an empty list ([]) if the worker has no business partners.", "items": { "type": "string" }, "type": "array" }, "citizenship": { "description": "The countries that the worker has citizenship in.", "type": "string" }, "compensation": { "description": "The compensation package for the worker.\n\nExpandable field", "properties": { "annual_compensation": { "description": "The worker's annual compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "annual_salary_equivalent": { "description": "The worker's annual salary equivalent, for insurance purposes. It will be equal to the worker's annual compensation, except for owners that are receiving no cashcompensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "bonus_schedule": { "description": "The worker's bonus schedule.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "hourly_wage": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "id": { "description": "Identifier field", "type": "string" }, "monthly_compensation": { "description": "The worker's monthly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "on_target_commission": { "description": "The worker's on-target commission.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "payment_terms": { "description": "The payment terms for an worker's compensation.", "type": "string" }, "payment_type": { "description": "The payment type for an worker's compensation.", "type": "string" }, "relocation_reimbursement": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "salary_effective_date": { "description": "Salary effective date", "type": "string" }, "signing_bonus": { "description": "The worker's signing bonus.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus": { "description": "The worker's target annual bonus amount.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus_percent": { "anyOf": [ { "description": "The worker's target annual bonus as a percent of annual compensation.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" }, "weekly_compensation": { "description": "The worker's weekly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "worker": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's details.\n\nExpandable field", "type": "object" }, "worker_id": { "description": "The worker's ID.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Compensation", "type": "object" }, "compensation_grade": { "description": "The compensation grade assigned to the worker, if any.", "properties": { "id": { "description": "The compensation grade's unique identifier.", "type": "string" }, "label": { "description": "The compensation grade's label.", "type": "string" } }, "title": "WorkerCompensationGrade", "type": "object" }, "compensation_id": { "description": "The compensation package for the worker.", "type": "string" }, "country": { "description": "The worker's country.", "type": "string" }, "country_fields": { "description": "Country level fields for the worker.", "properties": { "ca": { "description": "Country-wise regional fields for Canada", "properties": { "sin": { "description": "Social Insurance Number (SIN) for Canada employees.", "type": "string" } }, "title": "CanadaFields", "type": "object" }, "nz": { "description": "Country-wise regional fields for New Zealand", "properties": { "ird_number": { "description": "Inland Revenue Department (IRD) number for New Zealand employees.", "type": "string" } }, "title": "NewZealandFields", "type": "object" }, "us": { "description": "Country-wise regional fields for USA", "properties": { "ssn": { "description": "Social Security Number (SSN) for US employees.", "type": "string" } }, "title": "USFields", "type": "object" } }, "title": "CountryFields", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "custom_fields": { "description": "Custom field values defined on the Employee object for this worker\n\nExpandable field", "items": { "additionalProperties": {} }, "type": "array" }, "date_of_birth": { "description": "The worker's date of birth.", "type": "string" }, "department": { "description": "The worker's assigned department.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "department_hierarchy": { "description": "List of departments in the department hierarchy. Refer department_hierarchy_ids for department hierarchy order.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestDepartment" }, "type": "array" }, "department_hierarchy_id": { "description": "The identifier of departments in the department hierarchy ordered from parent department to child department.", "items": { "type": "string" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the department.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestDepartment", "description": "The parent department.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent department.", "type": "string" }, "reference_code": { "description": "Reference code of the department.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Department", "type": "object" }, "department_id": { "description": "The worker's assigned department.", "type": "string" }, "employment_type": { "description": "The worker's employment type.\n\nExpandable field", "properties": { "amount_worked": { "description": "The amount worked for the employment type. * `FULL-TIME`: Full-time is at least 30 hours per week. Full-time workers will typically be eligible for benefits. * `PART-TIME`: Part-time is less than 30 hours per week. These workers may be eligible for benefits, depending on company settings and hours worked. * `TEMPORARY`: These workers are hired on a temporary basis. You can specify how each worker with this employment type will be paid individually.", "type": "string" }, "compensation_time_period": { "description": "The compensation period for the employment type. * `SALARIED`: Employees that are paid a fixed amount per year. * `HOURLY`: Employees that are paid a wage per hour worked.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "label": { "description": "The display label of the employment type.", "type": "string" }, "name": { "description": "The name of the employment type for non-custom employment types.", "type": "string" }, "type": { "description": "The classification of the worker by the company. * `CONTRACTOR`: Contractors are self-employed workers who provide services on a short-term or per-project basis and are not eligible for tax-withholding or benefits. * `EMPLOYEE`: Employees are hired and managed by an employer, work under the employer's direct supervision and control, and are protected by law for wages and employment rights.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "label", "updated_at" ], "title": "CompanyEmploymentType", "type": "object" }, "employment_type_id": { "description": "The worker's employment type.", "type": "string" }, "end_date": { "description": "The end date of the worker.", "type": "string" }, "ethnicity": { "description": "The identified ethnicity of the worker, if specified.", "type": "string" }, "gender": { "description": "The gender of the worker, if specified.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_manager": { "description": "Whether the worker is a manager", "type": "boolean" }, "job_function": { "description": "The worker's job function. When expanded, this field requires `job-functions.read`.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "Displayed name of the job function", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "JobFunction", "type": "object" }, "job_function_id": { "description": "ID of the worker's job function.", "type": "string" }, "legal_entity": { "description": "The worker's associated legal entity.\n\nExpandable field", "properties": { "company": { "description": "The company or organization associated with the legal entity\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "doing_business_as_name": { "description": "The doing business as name for the company.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_entities": { "description": "A list of the company's entities.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestLegalEntity" }, "type": "array" }, "legal_entities_id": { "description": "A list of the company's entities.", "items": { "type": "string" }, "type": "array" }, "legal_name": { "description": "The legal name of the company.", "type": "string" }, "name": { "description": "The name of the company.", "type": "string" }, "parent_legal_entity": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The company's ultimate holding entity.\n\nExpandable field", "type": "object" }, "parent_legal_entity_id": { "description": "The company's ultimate holding entity.", "type": "string" }, "phone": { "description": "The phone number for the company.", "type": "string" }, "physical_address": { "description": "The physical address of the holding entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "primary_email": { "description": "The email address used when registering this company.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "legal_entities", "legal_entities_id", "name", "updated_at" ], "title": "Company", "type": "object" }, "company_id": { "description": "The company or organization associated with the legal entity", "type": "string" }, "country": { "description": "The country the legal entity is based in.", "properties": { "code": { "description": "The code of the country.", "type": "string" } }, "required": [ "code" ], "title": "Country", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "entity_level": { "description": "The legal entity's level in a hierarchy. * `PARENT`: The legal entity is considered the ultimate holding entity. * `SUBSIDIARY`: The legal entity is considered a subsidiary, fully or partially held by another. * `BRANCH`: The legal entity is considered a branch, associated with a parent legal entity.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_name": { "description": "The legal name of the legal entity.", "type": "string" }, "mailing_address": { "description": "The mailing address of the legal entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "management_type": { "description": "The legal entity management type in the case of an employer of record (EOR) or professional employment organization (PEO). * `PEO`: The legal entity is considered a Professional Employment Organization (PEO). * `EOR`: The legal entity is considered an Employer of Record (EOR).", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The parent legal entity.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent legal entity.", "type": "string" }, "physical_address": { "description": "The physical address of the legal entity, if it differs from the mailing address.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "registration_date": { "description": "The registration date of the entity.", "type": "string" }, "tax_identifier": { "description": "The tax identifier for the legal entity.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "LegalEntity", "type": "object" }, "legal_entity_id": { "description": "The worker's associated legal entity.", "type": "string" }, "level": { "description": "The level of the worker.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "description": { "description": "The description of the level.", "type": "string" }, "experience_requirements": { "description": "The experience requirements for the level.", "type": "string" }, "global_level": { "anyOf": [ { "description": "Global level is used to track the seniority of levels. The higher up a level is placed on the page, the more senior and higher-ranked the level. Global level is used in workflows, policies, and reports that use the level attribute (e.g., you can use Level Lookup to set up a workflow that notifies the nearest person in an worker's management chain at or above the specified level).", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the level. Must be unique within the company or organization.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLevel", "description": "The parent level.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent level.", "type": "string" }, "rank": { "anyOf": [ { "description": "The rank of the level within its track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "scope_of_responsibilities": { "description": "The scope of responsibilities for the level.", "type": "string" }, "track": { "description": "The track associated with the level, if it's not a global level.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_default": { "description": "Whether this is the company's default track.", "type": "boolean" }, "name": { "description": "The name of the track. Must be unique within the company or organization.", "type": "string" }, "order": { "anyOf": [ { "description": "The one-based horizontal display order of the track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "start_global_level": { "anyOf": [ { "description": "The highest global level occupied by this track. Empty tracks return null.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Track", "type": "object" }, "track_id": { "description": "The track associated with the level. Required during creation. Include global_level when changing it.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Level", "type": "object" }, "level_id": { "description": "The level of the worker.", "type": "string" }, "location": { "description": "The location that the worker is mapped to for tax purposes. In the case that a worker is remote, the location's type is remote.", "properties": { "type": { "description": "The type of location.", "type": "string" }, "work_location_id": { "description": "The work location, if the worker isn't remote.", "type": "string" } }, "required": [ "type", "work_location_id" ], "title": "WorkerLocation", "type": "object" }, "manager": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's manager.\n\nExpandable field", "type": "object" }, "manager_id": { "description": "The worker's manager.", "type": "string" }, "number": { "anyOf": [ { "description": "The worker's number within the organization.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "original_start_date": { "description": "The worker's earliest start date across their employment history, excluding INIT roles.", "type": "string" }, "overtime_exemption": { "description": "The worker's overtime exemption status.", "type": "string" }, "pay_schedule_id": { "description": "The ID of the pay schedule currently associated with the worker.", "type": "string" }, "personal_email": { "description": "The worker's associated personal email address.", "type": "string" }, "race": { "description": "The identified race of the worker, if specified.", "type": "string" }, "start_date": { "description": "The start date of the worker.", "type": "string" }, "status": { "description": "The worker's status within the organization.", "type": "string" }, "teams": { "description": "The worker's assigned teams.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiTeamcb26bc28f32f" }, "type": "array" }, "teams_id": { "description": "The worker's assigned teams.", "items": { "type": "string" }, "type": "array" }, "termination_details": { "description": "The details of the worker's termination, if applicable.", "properties": { "reason": { "description": "This is a description that will be custom to each Rippling company.", "type": "string" }, "type": { "description": "The termination type indicates whether the termination was voluntary or involuntary.", "type": "string" } }, "title": "TerminationDetails", "type": "object" }, "title": { "description": "The worker's title.", "type": "string" }, "title_effective_date": { "description": "Title effective date", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "user": { "description": "The worker's associated user.\n\nExpandable field", "properties": { "active": { "description": "Whether the user is able to access company resources, typically when they are in actively engaged with the company and not after off-boarding.", "type": "boolean" }, "addresses": { "description": "The user's addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiUserAddressedd59b9ba9a1" }, "type": "array" }, "created_at": { "description": "Record creation date", "type": "string" }, "display_name": { "description": "The display name of the user using either the concatenated preferred given and family name or username depending on availability.", "type": "string" }, "emails": { "description": "The user's email addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiEmail5284c8258dc3" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "locale": { "description": "The User's default location for purposes of localization of currency, date time format, or numerical representations pursuant to RFC5646.", "type": "string" }, "name": { "description": "The user's name.", "properties": { "family_name": { "description": "The legal family name of the user, or last name in most Western languages.", "type": "string" }, "formatted": { "description": "The user's full name.", "type": "string" }, "given_name": { "description": "The given legal name of the user, or first name in most Western languages.", "type": "string" }, "middle_name": { "description": "The middle name(s) of the user.", "type": "string" }, "preferred_family_name": { "description": "The preferred family name, or last name in most Western languages, by the user.", "type": "string" }, "preferred_given_name": { "description": "The preferred given name, or first name in most Western languages, by the user.", "type": "string" } }, "title": "UserName", "type": "object" }, "number": { "description": "The permanent profile number of the user.", "type": "string" }, "phone_numbers": { "description": "The user's phone numbers.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoneNumber12060c61ecf5" }, "type": "array" }, "photos": { "description": "The user's photos.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoto2be7c3ae3f39" }, "type": "array" }, "preferred_language": { "description": "The User's preferred written or spoken language in the same format of the HTTP Accept-Language header, pursuant to Section 5.3.5 of RFC7231.", "type": "string" }, "timezone": { "description": "The User's current time zone in IANA database Olson format", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "username": { "description": "The unique identifier across Rippling used by the User for direct authentication into their associated company. Globally unique.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "User", "type": "object" }, "user_id": { "description": "The worker's associated user.", "type": "string" }, "work_email": { "description": "The worker's associated work email address.", "type": "string" }, "work_schedule": { "additionalProperties": { "$ref": "#/components/schemas/OutputRestApiWorkScheduleDay938f88d94f20" }, "description": "The worker's scheduled working hours for each day of the week.", "type": "object" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Worker", "type": "object" }, "creator_id": { "description": "The creator id associated with the shift input.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "managed_by": { "description": "The party that manages this shift input", "type": "string" }, "name": { "description": "Name of the shift unit.", "type": "string" }, "prompt": { "description": "Prompt for the shift unit.", "type": "string" }, "type": { "description": "Type of shift unit.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "country_code", "created_at", "id", "name", "prompt", "type", "updated_at" ], "title": "ShiftInput", "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Update a shift input", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "shift-inputs.read-write" ] } }, "/shiftassignments/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/list-shiftassignments" }, "operationId": "rippling.rest_api.list_shiftassignments", "parameters": [ { "in": "query", "name": "filter", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "expand", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 100, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "__meta": { "$ref": "#/components/schemas/OutputRestApiRedactedFields9f7657dc2a2f" }, "next_link": { "description": "A link to the next page of responses.", "format": "uri", "type": "string" }, "results": { "items": { "$ref": "#/components/schemas/OutputRestApiShiftAssignmentd0bfafbeb81e" }, "type": "array" } }, "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "List shift assignments", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "shiftassignments.read" ] }, "post": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/create-shiftassignments" }, "operationId": "rippling.rest_api.create_shiftassignments", "parameters": [ { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiShiftAssignmentRequestb8d06a3a8c35" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "can_edit": { "description": "Whether the shift assignment can be edited", "type": "boolean" }, "created_at": { "description": "Record creation date", "type": "string" }, "custom_fields": { "description": "Custom fields for the shift assignment", "items": { "additionalProperties": {} }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "is_published": { "description": "Whether the shift assignment is published. If true, the published_version will be the same as the shift_data", "type": "boolean" }, "published_version": { "description": "The published version of the shift assignment, if it exists. If filled but is_published is false, the shift_data is the latest version.", "properties": { "end_time": { "description": "The end time of the shift", "type": "string" }, "notes": { "description": "Notes for the shift, max length 256 characters", "maxLength": 256, "type": "string" }, "shift_breaks": { "description": "The breaks of the shift", "items": { "$ref": "#/components/schemas/OutputRestApiShiftBreak314820414f10" }, "type": "array" }, "shift_segments": { "description": "The segments of the shift", "items": { "$ref": "#/components/schemas/OutputRestApiShiftSegment2a530a829033" }, "type": "array" }, "start_time": { "description": "The start time of the shift", "type": "string" } }, "required": [ "end_time", "start_time" ], "title": "ShiftData", "type": "object" }, "schedule": { "description": "The schedule\n\nExpandable field", "properties": { "can_edit": { "description": "Whether the requesting role can edit the schedule.", "type": "boolean" }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "managers": { "description": "The managers of the schedule.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiWorker75ef4092b644" }, "type": "array" }, "managers_id": { "description": "The IDs of the managers of the schedule.", "items": { "type": "string" }, "type": "array" }, "members": { "description": "The members of the schedule.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiWorker75ef4092b644" }, "type": "array" }, "members_id": { "description": "The IDs of the members of the schedule.", "items": { "type": "string" }, "type": "array" }, "name": { "description": "The name of the schedule.", "type": "string" }, "observers": { "description": "The observers of the schedule.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiWorker75ef4092b644" }, "type": "array" }, "observers_id": { "description": "The IDs of the observers of the schedule.", "items": { "type": "string" }, "type": "array" }, "settings": { "description": "The settings of the schedule.", "properties": { "timezone": { "description": "The IANA timezone identifier for the schedule (e.g., 'America/New_York'). Accepted values are defined by the tz database, listed here: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones", "type": "string" } }, "title": "ScheduleSettings", "type": "object" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Schedule", "type": "object" }, "schedule_id": { "description": "The ID of the schedule", "type": "string" }, "shift_data": { "description": "The data of the shift", "properties": { "end_time": { "description": "The end time of the shift", "type": "string" }, "notes": { "description": "Notes for the shift, max length 256 characters", "maxLength": 256, "type": "string" }, "shift_breaks": { "description": "The breaks of the shift", "items": { "$ref": "#/components/schemas/OutputRestApiShiftBreak314820414f10" }, "type": "array" }, "shift_segments": { "description": "The segments of the shift", "items": { "$ref": "#/components/schemas/OutputRestApiShiftSegment2a530a829033" }, "type": "array" }, "start_time": { "description": "The start time of the shift", "type": "string" } }, "required": [ "end_time", "start_time" ], "title": "ShiftData", "type": "object" }, "updated_at": { "description": "Record update date", "type": "string" }, "worker": { "description": "The worker\n\nExpandable field", "properties": { "business_partners": { "description": "Worker's assigned business partners. This field is only populated when explicitly requested via the expand parameter (e.g., ?expand=business_partners). When expanded, returns an empty list ([]) if the worker has no business partners.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiBusinessPartner77b00a069c32" }, "type": "array" }, "business_partners_id": { "description": "Worker's assigned business partners unique identifiers. Returns an empty list ([]) if the worker has no business partners.", "items": { "type": "string" }, "type": "array" }, "citizenship": { "description": "The countries that the worker has citizenship in.", "type": "string" }, "compensation": { "description": "The compensation package for the worker.\n\nExpandable field", "properties": { "annual_compensation": { "description": "The worker's annual compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "annual_salary_equivalent": { "description": "The worker's annual salary equivalent, for insurance purposes. It will be equal to the worker's annual compensation, except for owners that are receiving no cashcompensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "bonus_schedule": { "description": "The worker's bonus schedule.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "hourly_wage": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "id": { "description": "Identifier field", "type": "string" }, "monthly_compensation": { "description": "The worker's monthly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "on_target_commission": { "description": "The worker's on-target commission.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "payment_terms": { "description": "The payment terms for an worker's compensation.", "type": "string" }, "payment_type": { "description": "The payment type for an worker's compensation.", "type": "string" }, "relocation_reimbursement": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "salary_effective_date": { "description": "Salary effective date", "type": "string" }, "signing_bonus": { "description": "The worker's signing bonus.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus": { "description": "The worker's target annual bonus amount.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus_percent": { "anyOf": [ { "description": "The worker's target annual bonus as a percent of annual compensation.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" }, "weekly_compensation": { "description": "The worker's weekly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "worker": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's details.\n\nExpandable field", "type": "object" }, "worker_id": { "description": "The worker's ID.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Compensation", "type": "object" }, "compensation_grade": { "description": "The compensation grade assigned to the worker, if any.", "properties": { "id": { "description": "The compensation grade's unique identifier.", "type": "string" }, "label": { "description": "The compensation grade's label.", "type": "string" } }, "title": "WorkerCompensationGrade", "type": "object" }, "compensation_id": { "description": "The compensation package for the worker.", "type": "string" }, "country": { "description": "The worker's country.", "type": "string" }, "country_fields": { "description": "Country level fields for the worker.", "properties": { "ca": { "description": "Country-wise regional fields for Canada", "properties": { "sin": { "description": "Social Insurance Number (SIN) for Canada employees.", "type": "string" } }, "title": "CanadaFields", "type": "object" }, "nz": { "description": "Country-wise regional fields for New Zealand", "properties": { "ird_number": { "description": "Inland Revenue Department (IRD) number for New Zealand employees.", "type": "string" } }, "title": "NewZealandFields", "type": "object" }, "us": { "description": "Country-wise regional fields for USA", "properties": { "ssn": { "description": "Social Security Number (SSN) for US employees.", "type": "string" } }, "title": "USFields", "type": "object" } }, "title": "CountryFields", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "custom_fields": { "description": "Custom field values defined on the Employee object for this worker\n\nExpandable field", "items": { "additionalProperties": {} }, "type": "array" }, "date_of_birth": { "description": "The worker's date of birth.", "type": "string" }, "department": { "description": "The worker's assigned department.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "department_hierarchy": { "description": "List of departments in the department hierarchy. Refer department_hierarchy_ids for department hierarchy order.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestDepartment" }, "type": "array" }, "department_hierarchy_id": { "description": "The identifier of departments in the department hierarchy ordered from parent department to child department.", "items": { "type": "string" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the department.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestDepartment", "description": "The parent department.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent department.", "type": "string" }, "reference_code": { "description": "Reference code of the department.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Department", "type": "object" }, "department_id": { "description": "The worker's assigned department.", "type": "string" }, "employment_type": { "description": "The worker's employment type.\n\nExpandable field", "properties": { "amount_worked": { "description": "The amount worked for the employment type. * `FULL-TIME`: Full-time is at least 30 hours per week. Full-time workers will typically be eligible for benefits. * `PART-TIME`: Part-time is less than 30 hours per week. These workers may be eligible for benefits, depending on company settings and hours worked. * `TEMPORARY`: These workers are hired on a temporary basis. You can specify how each worker with this employment type will be paid individually.", "type": "string" }, "compensation_time_period": { "description": "The compensation period for the employment type. * `SALARIED`: Employees that are paid a fixed amount per year. * `HOURLY`: Employees that are paid a wage per hour worked.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "label": { "description": "The display label of the employment type.", "type": "string" }, "name": { "description": "The name of the employment type for non-custom employment types.", "type": "string" }, "type": { "description": "The classification of the worker by the company. * `CONTRACTOR`: Contractors are self-employed workers who provide services on a short-term or per-project basis and are not eligible for tax-withholding or benefits. * `EMPLOYEE`: Employees are hired and managed by an employer, work under the employer's direct supervision and control, and are protected by law for wages and employment rights.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "label", "updated_at" ], "title": "CompanyEmploymentType", "type": "object" }, "employment_type_id": { "description": "The worker's employment type.", "type": "string" }, "end_date": { "description": "The end date of the worker.", "type": "string" }, "ethnicity": { "description": "The identified ethnicity of the worker, if specified.", "type": "string" }, "gender": { "description": "The gender of the worker, if specified.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_manager": { "description": "Whether the worker is a manager", "type": "boolean" }, "job_function": { "description": "The worker's job function. When expanded, this field requires `job-functions.read`.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "Displayed name of the job function", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "JobFunction", "type": "object" }, "job_function_id": { "description": "ID of the worker's job function.", "type": "string" }, "legal_entity": { "description": "The worker's associated legal entity.\n\nExpandable field", "properties": { "company": { "description": "The company or organization associated with the legal entity\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "doing_business_as_name": { "description": "The doing business as name for the company.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_entities": { "description": "A list of the company's entities.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestLegalEntity" }, "type": "array" }, "legal_entities_id": { "description": "A list of the company's entities.", "items": { "type": "string" }, "type": "array" }, "legal_name": { "description": "The legal name of the company.", "type": "string" }, "name": { "description": "The name of the company.", "type": "string" }, "parent_legal_entity": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The company's ultimate holding entity.\n\nExpandable field", "type": "object" }, "parent_legal_entity_id": { "description": "The company's ultimate holding entity.", "type": "string" }, "phone": { "description": "The phone number for the company.", "type": "string" }, "physical_address": { "description": "The physical address of the holding entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "primary_email": { "description": "The email address used when registering this company.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "legal_entities", "legal_entities_id", "name", "updated_at" ], "title": "Company", "type": "object" }, "company_id": { "description": "The company or organization associated with the legal entity", "type": "string" }, "country": { "description": "The country the legal entity is based in.", "properties": { "code": { "description": "The code of the country.", "type": "string" } }, "required": [ "code" ], "title": "Country", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "entity_level": { "description": "The legal entity's level in a hierarchy. * `PARENT`: The legal entity is considered the ultimate holding entity. * `SUBSIDIARY`: The legal entity is considered a subsidiary, fully or partially held by another. * `BRANCH`: The legal entity is considered a branch, associated with a parent legal entity.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_name": { "description": "The legal name of the legal entity.", "type": "string" }, "mailing_address": { "description": "The mailing address of the legal entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "management_type": { "description": "The legal entity management type in the case of an employer of record (EOR) or professional employment organization (PEO). * `PEO`: The legal entity is considered a Professional Employment Organization (PEO). * `EOR`: The legal entity is considered an Employer of Record (EOR).", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The parent legal entity.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent legal entity.", "type": "string" }, "physical_address": { "description": "The physical address of the legal entity, if it differs from the mailing address.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "registration_date": { "description": "The registration date of the entity.", "type": "string" }, "tax_identifier": { "description": "The tax identifier for the legal entity.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "LegalEntity", "type": "object" }, "legal_entity_id": { "description": "The worker's associated legal entity.", "type": "string" }, "level": { "description": "The level of the worker.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "description": { "description": "The description of the level.", "type": "string" }, "experience_requirements": { "description": "The experience requirements for the level.", "type": "string" }, "global_level": { "anyOf": [ { "description": "Global level is used to track the seniority of levels. The higher up a level is placed on the page, the more senior and higher-ranked the level. Global level is used in workflows, policies, and reports that use the level attribute (e.g., you can use Level Lookup to set up a workflow that notifies the nearest person in an worker's management chain at or above the specified level).", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the level. Must be unique within the company or organization.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLevel", "description": "The parent level.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent level.", "type": "string" }, "rank": { "anyOf": [ { "description": "The rank of the level within its track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "scope_of_responsibilities": { "description": "The scope of responsibilities for the level.", "type": "string" }, "track": { "description": "The track associated with the level, if it's not a global level.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_default": { "description": "Whether this is the company's default track.", "type": "boolean" }, "name": { "description": "The name of the track. Must be unique within the company or organization.", "type": "string" }, "order": { "anyOf": [ { "description": "The one-based horizontal display order of the track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "start_global_level": { "anyOf": [ { "description": "The highest global level occupied by this track. Empty tracks return null.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Track", "type": "object" }, "track_id": { "description": "The track associated with the level. Required during creation. Include global_level when changing it.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Level", "type": "object" }, "level_id": { "description": "The level of the worker.", "type": "string" }, "location": { "description": "The location that the worker is mapped to for tax purposes. In the case that a worker is remote, the location's type is remote.", "properties": { "type": { "description": "The type of location.", "type": "string" }, "work_location_id": { "description": "The work location, if the worker isn't remote.", "type": "string" } }, "required": [ "type", "work_location_id" ], "title": "WorkerLocation", "type": "object" }, "manager": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's manager.\n\nExpandable field", "type": "object" }, "manager_id": { "description": "The worker's manager.", "type": "string" }, "number": { "anyOf": [ { "description": "The worker's number within the organization.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "original_start_date": { "description": "The worker's earliest start date across their employment history, excluding INIT roles.", "type": "string" }, "overtime_exemption": { "description": "The worker's overtime exemption status.", "type": "string" }, "pay_schedule_id": { "description": "The ID of the pay schedule currently associated with the worker.", "type": "string" }, "personal_email": { "description": "The worker's associated personal email address.", "type": "string" }, "race": { "description": "The identified race of the worker, if specified.", "type": "string" }, "start_date": { "description": "The start date of the worker.", "type": "string" }, "status": { "description": "The worker's status within the organization.", "type": "string" }, "teams": { "description": "The worker's assigned teams.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiTeamcb26bc28f32f" }, "type": "array" }, "teams_id": { "description": "The worker's assigned teams.", "items": { "type": "string" }, "type": "array" }, "termination_details": { "description": "The details of the worker's termination, if applicable.", "properties": { "reason": { "description": "This is a description that will be custom to each Rippling company.", "type": "string" }, "type": { "description": "The termination type indicates whether the termination was voluntary or involuntary.", "type": "string" } }, "title": "TerminationDetails", "type": "object" }, "title": { "description": "The worker's title.", "type": "string" }, "title_effective_date": { "description": "Title effective date", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "user": { "description": "The worker's associated user.\n\nExpandable field", "properties": { "active": { "description": "Whether the user is able to access company resources, typically when they are in actively engaged with the company and not after off-boarding.", "type": "boolean" }, "addresses": { "description": "The user's addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiUserAddressedd59b9ba9a1" }, "type": "array" }, "created_at": { "description": "Record creation date", "type": "string" }, "display_name": { "description": "The display name of the user using either the concatenated preferred given and family name or username depending on availability.", "type": "string" }, "emails": { "description": "The user's email addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiEmail5284c8258dc3" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "locale": { "description": "The User's default location for purposes of localization of currency, date time format, or numerical representations pursuant to RFC5646.", "type": "string" }, "name": { "description": "The user's name.", "properties": { "family_name": { "description": "The legal family name of the user, or last name in most Western languages.", "type": "string" }, "formatted": { "description": "The user's full name.", "type": "string" }, "given_name": { "description": "The given legal name of the user, or first name in most Western languages.", "type": "string" }, "middle_name": { "description": "The middle name(s) of the user.", "type": "string" }, "preferred_family_name": { "description": "The preferred family name, or last name in most Western languages, by the user.", "type": "string" }, "preferred_given_name": { "description": "The preferred given name, or first name in most Western languages, by the user.", "type": "string" } }, "title": "UserName", "type": "object" }, "number": { "description": "The permanent profile number of the user.", "type": "string" }, "phone_numbers": { "description": "The user's phone numbers.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoneNumber12060c61ecf5" }, "type": "array" }, "photos": { "description": "The user's photos.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoto2be7c3ae3f39" }, "type": "array" }, "preferred_language": { "description": "The User's preferred written or spoken language in the same format of the HTTP Accept-Language header, pursuant to Section 5.3.5 of RFC7231.", "type": "string" }, "timezone": { "description": "The User's current time zone in IANA database Olson format", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "username": { "description": "The unique identifier across Rippling used by the User for direct authentication into their associated company. Globally unique.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "User", "type": "object" }, "user_id": { "description": "The worker's associated user.", "type": "string" }, "work_email": { "description": "The worker's associated work email address.", "type": "string" }, "work_schedule": { "additionalProperties": { "$ref": "#/components/schemas/OutputRestApiWorkScheduleDay938f88d94f20" }, "description": "The worker's scheduled working hours for each day of the week.", "type": "object" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Worker", "type": "object" }, "worker_id": { "description": "The ID of the worker. Empty string '' to unassign if shift is from an open/empty shift.", "type": "string" } }, "required": [ "created_at", "id", "is_published", "schedule_id", "shift_data", "updated_at", "worker_id" ], "title": "ShiftAssignment", "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Create a new shift assignment", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "shiftassignments.read-write" ] } }, "/shiftassignments/{id}/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/get-shiftassignments" }, "operationId": "rippling.rest_api.get_shiftassignments", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "id", "type": "string" } }, { "in": "query", "name": "expand", "required": false, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "__meta": { "properties": { "redacted_fields": { "items": { "$ref": "#/components/schemas/OutputRestApiRedactedField21788a25ef22" }, "type": "array" } }, "type": "object" }, "can_edit": { "description": "Whether the shift assignment can be edited", "type": "boolean" }, "created_at": { "description": "Record creation date", "type": "string" }, "custom_fields": { "description": "Custom fields for the shift assignment", "items": { "additionalProperties": {} }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "is_published": { "description": "Whether the shift assignment is published. If true, the published_version will be the same as the shift_data", "type": "boolean" }, "published_version": { "description": "The published version of the shift assignment, if it exists. If filled but is_published is false, the shift_data is the latest version.", "properties": { "end_time": { "description": "The end time of the shift", "type": "string" }, "notes": { "description": "Notes for the shift, max length 256 characters", "maxLength": 256, "type": "string" }, "shift_breaks": { "description": "The breaks of the shift", "items": { "$ref": "#/components/schemas/OutputRestApiShiftBreak314820414f10" }, "type": "array" }, "shift_segments": { "description": "The segments of the shift", "items": { "$ref": "#/components/schemas/OutputRestApiShiftSegment2a530a829033" }, "type": "array" }, "start_time": { "description": "The start time of the shift", "type": "string" } }, "required": [ "end_time", "start_time" ], "title": "ShiftData", "type": "object" }, "schedule": { "description": "The schedule\n\nExpandable field", "properties": { "can_edit": { "description": "Whether the requesting role can edit the schedule.", "type": "boolean" }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "managers": { "description": "The managers of the schedule.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiWorker75ef4092b644" }, "type": "array" }, "managers_id": { "description": "The IDs of the managers of the schedule.", "items": { "type": "string" }, "type": "array" }, "members": { "description": "The members of the schedule.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiWorker75ef4092b644" }, "type": "array" }, "members_id": { "description": "The IDs of the members of the schedule.", "items": { "type": "string" }, "type": "array" }, "name": { "description": "The name of the schedule.", "type": "string" }, "observers": { "description": "The observers of the schedule.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiWorker75ef4092b644" }, "type": "array" }, "observers_id": { "description": "The IDs of the observers of the schedule.", "items": { "type": "string" }, "type": "array" }, "settings": { "description": "The settings of the schedule.", "properties": { "timezone": { "description": "The IANA timezone identifier for the schedule (e.g., 'America/New_York'). Accepted values are defined by the tz database, listed here: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones", "type": "string" } }, "title": "ScheduleSettings", "type": "object" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Schedule", "type": "object" }, "schedule_id": { "description": "The ID of the schedule", "type": "string" }, "shift_data": { "description": "The data of the shift", "properties": { "end_time": { "description": "The end time of the shift", "type": "string" }, "notes": { "description": "Notes for the shift, max length 256 characters", "maxLength": 256, "type": "string" }, "shift_breaks": { "description": "The breaks of the shift", "items": { "$ref": "#/components/schemas/OutputRestApiShiftBreak314820414f10" }, "type": "array" }, "shift_segments": { "description": "The segments of the shift", "items": { "$ref": "#/components/schemas/OutputRestApiShiftSegment2a530a829033" }, "type": "array" }, "start_time": { "description": "The start time of the shift", "type": "string" } }, "required": [ "end_time", "start_time" ], "title": "ShiftData", "type": "object" }, "updated_at": { "description": "Record update date", "type": "string" }, "worker": { "description": "The worker\n\nExpandable field", "properties": { "business_partners": { "description": "Worker's assigned business partners. This field is only populated when explicitly requested via the expand parameter (e.g., ?expand=business_partners). When expanded, returns an empty list ([]) if the worker has no business partners.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiBusinessPartner77b00a069c32" }, "type": "array" }, "business_partners_id": { "description": "Worker's assigned business partners unique identifiers. Returns an empty list ([]) if the worker has no business partners.", "items": { "type": "string" }, "type": "array" }, "citizenship": { "description": "The countries that the worker has citizenship in.", "type": "string" }, "compensation": { "description": "The compensation package for the worker.\n\nExpandable field", "properties": { "annual_compensation": { "description": "The worker's annual compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "annual_salary_equivalent": { "description": "The worker's annual salary equivalent, for insurance purposes. It will be equal to the worker's annual compensation, except for owners that are receiving no cashcompensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "bonus_schedule": { "description": "The worker's bonus schedule.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "hourly_wage": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "id": { "description": "Identifier field", "type": "string" }, "monthly_compensation": { "description": "The worker's monthly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "on_target_commission": { "description": "The worker's on-target commission.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "payment_terms": { "description": "The payment terms for an worker's compensation.", "type": "string" }, "payment_type": { "description": "The payment type for an worker's compensation.", "type": "string" }, "relocation_reimbursement": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "salary_effective_date": { "description": "Salary effective date", "type": "string" }, "signing_bonus": { "description": "The worker's signing bonus.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus": { "description": "The worker's target annual bonus amount.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus_percent": { "anyOf": [ { "description": "The worker's target annual bonus as a percent of annual compensation.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" }, "weekly_compensation": { "description": "The worker's weekly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "worker": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's details.\n\nExpandable field", "type": "object" }, "worker_id": { "description": "The worker's ID.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Compensation", "type": "object" }, "compensation_grade": { "description": "The compensation grade assigned to the worker, if any.", "properties": { "id": { "description": "The compensation grade's unique identifier.", "type": "string" }, "label": { "description": "The compensation grade's label.", "type": "string" } }, "title": "WorkerCompensationGrade", "type": "object" }, "compensation_id": { "description": "The compensation package for the worker.", "type": "string" }, "country": { "description": "The worker's country.", "type": "string" }, "country_fields": { "description": "Country level fields for the worker.", "properties": { "ca": { "description": "Country-wise regional fields for Canada", "properties": { "sin": { "description": "Social Insurance Number (SIN) for Canada employees.", "type": "string" } }, "title": "CanadaFields", "type": "object" }, "nz": { "description": "Country-wise regional fields for New Zealand", "properties": { "ird_number": { "description": "Inland Revenue Department (IRD) number for New Zealand employees.", "type": "string" } }, "title": "NewZealandFields", "type": "object" }, "us": { "description": "Country-wise regional fields for USA", "properties": { "ssn": { "description": "Social Security Number (SSN) for US employees.", "type": "string" } }, "title": "USFields", "type": "object" } }, "title": "CountryFields", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "custom_fields": { "description": "Custom field values defined on the Employee object for this worker\n\nExpandable field", "items": { "additionalProperties": {} }, "type": "array" }, "date_of_birth": { "description": "The worker's date of birth.", "type": "string" }, "department": { "description": "The worker's assigned department.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "department_hierarchy": { "description": "List of departments in the department hierarchy. Refer department_hierarchy_ids for department hierarchy order.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestDepartment" }, "type": "array" }, "department_hierarchy_id": { "description": "The identifier of departments in the department hierarchy ordered from parent department to child department.", "items": { "type": "string" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the department.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestDepartment", "description": "The parent department.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent department.", "type": "string" }, "reference_code": { "description": "Reference code of the department.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Department", "type": "object" }, "department_id": { "description": "The worker's assigned department.", "type": "string" }, "employment_type": { "description": "The worker's employment type.\n\nExpandable field", "properties": { "amount_worked": { "description": "The amount worked for the employment type. * `FULL-TIME`: Full-time is at least 30 hours per week. Full-time workers will typically be eligible for benefits. * `PART-TIME`: Part-time is less than 30 hours per week. These workers may be eligible for benefits, depending on company settings and hours worked. * `TEMPORARY`: These workers are hired on a temporary basis. You can specify how each worker with this employment type will be paid individually.", "type": "string" }, "compensation_time_period": { "description": "The compensation period for the employment type. * `SALARIED`: Employees that are paid a fixed amount per year. * `HOURLY`: Employees that are paid a wage per hour worked.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "label": { "description": "The display label of the employment type.", "type": "string" }, "name": { "description": "The name of the employment type for non-custom employment types.", "type": "string" }, "type": { "description": "The classification of the worker by the company. * `CONTRACTOR`: Contractors are self-employed workers who provide services on a short-term or per-project basis and are not eligible for tax-withholding or benefits. * `EMPLOYEE`: Employees are hired and managed by an employer, work under the employer's direct supervision and control, and are protected by law for wages and employment rights.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "label", "updated_at" ], "title": "CompanyEmploymentType", "type": "object" }, "employment_type_id": { "description": "The worker's employment type.", "type": "string" }, "end_date": { "description": "The end date of the worker.", "type": "string" }, "ethnicity": { "description": "The identified ethnicity of the worker, if specified.", "type": "string" }, "gender": { "description": "The gender of the worker, if specified.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_manager": { "description": "Whether the worker is a manager", "type": "boolean" }, "job_function": { "description": "The worker's job function. When expanded, this field requires `job-functions.read`.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "Displayed name of the job function", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "JobFunction", "type": "object" }, "job_function_id": { "description": "ID of the worker's job function.", "type": "string" }, "legal_entity": { "description": "The worker's associated legal entity.\n\nExpandable field", "properties": { "company": { "description": "The company or organization associated with the legal entity\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "doing_business_as_name": { "description": "The doing business as name for the company.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_entities": { "description": "A list of the company's entities.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestLegalEntity" }, "type": "array" }, "legal_entities_id": { "description": "A list of the company's entities.", "items": { "type": "string" }, "type": "array" }, "legal_name": { "description": "The legal name of the company.", "type": "string" }, "name": { "description": "The name of the company.", "type": "string" }, "parent_legal_entity": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The company's ultimate holding entity.\n\nExpandable field", "type": "object" }, "parent_legal_entity_id": { "description": "The company's ultimate holding entity.", "type": "string" }, "phone": { "description": "The phone number for the company.", "type": "string" }, "physical_address": { "description": "The physical address of the holding entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "primary_email": { "description": "The email address used when registering this company.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "legal_entities", "legal_entities_id", "name", "updated_at" ], "title": "Company", "type": "object" }, "company_id": { "description": "The company or organization associated with the legal entity", "type": "string" }, "country": { "description": "The country the legal entity is based in.", "properties": { "code": { "description": "The code of the country.", "type": "string" } }, "required": [ "code" ], "title": "Country", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "entity_level": { "description": "The legal entity's level in a hierarchy. * `PARENT`: The legal entity is considered the ultimate holding entity. * `SUBSIDIARY`: The legal entity is considered a subsidiary, fully or partially held by another. * `BRANCH`: The legal entity is considered a branch, associated with a parent legal entity.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_name": { "description": "The legal name of the legal entity.", "type": "string" }, "mailing_address": { "description": "The mailing address of the legal entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "management_type": { "description": "The legal entity management type in the case of an employer of record (EOR) or professional employment organization (PEO). * `PEO`: The legal entity is considered a Professional Employment Organization (PEO). * `EOR`: The legal entity is considered an Employer of Record (EOR).", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The parent legal entity.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent legal entity.", "type": "string" }, "physical_address": { "description": "The physical address of the legal entity, if it differs from the mailing address.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "registration_date": { "description": "The registration date of the entity.", "type": "string" }, "tax_identifier": { "description": "The tax identifier for the legal entity.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "LegalEntity", "type": "object" }, "legal_entity_id": { "description": "The worker's associated legal entity.", "type": "string" }, "level": { "description": "The level of the worker.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "description": { "description": "The description of the level.", "type": "string" }, "experience_requirements": { "description": "The experience requirements for the level.", "type": "string" }, "global_level": { "anyOf": [ { "description": "Global level is used to track the seniority of levels. The higher up a level is placed on the page, the more senior and higher-ranked the level. Global level is used in workflows, policies, and reports that use the level attribute (e.g., you can use Level Lookup to set up a workflow that notifies the nearest person in an worker's management chain at or above the specified level).", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the level. Must be unique within the company or organization.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLevel", "description": "The parent level.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent level.", "type": "string" }, "rank": { "anyOf": [ { "description": "The rank of the level within its track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "scope_of_responsibilities": { "description": "The scope of responsibilities for the level.", "type": "string" }, "track": { "description": "The track associated with the level, if it's not a global level.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_default": { "description": "Whether this is the company's default track.", "type": "boolean" }, "name": { "description": "The name of the track. Must be unique within the company or organization.", "type": "string" }, "order": { "anyOf": [ { "description": "The one-based horizontal display order of the track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "start_global_level": { "anyOf": [ { "description": "The highest global level occupied by this track. Empty tracks return null.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Track", "type": "object" }, "track_id": { "description": "The track associated with the level. Required during creation. Include global_level when changing it.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Level", "type": "object" }, "level_id": { "description": "The level of the worker.", "type": "string" }, "location": { "description": "The location that the worker is mapped to for tax purposes. In the case that a worker is remote, the location's type is remote.", "properties": { "type": { "description": "The type of location.", "type": "string" }, "work_location_id": { "description": "The work location, if the worker isn't remote.", "type": "string" } }, "required": [ "type", "work_location_id" ], "title": "WorkerLocation", "type": "object" }, "manager": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's manager.\n\nExpandable field", "type": "object" }, "manager_id": { "description": "The worker's manager.", "type": "string" }, "number": { "anyOf": [ { "description": "The worker's number within the organization.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "original_start_date": { "description": "The worker's earliest start date across their employment history, excluding INIT roles.", "type": "string" }, "overtime_exemption": { "description": "The worker's overtime exemption status.", "type": "string" }, "pay_schedule_id": { "description": "The ID of the pay schedule currently associated with the worker.", "type": "string" }, "personal_email": { "description": "The worker's associated personal email address.", "type": "string" }, "race": { "description": "The identified race of the worker, if specified.", "type": "string" }, "start_date": { "description": "The start date of the worker.", "type": "string" }, "status": { "description": "The worker's status within the organization.", "type": "string" }, "teams": { "description": "The worker's assigned teams.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiTeamcb26bc28f32f" }, "type": "array" }, "teams_id": { "description": "The worker's assigned teams.", "items": { "type": "string" }, "type": "array" }, "termination_details": { "description": "The details of the worker's termination, if applicable.", "properties": { "reason": { "description": "This is a description that will be custom to each Rippling company.", "type": "string" }, "type": { "description": "The termination type indicates whether the termination was voluntary or involuntary.", "type": "string" } }, "title": "TerminationDetails", "type": "object" }, "title": { "description": "The worker's title.", "type": "string" }, "title_effective_date": { "description": "Title effective date", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "user": { "description": "The worker's associated user.\n\nExpandable field", "properties": { "active": { "description": "Whether the user is able to access company resources, typically when they are in actively engaged with the company and not after off-boarding.", "type": "boolean" }, "addresses": { "description": "The user's addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiUserAddressedd59b9ba9a1" }, "type": "array" }, "created_at": { "description": "Record creation date", "type": "string" }, "display_name": { "description": "The display name of the user using either the concatenated preferred given and family name or username depending on availability.", "type": "string" }, "emails": { "description": "The user's email addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiEmail5284c8258dc3" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "locale": { "description": "The User's default location for purposes of localization of currency, date time format, or numerical representations pursuant to RFC5646.", "type": "string" }, "name": { "description": "The user's name.", "properties": { "family_name": { "description": "The legal family name of the user, or last name in most Western languages.", "type": "string" }, "formatted": { "description": "The user's full name.", "type": "string" }, "given_name": { "description": "The given legal name of the user, or first name in most Western languages.", "type": "string" }, "middle_name": { "description": "The middle name(s) of the user.", "type": "string" }, "preferred_family_name": { "description": "The preferred family name, or last name in most Western languages, by the user.", "type": "string" }, "preferred_given_name": { "description": "The preferred given name, or first name in most Western languages, by the user.", "type": "string" } }, "title": "UserName", "type": "object" }, "number": { "description": "The permanent profile number of the user.", "type": "string" }, "phone_numbers": { "description": "The user's phone numbers.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoneNumber12060c61ecf5" }, "type": "array" }, "photos": { "description": "The user's photos.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoto2be7c3ae3f39" }, "type": "array" }, "preferred_language": { "description": "The User's preferred written or spoken language in the same format of the HTTP Accept-Language header, pursuant to Section 5.3.5 of RFC7231.", "type": "string" }, "timezone": { "description": "The User's current time zone in IANA database Olson format", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "username": { "description": "The unique identifier across Rippling used by the User for direct authentication into their associated company. Globally unique.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "User", "type": "object" }, "user_id": { "description": "The worker's associated user.", "type": "string" }, "work_email": { "description": "The worker's associated work email address.", "type": "string" }, "work_schedule": { "additionalProperties": { "$ref": "#/components/schemas/OutputRestApiWorkScheduleDay938f88d94f20" }, "description": "The worker's scheduled working hours for each day of the week.", "type": "object" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Worker", "type": "object" }, "worker_id": { "description": "The ID of the worker. Empty string '' to unassign if shift is from an open/empty shift.", "type": "string" } }, "required": [ "created_at", "id", "is_published", "schedule_id", "shift_data", "updated_at", "worker_id" ], "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Retrieve a specific shift assignment", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "shiftassignments.read" ] }, "patch": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/update-shiftassignments" }, "operationId": "rippling.rest_api.update_shiftassignments", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "id", "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiShiftAssignmentUpdateRequest99692ad4196e" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "can_edit": { "description": "Whether the shift assignment can be edited", "type": "boolean" }, "created_at": { "description": "Record creation date", "type": "string" }, "custom_fields": { "description": "Custom fields for the shift assignment", "items": { "additionalProperties": {} }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "is_published": { "description": "Whether the shift assignment is published. If true, the published_version will be the same as the shift_data", "type": "boolean" }, "published_version": { "description": "The published version of the shift assignment, if it exists. If filled but is_published is false, the shift_data is the latest version.", "properties": { "end_time": { "description": "The end time of the shift", "type": "string" }, "notes": { "description": "Notes for the shift, max length 256 characters", "maxLength": 256, "type": "string" }, "shift_breaks": { "description": "The breaks of the shift", "items": { "$ref": "#/components/schemas/OutputRestApiShiftBreak314820414f10" }, "type": "array" }, "shift_segments": { "description": "The segments of the shift", "items": { "$ref": "#/components/schemas/OutputRestApiShiftSegment2a530a829033" }, "type": "array" }, "start_time": { "description": "The start time of the shift", "type": "string" } }, "required": [ "end_time", "start_time" ], "title": "ShiftData", "type": "object" }, "schedule": { "description": "The schedule\n\nExpandable field", "properties": { "can_edit": { "description": "Whether the requesting role can edit the schedule.", "type": "boolean" }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "managers": { "description": "The managers of the schedule.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiWorker75ef4092b644" }, "type": "array" }, "managers_id": { "description": "The IDs of the managers of the schedule.", "items": { "type": "string" }, "type": "array" }, "members": { "description": "The members of the schedule.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiWorker75ef4092b644" }, "type": "array" }, "members_id": { "description": "The IDs of the members of the schedule.", "items": { "type": "string" }, "type": "array" }, "name": { "description": "The name of the schedule.", "type": "string" }, "observers": { "description": "The observers of the schedule.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiWorker75ef4092b644" }, "type": "array" }, "observers_id": { "description": "The IDs of the observers of the schedule.", "items": { "type": "string" }, "type": "array" }, "settings": { "description": "The settings of the schedule.", "properties": { "timezone": { "description": "The IANA timezone identifier for the schedule (e.g., 'America/New_York'). Accepted values are defined by the tz database, listed here: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones", "type": "string" } }, "title": "ScheduleSettings", "type": "object" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Schedule", "type": "object" }, "schedule_id": { "description": "The ID of the schedule", "type": "string" }, "shift_data": { "description": "The data of the shift", "properties": { "end_time": { "description": "The end time of the shift", "type": "string" }, "notes": { "description": "Notes for the shift, max length 256 characters", "maxLength": 256, "type": "string" }, "shift_breaks": { "description": "The breaks of the shift", "items": { "$ref": "#/components/schemas/OutputRestApiShiftBreak314820414f10" }, "type": "array" }, "shift_segments": { "description": "The segments of the shift", "items": { "$ref": "#/components/schemas/OutputRestApiShiftSegment2a530a829033" }, "type": "array" }, "start_time": { "description": "The start time of the shift", "type": "string" } }, "required": [ "end_time", "start_time" ], "title": "ShiftData", "type": "object" }, "updated_at": { "description": "Record update date", "type": "string" }, "worker": { "description": "The worker\n\nExpandable field", "properties": { "business_partners": { "description": "Worker's assigned business partners. This field is only populated when explicitly requested via the expand parameter (e.g., ?expand=business_partners). When expanded, returns an empty list ([]) if the worker has no business partners.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiBusinessPartner77b00a069c32" }, "type": "array" }, "business_partners_id": { "description": "Worker's assigned business partners unique identifiers. Returns an empty list ([]) if the worker has no business partners.", "items": { "type": "string" }, "type": "array" }, "citizenship": { "description": "The countries that the worker has citizenship in.", "type": "string" }, "compensation": { "description": "The compensation package for the worker.\n\nExpandable field", "properties": { "annual_compensation": { "description": "The worker's annual compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "annual_salary_equivalent": { "description": "The worker's annual salary equivalent, for insurance purposes. It will be equal to the worker's annual compensation, except for owners that are receiving no cashcompensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "bonus_schedule": { "description": "The worker's bonus schedule.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "hourly_wage": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "id": { "description": "Identifier field", "type": "string" }, "monthly_compensation": { "description": "The worker's monthly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "on_target_commission": { "description": "The worker's on-target commission.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "payment_terms": { "description": "The payment terms for an worker's compensation.", "type": "string" }, "payment_type": { "description": "The payment type for an worker's compensation.", "type": "string" }, "relocation_reimbursement": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "salary_effective_date": { "description": "Salary effective date", "type": "string" }, "signing_bonus": { "description": "The worker's signing bonus.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus": { "description": "The worker's target annual bonus amount.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus_percent": { "anyOf": [ { "description": "The worker's target annual bonus as a percent of annual compensation.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" }, "weekly_compensation": { "description": "The worker's weekly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "worker": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's details.\n\nExpandable field", "type": "object" }, "worker_id": { "description": "The worker's ID.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Compensation", "type": "object" }, "compensation_grade": { "description": "The compensation grade assigned to the worker, if any.", "properties": { "id": { "description": "The compensation grade's unique identifier.", "type": "string" }, "label": { "description": "The compensation grade's label.", "type": "string" } }, "title": "WorkerCompensationGrade", "type": "object" }, "compensation_id": { "description": "The compensation package for the worker.", "type": "string" }, "country": { "description": "The worker's country.", "type": "string" }, "country_fields": { "description": "Country level fields for the worker.", "properties": { "ca": { "description": "Country-wise regional fields for Canada", "properties": { "sin": { "description": "Social Insurance Number (SIN) for Canada employees.", "type": "string" } }, "title": "CanadaFields", "type": "object" }, "nz": { "description": "Country-wise regional fields for New Zealand", "properties": { "ird_number": { "description": "Inland Revenue Department (IRD) number for New Zealand employees.", "type": "string" } }, "title": "NewZealandFields", "type": "object" }, "us": { "description": "Country-wise regional fields for USA", "properties": { "ssn": { "description": "Social Security Number (SSN) for US employees.", "type": "string" } }, "title": "USFields", "type": "object" } }, "title": "CountryFields", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "custom_fields": { "description": "Custom field values defined on the Employee object for this worker\n\nExpandable field", "items": { "additionalProperties": {} }, "type": "array" }, "date_of_birth": { "description": "The worker's date of birth.", "type": "string" }, "department": { "description": "The worker's assigned department.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "department_hierarchy": { "description": "List of departments in the department hierarchy. Refer department_hierarchy_ids for department hierarchy order.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestDepartment" }, "type": "array" }, "department_hierarchy_id": { "description": "The identifier of departments in the department hierarchy ordered from parent department to child department.", "items": { "type": "string" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the department.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestDepartment", "description": "The parent department.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent department.", "type": "string" }, "reference_code": { "description": "Reference code of the department.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Department", "type": "object" }, "department_id": { "description": "The worker's assigned department.", "type": "string" }, "employment_type": { "description": "The worker's employment type.\n\nExpandable field", "properties": { "amount_worked": { "description": "The amount worked for the employment type. * `FULL-TIME`: Full-time is at least 30 hours per week. Full-time workers will typically be eligible for benefits. * `PART-TIME`: Part-time is less than 30 hours per week. These workers may be eligible for benefits, depending on company settings and hours worked. * `TEMPORARY`: These workers are hired on a temporary basis. You can specify how each worker with this employment type will be paid individually.", "type": "string" }, "compensation_time_period": { "description": "The compensation period for the employment type. * `SALARIED`: Employees that are paid a fixed amount per year. * `HOURLY`: Employees that are paid a wage per hour worked.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "label": { "description": "The display label of the employment type.", "type": "string" }, "name": { "description": "The name of the employment type for non-custom employment types.", "type": "string" }, "type": { "description": "The classification of the worker by the company. * `CONTRACTOR`: Contractors are self-employed workers who provide services on a short-term or per-project basis and are not eligible for tax-withholding or benefits. * `EMPLOYEE`: Employees are hired and managed by an employer, work under the employer's direct supervision and control, and are protected by law for wages and employment rights.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "label", "updated_at" ], "title": "CompanyEmploymentType", "type": "object" }, "employment_type_id": { "description": "The worker's employment type.", "type": "string" }, "end_date": { "description": "The end date of the worker.", "type": "string" }, "ethnicity": { "description": "The identified ethnicity of the worker, if specified.", "type": "string" }, "gender": { "description": "The gender of the worker, if specified.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_manager": { "description": "Whether the worker is a manager", "type": "boolean" }, "job_function": { "description": "The worker's job function. When expanded, this field requires `job-functions.read`.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "Displayed name of the job function", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "JobFunction", "type": "object" }, "job_function_id": { "description": "ID of the worker's job function.", "type": "string" }, "legal_entity": { "description": "The worker's associated legal entity.\n\nExpandable field", "properties": { "company": { "description": "The company or organization associated with the legal entity\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "doing_business_as_name": { "description": "The doing business as name for the company.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_entities": { "description": "A list of the company's entities.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestLegalEntity" }, "type": "array" }, "legal_entities_id": { "description": "A list of the company's entities.", "items": { "type": "string" }, "type": "array" }, "legal_name": { "description": "The legal name of the company.", "type": "string" }, "name": { "description": "The name of the company.", "type": "string" }, "parent_legal_entity": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The company's ultimate holding entity.\n\nExpandable field", "type": "object" }, "parent_legal_entity_id": { "description": "The company's ultimate holding entity.", "type": "string" }, "phone": { "description": "The phone number for the company.", "type": "string" }, "physical_address": { "description": "The physical address of the holding entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "primary_email": { "description": "The email address used when registering this company.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "legal_entities", "legal_entities_id", "name", "updated_at" ], "title": "Company", "type": "object" }, "company_id": { "description": "The company or organization associated with the legal entity", "type": "string" }, "country": { "description": "The country the legal entity is based in.", "properties": { "code": { "description": "The code of the country.", "type": "string" } }, "required": [ "code" ], "title": "Country", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "entity_level": { "description": "The legal entity's level in a hierarchy. * `PARENT`: The legal entity is considered the ultimate holding entity. * `SUBSIDIARY`: The legal entity is considered a subsidiary, fully or partially held by another. * `BRANCH`: The legal entity is considered a branch, associated with a parent legal entity.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_name": { "description": "The legal name of the legal entity.", "type": "string" }, "mailing_address": { "description": "The mailing address of the legal entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "management_type": { "description": "The legal entity management type in the case of an employer of record (EOR) or professional employment organization (PEO). * `PEO`: The legal entity is considered a Professional Employment Organization (PEO). * `EOR`: The legal entity is considered an Employer of Record (EOR).", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The parent legal entity.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent legal entity.", "type": "string" }, "physical_address": { "description": "The physical address of the legal entity, if it differs from the mailing address.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "registration_date": { "description": "The registration date of the entity.", "type": "string" }, "tax_identifier": { "description": "The tax identifier for the legal entity.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "LegalEntity", "type": "object" }, "legal_entity_id": { "description": "The worker's associated legal entity.", "type": "string" }, "level": { "description": "The level of the worker.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "description": { "description": "The description of the level.", "type": "string" }, "experience_requirements": { "description": "The experience requirements for the level.", "type": "string" }, "global_level": { "anyOf": [ { "description": "Global level is used to track the seniority of levels. The higher up a level is placed on the page, the more senior and higher-ranked the level. Global level is used in workflows, policies, and reports that use the level attribute (e.g., you can use Level Lookup to set up a workflow that notifies the nearest person in an worker's management chain at or above the specified level).", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the level. Must be unique within the company or organization.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLevel", "description": "The parent level.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent level.", "type": "string" }, "rank": { "anyOf": [ { "description": "The rank of the level within its track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "scope_of_responsibilities": { "description": "The scope of responsibilities for the level.", "type": "string" }, "track": { "description": "The track associated with the level, if it's not a global level.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_default": { "description": "Whether this is the company's default track.", "type": "boolean" }, "name": { "description": "The name of the track. Must be unique within the company or organization.", "type": "string" }, "order": { "anyOf": [ { "description": "The one-based horizontal display order of the track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "start_global_level": { "anyOf": [ { "description": "The highest global level occupied by this track. Empty tracks return null.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Track", "type": "object" }, "track_id": { "description": "The track associated with the level. Required during creation. Include global_level when changing it.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Level", "type": "object" }, "level_id": { "description": "The level of the worker.", "type": "string" }, "location": { "description": "The location that the worker is mapped to for tax purposes. In the case that a worker is remote, the location's type is remote.", "properties": { "type": { "description": "The type of location.", "type": "string" }, "work_location_id": { "description": "The work location, if the worker isn't remote.", "type": "string" } }, "required": [ "type", "work_location_id" ], "title": "WorkerLocation", "type": "object" }, "manager": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's manager.\n\nExpandable field", "type": "object" }, "manager_id": { "description": "The worker's manager.", "type": "string" }, "number": { "anyOf": [ { "description": "The worker's number within the organization.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "original_start_date": { "description": "The worker's earliest start date across their employment history, excluding INIT roles.", "type": "string" }, "overtime_exemption": { "description": "The worker's overtime exemption status.", "type": "string" }, "pay_schedule_id": { "description": "The ID of the pay schedule currently associated with the worker.", "type": "string" }, "personal_email": { "description": "The worker's associated personal email address.", "type": "string" }, "race": { "description": "The identified race of the worker, if specified.", "type": "string" }, "start_date": { "description": "The start date of the worker.", "type": "string" }, "status": { "description": "The worker's status within the organization.", "type": "string" }, "teams": { "description": "The worker's assigned teams.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiTeamcb26bc28f32f" }, "type": "array" }, "teams_id": { "description": "The worker's assigned teams.", "items": { "type": "string" }, "type": "array" }, "termination_details": { "description": "The details of the worker's termination, if applicable.", "properties": { "reason": { "description": "This is a description that will be custom to each Rippling company.", "type": "string" }, "type": { "description": "The termination type indicates whether the termination was voluntary or involuntary.", "type": "string" } }, "title": "TerminationDetails", "type": "object" }, "title": { "description": "The worker's title.", "type": "string" }, "title_effective_date": { "description": "Title effective date", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "user": { "description": "The worker's associated user.\n\nExpandable field", "properties": { "active": { "description": "Whether the user is able to access company resources, typically when they are in actively engaged with the company and not after off-boarding.", "type": "boolean" }, "addresses": { "description": "The user's addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiUserAddressedd59b9ba9a1" }, "type": "array" }, "created_at": { "description": "Record creation date", "type": "string" }, "display_name": { "description": "The display name of the user using either the concatenated preferred given and family name or username depending on availability.", "type": "string" }, "emails": { "description": "The user's email addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiEmail5284c8258dc3" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "locale": { "description": "The User's default location for purposes of localization of currency, date time format, or numerical representations pursuant to RFC5646.", "type": "string" }, "name": { "description": "The user's name.", "properties": { "family_name": { "description": "The legal family name of the user, or last name in most Western languages.", "type": "string" }, "formatted": { "description": "The user's full name.", "type": "string" }, "given_name": { "description": "The given legal name of the user, or first name in most Western languages.", "type": "string" }, "middle_name": { "description": "The middle name(s) of the user.", "type": "string" }, "preferred_family_name": { "description": "The preferred family name, or last name in most Western languages, by the user.", "type": "string" }, "preferred_given_name": { "description": "The preferred given name, or first name in most Western languages, by the user.", "type": "string" } }, "title": "UserName", "type": "object" }, "number": { "description": "The permanent profile number of the user.", "type": "string" }, "phone_numbers": { "description": "The user's phone numbers.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoneNumber12060c61ecf5" }, "type": "array" }, "photos": { "description": "The user's photos.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoto2be7c3ae3f39" }, "type": "array" }, "preferred_language": { "description": "The User's preferred written or spoken language in the same format of the HTTP Accept-Language header, pursuant to Section 5.3.5 of RFC7231.", "type": "string" }, "timezone": { "description": "The User's current time zone in IANA database Olson format", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "username": { "description": "The unique identifier across Rippling used by the User for direct authentication into their associated company. Globally unique.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "User", "type": "object" }, "user_id": { "description": "The worker's associated user.", "type": "string" }, "work_email": { "description": "The worker's associated work email address.", "type": "string" }, "work_schedule": { "additionalProperties": { "$ref": "#/components/schemas/OutputRestApiWorkScheduleDay938f88d94f20" }, "description": "The worker's scheduled working hours for each day of the week.", "type": "object" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Worker", "type": "object" }, "worker_id": { "description": "The ID of the worker. Empty string '' to unassign if shift is from an open/empty shift.", "type": "string" } }, "required": [ "created_at", "id", "is_published", "schedule_id", "shift_data", "updated_at", "worker_id" ], "title": "ShiftAssignment", "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Update a shift assignment", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "shiftassignments.read-write" ] } }, "/shiftassignments/{id}/customfields/": { "patch": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/update-shiftassignments-customfields" }, "operationId": "rippling.rest_api.update_shiftassignments_customfields", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "description": "Dictionary mapping custom field names to their values. Field names are dynamic and depend on your company's custom field configuration.", "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "__meta": { "properties": { "redacted_fields": { "items": { "$ref": "#/components/schemas/OutputRestApiRedactedField21788a25ef22" }, "type": "array" } }, "type": "object" }, "can_edit": { "description": "Whether the shift assignment can be edited", "type": "boolean" }, "created_at": { "description": "Record creation date", "type": "string" }, "custom_fields": { "description": "Custom fields for the shift assignment", "items": { "additionalProperties": {} }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "is_published": { "description": "Whether the shift assignment is published. If true, the published_version will be the same as the shift_data", "type": "boolean" }, "published_version": { "description": "The published version of the shift assignment, if it exists. If filled but is_published is false, the shift_data is the latest version.", "properties": { "end_time": { "description": "The end time of the shift", "type": "string" }, "notes": { "description": "Notes for the shift, max length 256 characters", "maxLength": 256, "type": "string" }, "shift_breaks": { "description": "The breaks of the shift", "items": { "$ref": "#/components/schemas/OutputRestApiShiftBreak314820414f10" }, "type": "array" }, "shift_segments": { "description": "The segments of the shift", "items": { "$ref": "#/components/schemas/OutputRestApiShiftSegment2a530a829033" }, "type": "array" }, "start_time": { "description": "The start time of the shift", "type": "string" } }, "required": [ "end_time", "start_time" ], "title": "ShiftData", "type": "object" }, "schedule": { "description": "The schedule\n\nExpandable field", "properties": { "can_edit": { "description": "Whether the requesting role can edit the schedule.", "type": "boolean" }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "managers": { "description": "The managers of the schedule.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiWorker75ef4092b644" }, "type": "array" }, "managers_id": { "description": "The IDs of the managers of the schedule.", "items": { "type": "string" }, "type": "array" }, "members": { "description": "The members of the schedule.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiWorker75ef4092b644" }, "type": "array" }, "members_id": { "description": "The IDs of the members of the schedule.", "items": { "type": "string" }, "type": "array" }, "name": { "description": "The name of the schedule.", "type": "string" }, "observers": { "description": "The observers of the schedule.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiWorker75ef4092b644" }, "type": "array" }, "observers_id": { "description": "The IDs of the observers of the schedule.", "items": { "type": "string" }, "type": "array" }, "settings": { "description": "The settings of the schedule.", "properties": { "timezone": { "description": "The IANA timezone identifier for the schedule (e.g., 'America/New_York'). Accepted values are defined by the tz database, listed here: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones", "type": "string" } }, "title": "ScheduleSettings", "type": "object" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Schedule", "type": "object" }, "schedule_id": { "description": "The ID of the schedule", "type": "string" }, "shift_data": { "description": "The data of the shift", "properties": { "end_time": { "description": "The end time of the shift", "type": "string" }, "notes": { "description": "Notes for the shift, max length 256 characters", "maxLength": 256, "type": "string" }, "shift_breaks": { "description": "The breaks of the shift", "items": { "$ref": "#/components/schemas/OutputRestApiShiftBreak314820414f10" }, "type": "array" }, "shift_segments": { "description": "The segments of the shift", "items": { "$ref": "#/components/schemas/OutputRestApiShiftSegment2a530a829033" }, "type": "array" }, "start_time": { "description": "The start time of the shift", "type": "string" } }, "required": [ "end_time", "start_time" ], "title": "ShiftData", "type": "object" }, "updated_at": { "description": "Record update date", "type": "string" }, "worker": { "description": "The worker\n\nExpandable field", "properties": { "business_partners": { "description": "Worker's assigned business partners. This field is only populated when explicitly requested via the expand parameter (e.g., ?expand=business_partners). When expanded, returns an empty list ([]) if the worker has no business partners.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiBusinessPartner77b00a069c32" }, "type": "array" }, "business_partners_id": { "description": "Worker's assigned business partners unique identifiers. Returns an empty list ([]) if the worker has no business partners.", "items": { "type": "string" }, "type": "array" }, "citizenship": { "description": "The countries that the worker has citizenship in.", "type": "string" }, "compensation": { "description": "The compensation package for the worker.\n\nExpandable field", "properties": { "annual_compensation": { "description": "The worker's annual compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "annual_salary_equivalent": { "description": "The worker's annual salary equivalent, for insurance purposes. It will be equal to the worker's annual compensation, except for owners that are receiving no cashcompensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "bonus_schedule": { "description": "The worker's bonus schedule.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "hourly_wage": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "id": { "description": "Identifier field", "type": "string" }, "monthly_compensation": { "description": "The worker's monthly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "on_target_commission": { "description": "The worker's on-target commission.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "payment_terms": { "description": "The payment terms for an worker's compensation.", "type": "string" }, "payment_type": { "description": "The payment type for an worker's compensation.", "type": "string" }, "relocation_reimbursement": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "salary_effective_date": { "description": "Salary effective date", "type": "string" }, "signing_bonus": { "description": "The worker's signing bonus.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus": { "description": "The worker's target annual bonus amount.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus_percent": { "anyOf": [ { "description": "The worker's target annual bonus as a percent of annual compensation.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" }, "weekly_compensation": { "description": "The worker's weekly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "worker": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's details.\n\nExpandable field", "type": "object" }, "worker_id": { "description": "The worker's ID.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Compensation", "type": "object" }, "compensation_grade": { "description": "The compensation grade assigned to the worker, if any.", "properties": { "id": { "description": "The compensation grade's unique identifier.", "type": "string" }, "label": { "description": "The compensation grade's label.", "type": "string" } }, "title": "WorkerCompensationGrade", "type": "object" }, "compensation_id": { "description": "The compensation package for the worker.", "type": "string" }, "country": { "description": "The worker's country.", "type": "string" }, "country_fields": { "description": "Country level fields for the worker.", "properties": { "ca": { "description": "Country-wise regional fields for Canada", "properties": { "sin": { "description": "Social Insurance Number (SIN) for Canada employees.", "type": "string" } }, "title": "CanadaFields", "type": "object" }, "nz": { "description": "Country-wise regional fields for New Zealand", "properties": { "ird_number": { "description": "Inland Revenue Department (IRD) number for New Zealand employees.", "type": "string" } }, "title": "NewZealandFields", "type": "object" }, "us": { "description": "Country-wise regional fields for USA", "properties": { "ssn": { "description": "Social Security Number (SSN) for US employees.", "type": "string" } }, "title": "USFields", "type": "object" } }, "title": "CountryFields", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "custom_fields": { "description": "Custom field values defined on the Employee object for this worker\n\nExpandable field", "items": { "additionalProperties": {} }, "type": "array" }, "date_of_birth": { "description": "The worker's date of birth.", "type": "string" }, "department": { "description": "The worker's assigned department.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "department_hierarchy": { "description": "List of departments in the department hierarchy. Refer department_hierarchy_ids for department hierarchy order.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestDepartment" }, "type": "array" }, "department_hierarchy_id": { "description": "The identifier of departments in the department hierarchy ordered from parent department to child department.", "items": { "type": "string" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the department.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestDepartment", "description": "The parent department.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent department.", "type": "string" }, "reference_code": { "description": "Reference code of the department.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Department", "type": "object" }, "department_id": { "description": "The worker's assigned department.", "type": "string" }, "employment_type": { "description": "The worker's employment type.\n\nExpandable field", "properties": { "amount_worked": { "description": "The amount worked for the employment type. * `FULL-TIME`: Full-time is at least 30 hours per week. Full-time workers will typically be eligible for benefits. * `PART-TIME`: Part-time is less than 30 hours per week. These workers may be eligible for benefits, depending on company settings and hours worked. * `TEMPORARY`: These workers are hired on a temporary basis. You can specify how each worker with this employment type will be paid individually.", "type": "string" }, "compensation_time_period": { "description": "The compensation period for the employment type. * `SALARIED`: Employees that are paid a fixed amount per year. * `HOURLY`: Employees that are paid a wage per hour worked.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "label": { "description": "The display label of the employment type.", "type": "string" }, "name": { "description": "The name of the employment type for non-custom employment types.", "type": "string" }, "type": { "description": "The classification of the worker by the company. * `CONTRACTOR`: Contractors are self-employed workers who provide services on a short-term or per-project basis and are not eligible for tax-withholding or benefits. * `EMPLOYEE`: Employees are hired and managed by an employer, work under the employer's direct supervision and control, and are protected by law for wages and employment rights.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "label", "updated_at" ], "title": "CompanyEmploymentType", "type": "object" }, "employment_type_id": { "description": "The worker's employment type.", "type": "string" }, "end_date": { "description": "The end date of the worker.", "type": "string" }, "ethnicity": { "description": "The identified ethnicity of the worker, if specified.", "type": "string" }, "gender": { "description": "The gender of the worker, if specified.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_manager": { "description": "Whether the worker is a manager", "type": "boolean" }, "job_function": { "description": "The worker's job function. When expanded, this field requires `job-functions.read`.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "Displayed name of the job function", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "JobFunction", "type": "object" }, "job_function_id": { "description": "ID of the worker's job function.", "type": "string" }, "legal_entity": { "description": "The worker's associated legal entity.\n\nExpandable field", "properties": { "company": { "description": "The company or organization associated with the legal entity\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "doing_business_as_name": { "description": "The doing business as name for the company.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_entities": { "description": "A list of the company's entities.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestLegalEntity" }, "type": "array" }, "legal_entities_id": { "description": "A list of the company's entities.", "items": { "type": "string" }, "type": "array" }, "legal_name": { "description": "The legal name of the company.", "type": "string" }, "name": { "description": "The name of the company.", "type": "string" }, "parent_legal_entity": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The company's ultimate holding entity.\n\nExpandable field", "type": "object" }, "parent_legal_entity_id": { "description": "The company's ultimate holding entity.", "type": "string" }, "phone": { "description": "The phone number for the company.", "type": "string" }, "physical_address": { "description": "The physical address of the holding entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "primary_email": { "description": "The email address used when registering this company.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "legal_entities", "legal_entities_id", "name", "updated_at" ], "title": "Company", "type": "object" }, "company_id": { "description": "The company or organization associated with the legal entity", "type": "string" }, "country": { "description": "The country the legal entity is based in.", "properties": { "code": { "description": "The code of the country.", "type": "string" } }, "required": [ "code" ], "title": "Country", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "entity_level": { "description": "The legal entity's level in a hierarchy. * `PARENT`: The legal entity is considered the ultimate holding entity. * `SUBSIDIARY`: The legal entity is considered a subsidiary, fully or partially held by another. * `BRANCH`: The legal entity is considered a branch, associated with a parent legal entity.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_name": { "description": "The legal name of the legal entity.", "type": "string" }, "mailing_address": { "description": "The mailing address of the legal entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "management_type": { "description": "The legal entity management type in the case of an employer of record (EOR) or professional employment organization (PEO). * `PEO`: The legal entity is considered a Professional Employment Organization (PEO). * `EOR`: The legal entity is considered an Employer of Record (EOR).", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The parent legal entity.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent legal entity.", "type": "string" }, "physical_address": { "description": "The physical address of the legal entity, if it differs from the mailing address.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "registration_date": { "description": "The registration date of the entity.", "type": "string" }, "tax_identifier": { "description": "The tax identifier for the legal entity.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "LegalEntity", "type": "object" }, "legal_entity_id": { "description": "The worker's associated legal entity.", "type": "string" }, "level": { "description": "The level of the worker.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "description": { "description": "The description of the level.", "type": "string" }, "experience_requirements": { "description": "The experience requirements for the level.", "type": "string" }, "global_level": { "anyOf": [ { "description": "Global level is used to track the seniority of levels. The higher up a level is placed on the page, the more senior and higher-ranked the level. Global level is used in workflows, policies, and reports that use the level attribute (e.g., you can use Level Lookup to set up a workflow that notifies the nearest person in an worker's management chain at or above the specified level).", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the level. Must be unique within the company or organization.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLevel", "description": "The parent level.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent level.", "type": "string" }, "rank": { "anyOf": [ { "description": "The rank of the level within its track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "scope_of_responsibilities": { "description": "The scope of responsibilities for the level.", "type": "string" }, "track": { "description": "The track associated with the level, if it's not a global level.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_default": { "description": "Whether this is the company's default track.", "type": "boolean" }, "name": { "description": "The name of the track. Must be unique within the company or organization.", "type": "string" }, "order": { "anyOf": [ { "description": "The one-based horizontal display order of the track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "start_global_level": { "anyOf": [ { "description": "The highest global level occupied by this track. Empty tracks return null.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Track", "type": "object" }, "track_id": { "description": "The track associated with the level. Required during creation. Include global_level when changing it.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Level", "type": "object" }, "level_id": { "description": "The level of the worker.", "type": "string" }, "location": { "description": "The location that the worker is mapped to for tax purposes. In the case that a worker is remote, the location's type is remote.", "properties": { "type": { "description": "The type of location.", "type": "string" }, "work_location_id": { "description": "The work location, if the worker isn't remote.", "type": "string" } }, "required": [ "type", "work_location_id" ], "title": "WorkerLocation", "type": "object" }, "manager": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's manager.\n\nExpandable field", "type": "object" }, "manager_id": { "description": "The worker's manager.", "type": "string" }, "number": { "anyOf": [ { "description": "The worker's number within the organization.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "original_start_date": { "description": "The worker's earliest start date across their employment history, excluding INIT roles.", "type": "string" }, "overtime_exemption": { "description": "The worker's overtime exemption status.", "type": "string" }, "pay_schedule_id": { "description": "The ID of the pay schedule currently associated with the worker.", "type": "string" }, "personal_email": { "description": "The worker's associated personal email address.", "type": "string" }, "race": { "description": "The identified race of the worker, if specified.", "type": "string" }, "start_date": { "description": "The start date of the worker.", "type": "string" }, "status": { "description": "The worker's status within the organization.", "type": "string" }, "teams": { "description": "The worker's assigned teams.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiTeamcb26bc28f32f" }, "type": "array" }, "teams_id": { "description": "The worker's assigned teams.", "items": { "type": "string" }, "type": "array" }, "termination_details": { "description": "The details of the worker's termination, if applicable.", "properties": { "reason": { "description": "This is a description that will be custom to each Rippling company.", "type": "string" }, "type": { "description": "The termination type indicates whether the termination was voluntary or involuntary.", "type": "string" } }, "title": "TerminationDetails", "type": "object" }, "title": { "description": "The worker's title.", "type": "string" }, "title_effective_date": { "description": "Title effective date", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "user": { "description": "The worker's associated user.\n\nExpandable field", "properties": { "active": { "description": "Whether the user is able to access company resources, typically when they are in actively engaged with the company and not after off-boarding.", "type": "boolean" }, "addresses": { "description": "The user's addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiUserAddressedd59b9ba9a1" }, "type": "array" }, "created_at": { "description": "Record creation date", "type": "string" }, "display_name": { "description": "The display name of the user using either the concatenated preferred given and family name or username depending on availability.", "type": "string" }, "emails": { "description": "The user's email addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiEmail5284c8258dc3" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "locale": { "description": "The User's default location for purposes of localization of currency, date time format, or numerical representations pursuant to RFC5646.", "type": "string" }, "name": { "description": "The user's name.", "properties": { "family_name": { "description": "The legal family name of the user, or last name in most Western languages.", "type": "string" }, "formatted": { "description": "The user's full name.", "type": "string" }, "given_name": { "description": "The given legal name of the user, or first name in most Western languages.", "type": "string" }, "middle_name": { "description": "The middle name(s) of the user.", "type": "string" }, "preferred_family_name": { "description": "The preferred family name, or last name in most Western languages, by the user.", "type": "string" }, "preferred_given_name": { "description": "The preferred given name, or first name in most Western languages, by the user.", "type": "string" } }, "title": "UserName", "type": "object" }, "number": { "description": "The permanent profile number of the user.", "type": "string" }, "phone_numbers": { "description": "The user's phone numbers.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoneNumber12060c61ecf5" }, "type": "array" }, "photos": { "description": "The user's photos.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoto2be7c3ae3f39" }, "type": "array" }, "preferred_language": { "description": "The User's preferred written or spoken language in the same format of the HTTP Accept-Language header, pursuant to Section 5.3.5 of RFC7231.", "type": "string" }, "timezone": { "description": "The User's current time zone in IANA database Olson format", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "username": { "description": "The unique identifier across Rippling used by the User for direct authentication into their associated company. Globally unique.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "User", "type": "object" }, "user_id": { "description": "The worker's associated user.", "type": "string" }, "work_email": { "description": "The worker's associated work email address.", "type": "string" }, "work_schedule": { "additionalProperties": { "$ref": "#/components/schemas/OutputRestApiWorkScheduleDay938f88d94f20" }, "description": "The worker's scheduled working hours for each day of the week.", "type": "object" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Worker", "type": "object" }, "worker_id": { "description": "The ID of the worker. Empty string '' to unassign if shift is from an open/empty shift.", "type": "string" } }, "required": [ "created_at", "id", "is_published", "schedule_id", "shift_data", "updated_at", "worker_id" ], "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Update custom fields for a shift assignment", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "shiftassignments.read-write" ] } }, "/sites/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/list-sites" }, "operationId": "rippling.rest_api.list_sites", "parameters": [ { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 100, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "__meta": { "$ref": "#/components/schemas/OutputRestApiRedactedFields9f7657dc2a2f" }, "next_link": { "description": "A link to the next page of responses.", "format": "uri", "type": "string" }, "results": { "items": { "$ref": "#/components/schemas/OutputRestApiSite17f973608cc3" }, "type": "array" } }, "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "List Sites", "x-rippling-entitlements": [ "Sites_Platform_API" ], "x-rippling-required-scopes": [ "sites.read" ] }, "post": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/create-sites" }, "operationId": "rippling.rest_api.create_sites", "parameters": [ { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "description": "Request body for create/PATCH using a staged upload file_id.", "properties": { "api_name": { "description": "The unique api name of the custom site", "type": "string" }, "description": { "description": "The optional description of the custom site", "type": "string" }, "entry_path": { "description": "Entry path inside the uploaded asset (for example index.html). Required with file_id when the zip has no index.html.", "type": "string" }, "file_id": { "description": "Staged upload id from POST /sites/upload-batches/presign/ after uploading bytes to S3. Required to create a site or replace the bundle. The id can be reused for 1 hour from presign, each attach copies the bytes into that site's bundle, a repeat attach before expiry creates another bundle, and the staged object is removed after expiry.", "type": "string" }, "logo": { "description": "A Rippling-owned logo URL for the custom site", "type": "string" }, "name": { "description": "The display name of the custom site", "type": "string" } }, "required": [ "api_name", "file_id", "name" ], "title": "SiteWriteRequest", "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Response/resource shape for a custom site.", "properties": { "admin_group_id": { "description": "The admin group id for the custom site", "type": "string" }, "api_name": { "description": "The unique api name of the custom site", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "created_by": { "description": "The ID of the role that created the custom site", "type": "string" }, "current_bundle_id": { "description": "The active bundle id for the custom site", "type": "string" }, "description": { "description": "The optional description of the custom site", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "logo": { "description": "A Rippling-owned logo URL for the custom site", "type": "string" }, "name": { "description": "The display name of the custom site", "type": "string" }, "viewer_group_id": { "description": "The viewer group id for the custom site", "type": "string" } }, "title": "Site", "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Create a new site", "x-rippling-entitlements": [ "Sites_Platform_API" ], "x-rippling-required-scopes": [ "sites.read-write" ] } }, "/sites/upload-batches/presign/": { "post": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/upload-batches-presign-sites" }, "operationId": "rippling.rest_api.upload_batches_presign_sites", "parameters": [ { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiSitePresignUploadBatchRequest569906f97a77" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OutputRestApiSiteStagedUploadBatchResponse2260ba5ee8b1" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Create a presigned staged upload batch", "x-rippling-entitlements": [ "Sites_Platform_API" ], "x-rippling-required-scopes": [ "sites.read-write" ] } }, "/sites/{api_name}/": { "delete": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/delete-sites" }, "operationId": "rippling.rest_api.delete_sites", "parameters": [ { "in": "path", "name": "api_name", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "204": { "description": "The resource was deleted successfully" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Delete a site", "x-rippling-entitlements": [ "Sites_Platform_API" ], "x-rippling-required-scopes": [ "sites.read-write" ] }, "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/get-sites" }, "operationId": "rippling.rest_api.get_sites", "parameters": [ { "in": "path", "name": "api_name", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "__meta": { "properties": { "redacted_fields": { "items": { "$ref": "#/components/schemas/OutputRestApiRedactedField21788a25ef22" }, "type": "array" } }, "type": "object" }, "admin_group_id": { "description": "The admin group id for the custom site", "type": "string" }, "api_name": { "description": "The unique api name of the custom site", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "created_by": { "description": "The ID of the role that created the custom site", "type": "string" }, "current_bundle_id": { "description": "The active bundle id for the custom site", "type": "string" }, "description": { "description": "The optional description of the custom site", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "logo": { "description": "A Rippling-owned logo URL for the custom site", "type": "string" }, "name": { "description": "The display name of the custom site", "type": "string" }, "viewer_group_id": { "description": "The viewer group id for the custom site", "type": "string" } }, "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Retrieve a specific site", "x-rippling-entitlements": [ "Sites_Platform_API" ], "x-rippling-required-scopes": [ "sites.read" ] }, "patch": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/update-sites" }, "operationId": "rippling.rest_api.update_sites", "parameters": [ { "in": "path", "name": "api_name", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiSiteWriteRequest62ccf03a4f5e" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Response/resource shape for a custom site.", "properties": { "admin_group_id": { "description": "The admin group id for the custom site", "type": "string" }, "api_name": { "description": "The unique api name of the custom site", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "created_by": { "description": "The ID of the role that created the custom site", "type": "string" }, "current_bundle_id": { "description": "The active bundle id for the custom site", "type": "string" }, "description": { "description": "The optional description of the custom site", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "logo": { "description": "A Rippling-owned logo URL for the custom site", "type": "string" }, "name": { "description": "The display name of the custom site", "type": "string" }, "viewer_group_id": { "description": "The viewer group id for the custom site", "type": "string" } }, "title": "Site", "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Update a site", "x-rippling-entitlements": [ "Sites_Platform_API" ], "x-rippling-required-scopes": [ "sites.read-write" ] } }, "/sites/{api_name}/file-operations/": { "post": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/file-operations-sites" }, "operationId": "rippling.rest_api.file_operations_sites", "parameters": [ { "in": "path", "name": "api_name", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiSiteFileOperationsRequest07e1ffd39219" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Response/resource shape for a custom site.", "properties": { "admin_group_id": { "description": "The admin group id for the custom site", "type": "string" }, "api_name": { "description": "The unique api name of the custom site", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "created_by": { "description": "The ID of the role that created the custom site", "type": "string" }, "current_bundle_id": { "description": "The active bundle id for the custom site", "type": "string" }, "description": { "description": "The optional description of the custom site", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "logo": { "description": "A Rippling-owned logo URL for the custom site", "type": "string" }, "name": { "description": "The display name of the custom site", "type": "string" }, "viewer_group_id": { "description": "The viewer group id for the custom site", "type": "string" } }, "title": "Site", "type": "object" } } }, "description": "Successful response" }, "409": { "description": "Conflict when base_bundle_id does not match the current active bundle", "x-rippling-source-response": { "content": { "application/json": { "example": { "current_bundle_id": "latest_bundle_id", "error": "base_bundle_id does not match current bundle" }, "schema": { "properties": { "current_bundle_id": { "type": "string" }, "error": { "type": "string" } }, "required": [ "error", "current_bundle_id" ], "type": "object" } } }, "description": "Conflict when base_bundle_id does not match the current active bundle" } } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Apply file operations to a site bundle", "x-rippling-entitlements": [ "Sites_Platform_API" ], "x-rippling-required-scopes": [ "sites.read-write" ] } }, "/sites/{api_name}/files/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/files-sites" }, "operationId": "rippling.rest_api.files_sites", "parameters": [ { "in": "path", "name": "api_name", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "parent_path", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "recursive", "required": false, "schema": { "type": "boolean" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OutputRestApiSiteFileListResponse500885ed9596" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "List files in the active bundle", "x-rippling-entitlements": [ "Sites_Platform_API" ], "x-rippling-required-scopes": [ "sites.read" ] } }, "/software-deployments/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/list-software-deployments" }, "operationId": "rippling.rest_api.list_software_deployments", "parameters": [ { "in": "query", "name": "filter", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "expand", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 100, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "__meta": { "$ref": "#/components/schemas/OutputRestApiRedactedFields9f7657dc2a2f" }, "next_link": { "description": "A link to the next page of responses.", "format": "uri", "type": "string" }, "results": { "items": { "$ref": "#/components/schemas/OutputRestApiSoftwareDeployment2f2360103426" }, "type": "array" } }, "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "List software deployments", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "software-deployments.read" ] }, "post": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/create-software-deployments" }, "operationId": "rippling.rest_api.create_software_deployments", "parameters": [ { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiSoftwareDeploymentRequest8e07af01b521" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "active_group_type": { "description": "Type of group targeting: 'Role' or 'Device'.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "group_id": { "description": "Group ID for role-based targeting. Required if active_group_type is 'Role'. Must be null if 'Device'.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_report_syncing_in_progress": { "description": "Whether installation report syncing is in progress. When true, deployment status may be temporarily inconsistent.", "type": "boolean" }, "ma_device_group_id": { "description": "Device group ID for device-based targeting. Required if active_group_type is 'Device'. Must be null if 'Role'.", "type": "string" }, "software": { "description": "The software being deployed. Expandable to get software name, icon, and metadata.\n\nExpandable field", "properties": { "available_platforms": { "description": "Platforms this software is available on (macOS, Windows, etc).", "items": { "type": "string" }, "type": "array" }, "category": { "description": "Category of the software.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "description": { "description": "Description of the software.", "type": "string" }, "display_name": { "description": "Custom display name for the software.", "type": "string" }, "icon_url": { "description": "URL for the software icon.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the software.", "type": "string" }, "scope": { "description": "Scope of the software (PUBLIC, CUSTOM, INTERNAL).", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "SFMSoftware", "type": "object" }, "software_id": { "description": "The ID of the software to deploy.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "software_id", "updated_at" ], "title": "SoftwareDeployment", "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Create a new software deployment", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "software-deployments.read-write" ] } }, "/software-deployments/{id}/": { "delete": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/delete-software-deployments" }, "operationId": "rippling.rest_api.delete_software_deployments", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "id", "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "204": { "description": "The resource was deleted successfully" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Delete a software deployment", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "software-deployments.read-write" ] }, "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/get-software-deployments" }, "operationId": "rippling.rest_api.get_software_deployments", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "id", "type": "string" } }, { "in": "query", "name": "expand", "required": false, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "__meta": { "properties": { "redacted_fields": { "items": { "$ref": "#/components/schemas/OutputRestApiRedactedField21788a25ef22" }, "type": "array" } }, "type": "object" }, "active_group_type": { "description": "Type of group targeting: 'Role' or 'Device'.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "group_id": { "description": "Group ID for role-based targeting. Required if active_group_type is 'Role'. Must be null if 'Device'.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_report_syncing_in_progress": { "description": "Whether installation report syncing is in progress. When true, deployment status may be temporarily inconsistent.", "type": "boolean" }, "ma_device_group_id": { "description": "Device group ID for device-based targeting. Required if active_group_type is 'Device'. Must be null if 'Role'.", "type": "string" }, "software": { "description": "The software being deployed. Expandable to get software name, icon, and metadata.\n\nExpandable field", "properties": { "available_platforms": { "description": "Platforms this software is available on (macOS, Windows, etc).", "items": { "type": "string" }, "type": "array" }, "category": { "description": "Category of the software.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "description": { "description": "Description of the software.", "type": "string" }, "display_name": { "description": "Custom display name for the software.", "type": "string" }, "icon_url": { "description": "URL for the software icon.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the software.", "type": "string" }, "scope": { "description": "Scope of the software (PUBLIC, CUSTOM, INTERNAL).", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "SFMSoftware", "type": "object" }, "software_id": { "description": "The ID of the software to deploy.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "software_id", "updated_at" ], "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Retrieve a specific software deployment", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "software-deployments.read" ] }, "patch": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/update-software-deployments" }, "operationId": "rippling.rest_api.update_software_deployments", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "id", "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiSoftwareDeploymentUpdateRequest5daff46e1b2c" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "active_group_type": { "description": "Type of group targeting: 'Role' or 'Device'.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "group_id": { "description": "Group ID for role-based targeting. Required if active_group_type is 'Role'. Must be null if 'Device'.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_report_syncing_in_progress": { "description": "Whether installation report syncing is in progress. When true, deployment status may be temporarily inconsistent.", "type": "boolean" }, "ma_device_group_id": { "description": "Device group ID for device-based targeting. Required if active_group_type is 'Device'. Must be null if 'Role'.", "type": "string" }, "software": { "description": "The software being deployed. Expandable to get software name, icon, and metadata.\n\nExpandable field", "properties": { "available_platforms": { "description": "Platforms this software is available on (macOS, Windows, etc).", "items": { "type": "string" }, "type": "array" }, "category": { "description": "Category of the software.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "description": { "description": "Description of the software.", "type": "string" }, "display_name": { "description": "Custom display name for the software.", "type": "string" }, "icon_url": { "description": "URL for the software icon.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the software.", "type": "string" }, "scope": { "description": "Scope of the software (PUBLIC, CUSTOM, INTERNAL).", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "SFMSoftware", "type": "object" }, "software_id": { "description": "The ID of the software to deploy.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "software_id", "updated_at" ], "title": "SoftwareDeployment", "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Update a software deployment", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "software-deployments.read-write" ] } }, "/spend-categories/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/list-spend-categories" }, "operationId": "rippling.rest_api.list_spend_categories", "parameters": [ { "in": "query", "name": "filter", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 100, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "__meta": { "$ref": "#/components/schemas/OutputRestApiRedactedFields9f7657dc2a2f" }, "next_link": { "description": "A link to the next page of responses.", "format": "uri", "type": "string" }, "results": { "items": { "$ref": "#/components/schemas/OutputRestApiCategoryd17181c72f24" }, "type": "array" } }, "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "List spend categories", "x-rippling-entitlements": [ "Internal_Testing" ], "x-rippling-required-scopes": [ "spend-categories.read" ] } }, "/spend-categories/{id}/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/get-spend-categories" }, "operationId": "rippling.rest_api.get_spend_categories", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "id", "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "__meta": { "properties": { "redacted_fields": { "items": { "$ref": "#/components/schemas/OutputRestApiRedactedField21788a25ef22" }, "type": "array" } }, "type": "object" }, "active": { "description": "Whether the category is active. Inactive categories remain available for historical references.", "type": "boolean" }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "Name of the Spend category.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Retrieve a specific spend category", "x-rippling-entitlements": [ "Internal_Testing" ], "x-rippling-required-scopes": [ "spend-categories.read" ] } }, "/spend-vendors/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/list-spend-vendors" }, "operationId": "rippling.rest_api.list_spend_vendors", "parameters": [ { "in": "query", "name": "filter", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 100, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "__meta": { "$ref": "#/components/schemas/OutputRestApiRedactedFields9f7657dc2a2f" }, "next_link": { "description": "A link to the next page of responses.", "format": "uri", "type": "string" }, "results": { "items": { "$ref": "#/components/schemas/OutputRestApiVendorResourcef5479c61c57f" }, "type": "array" } }, "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "List spend vendors", "x-rippling-entitlements": [ "Internal_Testing" ], "x-rippling-required-scopes": [ "spend-vendors.read" ] } }, "/spend-vendors/{id}/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/get-spend-vendors" }, "operationId": "rippling.rest_api.get_spend_vendors", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "id", "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "__meta": { "properties": { "redacted_fields": { "items": { "$ref": "#/components/schemas/OutputRestApiRedactedField21788a25ef22" }, "type": "array" } }, "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_archived": { "description": "Whether the vendor is archived. Archived vendors remain available for historical references.", "type": "boolean" }, "logo": { "description": "URL of the vendor's logo. Null when no logo is available.", "type": "string" }, "name": { "description": "Canonical name of the Spend vendor. Name eq, ne, and in filters also match alternate names.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Retrieve a specific spend vendor", "x-rippling-entitlements": [ "Internal_Testing" ], "x-rippling-required-scopes": [ "spend-vendors.read" ] } }, "/sso-me/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/list-sso-me" }, "operationId": "rippling.rest_api.list_sso_me", "parameters": [ { "in": "query", "name": "expand", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 100, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "company": { "description": "The company of the user.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "doing_business_as_name": { "description": "The doing business as name for the company.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_entities": { "description": "A list of the company's entities.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiLegalEntity9c4b5c98341c" }, "type": "array" }, "legal_entities_id": { "description": "A list of the company's entities.", "items": { "type": "string" }, "type": "array" }, "legal_name": { "description": "The legal name of the company.", "type": "string" }, "name": { "description": "The name of the company.", "type": "string" }, "parent_legal_entity": { "description": "The company's ultimate holding entity.\n\nExpandable field", "properties": { "company": { "$ref": "#/components/schemas/OutputRestCompany", "description": "The company or organization associated with the legal entity\n\nExpandable field", "type": "object" }, "company_id": { "description": "The company or organization associated with the legal entity", "type": "string" }, "country": { "description": "The country the legal entity is based in.", "properties": { "code": { "description": "The code of the country.", "type": "string" } }, "required": [ "code" ], "title": "Country", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "entity_level": { "description": "The legal entity's level in a hierarchy. * `PARENT`: The legal entity is considered the ultimate holding entity. * `SUBSIDIARY`: The legal entity is considered a subsidiary, fully or partially held by another. * `BRANCH`: The legal entity is considered a branch, associated with a parent legal entity.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_name": { "description": "The legal name of the legal entity.", "type": "string" }, "mailing_address": { "description": "The mailing address of the legal entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "management_type": { "description": "The legal entity management type in the case of an employer of record (EOR) or professional employment organization (PEO). * `PEO`: The legal entity is considered a Professional Employment Organization (PEO). * `EOR`: The legal entity is considered an Employer of Record (EOR).", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The parent legal entity.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent legal entity.", "type": "string" }, "physical_address": { "description": "The physical address of the legal entity, if it differs from the mailing address.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "registration_date": { "description": "The registration date of the entity.", "type": "string" }, "tax_identifier": { "description": "The tax identifier for the legal entity.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "LegalEntity", "type": "object" }, "parent_legal_entity_id": { "description": "The company's ultimate holding entity.", "type": "string" }, "phone": { "description": "The phone number for the company.", "type": "string" }, "physical_address": { "description": "The physical address of the holding entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "primary_email": { "description": "The email address used when registering this company.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "legal_entities", "legal_entities_id", "name", "updated_at" ], "title": "Company", "type": "object" }, "company_id": { "description": "The company ID of the user.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "work_email": { "description": "The user's work email address.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "SSOMe", "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Retrieve my SSO information", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "sso-me.read" ] } }, "/supergroups/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/list-supergroups" }, "operationId": "rippling.rest_api.list_supergroups", "parameters": [ { "in": "query", "name": "filter", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 100, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "__meta": { "$ref": "#/components/schemas/OutputRestApiRedactedFields9f7657dc2a2f" }, "next_link": { "description": "A link to the next page of responses.", "format": "uri", "type": "string" }, "results": { "items": { "$ref": "#/components/schemas/OutputRestApiSupergroup02a67f7960e9" }, "type": "array" } }, "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "List supergroups", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "supergroups.read" ] } }, "/supergroups/{group_id}/exclusion-members/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/list-supergroups-group-id-exclusion-members" }, "operationId": "rippling.rest_api.list_supergroups_group_id_exclusion_members", "parameters": [ { "in": "path", "name": "group_id", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "expand", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 100, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "__meta": { "$ref": "#/components/schemas/OutputRestApiRedactedFields9f7657dc2a2f" }, "next_link": { "description": "A link to the next page of responses.", "format": "uri", "type": "string" }, "results": { "items": { "$ref": "#/components/schemas/OutputRestApiGroupMember1b01a7ea9b9e" }, "type": "array" } }, "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "List supergroup exclusion members", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "supergroups.read" ] }, "patch": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/update-supergroups-group-id-exclusion-members" }, "operationId": "rippling.rest_api.update_supergroups_group_id_exclusion_members", "parameters": [ { "in": "path", "name": "group_id", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "Operations": { "items": { "properties": { "op": { "description": "add or remove", "type": "string" }, "value": { "description": "The members to add or remove.", "items": { "properties": { "id": { "description": "A member id.", "type": "string" } }, "type": "object" }, "type": "array" } }, "type": "object" }, "type": "array" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "ok": { "description": "Whether the operation succeeded.", "type": "boolean" } }, "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Update supergroup exclusion members", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "supergroups.read-write" ] } }, "/supergroups/{group_id}/inclusion-members/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/list-supergroups-group-id-inclusion-members" }, "operationId": "rippling.rest_api.list_supergroups_group_id_inclusion_members", "parameters": [ { "in": "path", "name": "group_id", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "expand", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 100, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "__meta": { "$ref": "#/components/schemas/OutputRestApiRedactedFields9f7657dc2a2f" }, "next_link": { "description": "A link to the next page of responses.", "format": "uri", "type": "string" }, "results": { "items": { "$ref": "#/components/schemas/OutputRestApiGroupMember1b01a7ea9b9e" }, "type": "array" } }, "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "List supergroup inclusion members", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "supergroups.read" ] }, "patch": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/update-supergroups-group-id-inclusion-members" }, "operationId": "rippling.rest_api.update_supergroups_group_id_inclusion_members", "parameters": [ { "in": "path", "name": "group_id", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "Operations": { "items": { "properties": { "op": { "description": "add or remove", "type": "string" }, "value": { "description": "The members to add or remove.", "items": { "properties": { "id": { "description": "A member id.", "type": "string" } }, "type": "object" }, "type": "array" } }, "type": "object" }, "type": "array" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "ok": { "description": "Whether the operation succeeded.", "type": "boolean" } }, "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Update supergroup inclusion members", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "supergroups.read-write" ] } }, "/supergroups/{group_id}/members/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/list-supergroups-group-id-members" }, "operationId": "rippling.rest_api.list_supergroups_group_id_members", "parameters": [ { "in": "path", "name": "group_id", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "expand", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 100, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "__meta": { "$ref": "#/components/schemas/OutputRestApiRedactedFields9f7657dc2a2f" }, "next_link": { "description": "A link to the next page of responses.", "format": "uri", "type": "string" }, "results": { "items": { "$ref": "#/components/schemas/OutputRestApiGroupMember1b01a7ea9b9e" }, "type": "array" } }, "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "List supergroup members", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "supergroups.read" ] } }, "/supergroups/{id}/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/get-supergroups" }, "operationId": "rippling.rest_api.get_supergroups", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "id", "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "__meta": { "properties": { "redacted_fields": { "items": { "$ref": "#/components/schemas/OutputRestApiRedactedField21788a25ef22" }, "type": "array" } }, "type": "object" }, "allow_non_employees": { "description": "Whether the group allows non employees", "type": "boolean" }, "app_owner_id": { "description": "The id of the group's app owner.", "type": "string" }, "can_override_role_states": { "description": "Whether the group can override role states", "type": "boolean" }, "created_at": { "description": "Record creation date", "type": "string" }, "cumulatively_exhaustive_default": { "description": "Whether the group is the cumulatively exhaustive default", "type": "boolean" }, "description": { "description": "The group's description.", "type": "string" }, "display_name": { "description": "The group's display name.", "type": "string" }, "group_type": { "description": "The group type", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "ignore_prov_group_matching": { "description": "Whether to ignore provisioning group matching when determining group membership", "type": "boolean" }, "include_terminated": { "description": "Whether the group include terminated roles", "type": "boolean" }, "is_invisible": { "description": "Whether the group is invisible", "type": "boolean" }, "mutually_exclusive_key": { "description": "The group's mutually exclusive key", "type": "string" }, "name": { "description": "The group's name.", "type": "string" }, "parent": { "description": "The group's parent.", "type": "string" }, "priority": { "anyOf": [ { "description": "The group's priority when calculating mutual exclusivity", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "read_only": { "description": "Whether the group is read only.", "type": "boolean" }, "sub_group_type": { "description": "The sub group type", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Retrieve a specific supergroup", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "supergroups.read" ] } }, "/teams/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/list-teams" }, "operationId": "rippling.rest_api.list_teams", "parameters": [ { "in": "query", "name": "expand", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 100, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "__meta": { "$ref": "#/components/schemas/OutputRestApiRedactedFields9f7657dc2a2f" }, "next_link": { "description": "A link to the next page of responses.", "format": "uri", "type": "string" }, "results": { "items": { "$ref": "#/components/schemas/OutputRestApiTeamcb26bc28f32f" }, "type": "array" } }, "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "List teams", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "teams.read" ] }, "post": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/create-teams" }, "operationId": "rippling.rest_api.create_teams", "parameters": [ { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiTeamRequest30691743f0d2" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the team.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestTeam", "description": "The parent team\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent team", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Team", "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Create a new team", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "teams.read-write" ] } }, "/teams/{id}/": { "delete": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/delete-teams" }, "operationId": "rippling.rest_api.delete_teams", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "id", "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "204": { "description": "The resource was deleted successfully" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Delete a team", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "teams.read-write" ] }, "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/get-teams" }, "operationId": "rippling.rest_api.get_teams", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "id", "type": "string" } }, { "in": "query", "name": "expand", "required": false, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "__meta": { "properties": { "redacted_fields": { "items": { "$ref": "#/components/schemas/OutputRestApiRedactedField21788a25ef22" }, "type": "array" } }, "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the team.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestTeam", "description": "The parent team\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent team", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Retrieve a specific team", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "teams.read" ] }, "patch": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/update-teams" }, "operationId": "rippling.rest_api.update_teams", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "id", "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiTeamUpdateRequest853d6d6a14ca" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the team.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestTeam", "description": "The parent team\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent team", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Team", "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Update a team", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "teams.read-write" ] } }, "/time-cards/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/list-time-cards" }, "operationId": "rippling.rest_api.list_time_cards", "parameters": [ { "in": "query", "name": "filter", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "expand", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 100, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "__meta": { "$ref": "#/components/schemas/OutputRestApiRedactedFields9f7657dc2a2f" }, "next_link": { "description": "A link to the next page of responses.", "format": "uri", "type": "string" }, "results": { "items": { "$ref": "#/components/schemas/OutputRestApiTimeCard1831ec89697c" }, "type": "array" } }, "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "List time cards", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "time-cards.read" ] } }, "/time-cards/{id}/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/get-time-cards" }, "operationId": "rippling.rest_api.get_time_cards", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "id", "type": "string" } }, { "in": "query", "name": "expand", "required": false, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "__meta": { "properties": { "redacted_fields": { "items": { "$ref": "#/components/schemas/OutputRestApiRedactedField21788a25ef22" }, "type": "array" } }, "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "pay_period": { "description": "The pay period associated with the time card.", "properties": { "end_date": { "description": "The end date of the pay period.", "type": "string" }, "pay_schedule_id": { "description": "The ID of the pay schedule associated with the pay period.", "type": "string" }, "start_date": { "description": "The start date of the pay period.", "type": "string" } }, "title": "PayPeriod", "type": "object" }, "summary": { "description": "The summary of the time card.", "properties": { "approved_hours": { "anyOf": [ { "description": "The approved hours for the pay period.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "double_overtime_hours": { "anyOf": [ { "description": "The total number of doubletime hours worked during the pay period.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "earnings": { "anyOf": [ { "description": "The earnings for the pay period.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "hours_worked_by_job_code": { "description": "The amount of hours worked for each job code for the pay period.", "items": { "$ref": "#/components/schemas/OutputRestApiJobCodeSummary73cdc3312543" }, "type": "array" }, "overtime_hours": { "anyOf": [ { "description": "The total number of overtime hours worked during the pay period.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "paid_hours": { "anyOf": [ { "description": "The paid hours for the pay period.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "premiums": { "anyOf": [ { "description": "The premiums for the pay period.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "regular_hours": { "anyOf": [ { "description": "The total number of regular hours worked during the pay period.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "total_holiday_hours": { "anyOf": [ { "description": "The total holiday hours for the pay period.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "total_hours": { "anyOf": [ { "description": "The total hours for the pay period.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "total_paid_time_off_hours": { "anyOf": [ { "description": "The total paid time off hours for the pay period.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "total_unpaid_time_off_hours": { "anyOf": [ { "description": "The total unpaid time off hours for the pay period.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "unpaid_break_hours_by_entry": { "anyOf": [ { "description": "The map of time entry to unpaidBreakHours in seconds", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "TimeCardSummary", "type": "object" }, "updated_at": { "description": "Record update date", "type": "string" }, "worker": { "description": "The worker associated with the time card.\n\nExpandable field", "properties": { "business_partners": { "description": "Worker's assigned business partners. This field is only populated when explicitly requested via the expand parameter (e.g., ?expand=business_partners). When expanded, returns an empty list ([]) if the worker has no business partners.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiBusinessPartner77b00a069c32" }, "type": "array" }, "business_partners_id": { "description": "Worker's assigned business partners unique identifiers. Returns an empty list ([]) if the worker has no business partners.", "items": { "type": "string" }, "type": "array" }, "citizenship": { "description": "The countries that the worker has citizenship in.", "type": "string" }, "compensation": { "description": "The compensation package for the worker.\n\nExpandable field", "properties": { "annual_compensation": { "description": "The worker's annual compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "annual_salary_equivalent": { "description": "The worker's annual salary equivalent, for insurance purposes. It will be equal to the worker's annual compensation, except for owners that are receiving no cashcompensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "bonus_schedule": { "description": "The worker's bonus schedule.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "hourly_wage": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "id": { "description": "Identifier field", "type": "string" }, "monthly_compensation": { "description": "The worker's monthly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "on_target_commission": { "description": "The worker's on-target commission.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "payment_terms": { "description": "The payment terms for an worker's compensation.", "type": "string" }, "payment_type": { "description": "The payment type for an worker's compensation.", "type": "string" }, "relocation_reimbursement": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "salary_effective_date": { "description": "Salary effective date", "type": "string" }, "signing_bonus": { "description": "The worker's signing bonus.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus": { "description": "The worker's target annual bonus amount.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus_percent": { "anyOf": [ { "description": "The worker's target annual bonus as a percent of annual compensation.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" }, "weekly_compensation": { "description": "The worker's weekly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "worker": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's details.\n\nExpandable field", "type": "object" }, "worker_id": { "description": "The worker's ID.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Compensation", "type": "object" }, "compensation_grade": { "description": "The compensation grade assigned to the worker, if any.", "properties": { "id": { "description": "The compensation grade's unique identifier.", "type": "string" }, "label": { "description": "The compensation grade's label.", "type": "string" } }, "title": "WorkerCompensationGrade", "type": "object" }, "compensation_id": { "description": "The compensation package for the worker.", "type": "string" }, "country": { "description": "The worker's country.", "type": "string" }, "country_fields": { "description": "Country level fields for the worker.", "properties": { "ca": { "description": "Country-wise regional fields for Canada", "properties": { "sin": { "description": "Social Insurance Number (SIN) for Canada employees.", "type": "string" } }, "title": "CanadaFields", "type": "object" }, "nz": { "description": "Country-wise regional fields for New Zealand", "properties": { "ird_number": { "description": "Inland Revenue Department (IRD) number for New Zealand employees.", "type": "string" } }, "title": "NewZealandFields", "type": "object" }, "us": { "description": "Country-wise regional fields for USA", "properties": { "ssn": { "description": "Social Security Number (SSN) for US employees.", "type": "string" } }, "title": "USFields", "type": "object" } }, "title": "CountryFields", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "custom_fields": { "description": "Custom field values defined on the Employee object for this worker\n\nExpandable field", "items": { "additionalProperties": {} }, "type": "array" }, "date_of_birth": { "description": "The worker's date of birth.", "type": "string" }, "department": { "description": "The worker's assigned department.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "department_hierarchy": { "description": "List of departments in the department hierarchy. Refer department_hierarchy_ids for department hierarchy order.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestDepartment" }, "type": "array" }, "department_hierarchy_id": { "description": "The identifier of departments in the department hierarchy ordered from parent department to child department.", "items": { "type": "string" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the department.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestDepartment", "description": "The parent department.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent department.", "type": "string" }, "reference_code": { "description": "Reference code of the department.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Department", "type": "object" }, "department_id": { "description": "The worker's assigned department.", "type": "string" }, "employment_type": { "description": "The worker's employment type.\n\nExpandable field", "properties": { "amount_worked": { "description": "The amount worked for the employment type. * `FULL-TIME`: Full-time is at least 30 hours per week. Full-time workers will typically be eligible for benefits. * `PART-TIME`: Part-time is less than 30 hours per week. These workers may be eligible for benefits, depending on company settings and hours worked. * `TEMPORARY`: These workers are hired on a temporary basis. You can specify how each worker with this employment type will be paid individually.", "type": "string" }, "compensation_time_period": { "description": "The compensation period for the employment type. * `SALARIED`: Employees that are paid a fixed amount per year. * `HOURLY`: Employees that are paid a wage per hour worked.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "label": { "description": "The display label of the employment type.", "type": "string" }, "name": { "description": "The name of the employment type for non-custom employment types.", "type": "string" }, "type": { "description": "The classification of the worker by the company. * `CONTRACTOR`: Contractors are self-employed workers who provide services on a short-term or per-project basis and are not eligible for tax-withholding or benefits. * `EMPLOYEE`: Employees are hired and managed by an employer, work under the employer's direct supervision and control, and are protected by law for wages and employment rights.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "label", "updated_at" ], "title": "CompanyEmploymentType", "type": "object" }, "employment_type_id": { "description": "The worker's employment type.", "type": "string" }, "end_date": { "description": "The end date of the worker.", "type": "string" }, "ethnicity": { "description": "The identified ethnicity of the worker, if specified.", "type": "string" }, "gender": { "description": "The gender of the worker, if specified.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_manager": { "description": "Whether the worker is a manager", "type": "boolean" }, "job_function": { "description": "The worker's job function. When expanded, this field requires `job-functions.read`.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "Displayed name of the job function", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "JobFunction", "type": "object" }, "job_function_id": { "description": "ID of the worker's job function.", "type": "string" }, "legal_entity": { "description": "The worker's associated legal entity.\n\nExpandable field", "properties": { "company": { "description": "The company or organization associated with the legal entity\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "doing_business_as_name": { "description": "The doing business as name for the company.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_entities": { "description": "A list of the company's entities.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestLegalEntity" }, "type": "array" }, "legal_entities_id": { "description": "A list of the company's entities.", "items": { "type": "string" }, "type": "array" }, "legal_name": { "description": "The legal name of the company.", "type": "string" }, "name": { "description": "The name of the company.", "type": "string" }, "parent_legal_entity": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The company's ultimate holding entity.\n\nExpandable field", "type": "object" }, "parent_legal_entity_id": { "description": "The company's ultimate holding entity.", "type": "string" }, "phone": { "description": "The phone number for the company.", "type": "string" }, "physical_address": { "description": "The physical address of the holding entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "primary_email": { "description": "The email address used when registering this company.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "legal_entities", "legal_entities_id", "name", "updated_at" ], "title": "Company", "type": "object" }, "company_id": { "description": "The company or organization associated with the legal entity", "type": "string" }, "country": { "description": "The country the legal entity is based in.", "properties": { "code": { "description": "The code of the country.", "type": "string" } }, "required": [ "code" ], "title": "Country", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "entity_level": { "description": "The legal entity's level in a hierarchy. * `PARENT`: The legal entity is considered the ultimate holding entity. * `SUBSIDIARY`: The legal entity is considered a subsidiary, fully or partially held by another. * `BRANCH`: The legal entity is considered a branch, associated with a parent legal entity.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_name": { "description": "The legal name of the legal entity.", "type": "string" }, "mailing_address": { "description": "The mailing address of the legal entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "management_type": { "description": "The legal entity management type in the case of an employer of record (EOR) or professional employment organization (PEO). * `PEO`: The legal entity is considered a Professional Employment Organization (PEO). * `EOR`: The legal entity is considered an Employer of Record (EOR).", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The parent legal entity.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent legal entity.", "type": "string" }, "physical_address": { "description": "The physical address of the legal entity, if it differs from the mailing address.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "registration_date": { "description": "The registration date of the entity.", "type": "string" }, "tax_identifier": { "description": "The tax identifier for the legal entity.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "LegalEntity", "type": "object" }, "legal_entity_id": { "description": "The worker's associated legal entity.", "type": "string" }, "level": { "description": "The level of the worker.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "description": { "description": "The description of the level.", "type": "string" }, "experience_requirements": { "description": "The experience requirements for the level.", "type": "string" }, "global_level": { "anyOf": [ { "description": "Global level is used to track the seniority of levels. The higher up a level is placed on the page, the more senior and higher-ranked the level. Global level is used in workflows, policies, and reports that use the level attribute (e.g., you can use Level Lookup to set up a workflow that notifies the nearest person in an worker's management chain at or above the specified level).", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the level. Must be unique within the company or organization.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLevel", "description": "The parent level.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent level.", "type": "string" }, "rank": { "anyOf": [ { "description": "The rank of the level within its track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "scope_of_responsibilities": { "description": "The scope of responsibilities for the level.", "type": "string" }, "track": { "description": "The track associated with the level, if it's not a global level.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_default": { "description": "Whether this is the company's default track.", "type": "boolean" }, "name": { "description": "The name of the track. Must be unique within the company or organization.", "type": "string" }, "order": { "anyOf": [ { "description": "The one-based horizontal display order of the track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "start_global_level": { "anyOf": [ { "description": "The highest global level occupied by this track. Empty tracks return null.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Track", "type": "object" }, "track_id": { "description": "The track associated with the level. Required during creation. Include global_level when changing it.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Level", "type": "object" }, "level_id": { "description": "The level of the worker.", "type": "string" }, "location": { "description": "The location that the worker is mapped to for tax purposes. In the case that a worker is remote, the location's type is remote.", "properties": { "type": { "description": "The type of location.", "type": "string" }, "work_location_id": { "description": "The work location, if the worker isn't remote.", "type": "string" } }, "required": [ "type", "work_location_id" ], "title": "WorkerLocation", "type": "object" }, "manager": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's manager.\n\nExpandable field", "type": "object" }, "manager_id": { "description": "The worker's manager.", "type": "string" }, "number": { "anyOf": [ { "description": "The worker's number within the organization.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "original_start_date": { "description": "The worker's earliest start date across their employment history, excluding INIT roles.", "type": "string" }, "overtime_exemption": { "description": "The worker's overtime exemption status.", "type": "string" }, "pay_schedule_id": { "description": "The ID of the pay schedule currently associated with the worker.", "type": "string" }, "personal_email": { "description": "The worker's associated personal email address.", "type": "string" }, "race": { "description": "The identified race of the worker, if specified.", "type": "string" }, "start_date": { "description": "The start date of the worker.", "type": "string" }, "status": { "description": "The worker's status within the organization.", "type": "string" }, "teams": { "description": "The worker's assigned teams.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiTeamcb26bc28f32f" }, "type": "array" }, "teams_id": { "description": "The worker's assigned teams.", "items": { "type": "string" }, "type": "array" }, "termination_details": { "description": "The details of the worker's termination, if applicable.", "properties": { "reason": { "description": "This is a description that will be custom to each Rippling company.", "type": "string" }, "type": { "description": "The termination type indicates whether the termination was voluntary or involuntary.", "type": "string" } }, "title": "TerminationDetails", "type": "object" }, "title": { "description": "The worker's title.", "type": "string" }, "title_effective_date": { "description": "Title effective date", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "user": { "description": "The worker's associated user.\n\nExpandable field", "properties": { "active": { "description": "Whether the user is able to access company resources, typically when they are in actively engaged with the company and not after off-boarding.", "type": "boolean" }, "addresses": { "description": "The user's addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiUserAddressedd59b9ba9a1" }, "type": "array" }, "created_at": { "description": "Record creation date", "type": "string" }, "display_name": { "description": "The display name of the user using either the concatenated preferred given and family name or username depending on availability.", "type": "string" }, "emails": { "description": "The user's email addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiEmail5284c8258dc3" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "locale": { "description": "The User's default location for purposes of localization of currency, date time format, or numerical representations pursuant to RFC5646.", "type": "string" }, "name": { "description": "The user's name.", "properties": { "family_name": { "description": "The legal family name of the user, or last name in most Western languages.", "type": "string" }, "formatted": { "description": "The user's full name.", "type": "string" }, "given_name": { "description": "The given legal name of the user, or first name in most Western languages.", "type": "string" }, "middle_name": { "description": "The middle name(s) of the user.", "type": "string" }, "preferred_family_name": { "description": "The preferred family name, or last name in most Western languages, by the user.", "type": "string" }, "preferred_given_name": { "description": "The preferred given name, or first name in most Western languages, by the user.", "type": "string" } }, "title": "UserName", "type": "object" }, "number": { "description": "The permanent profile number of the user.", "type": "string" }, "phone_numbers": { "description": "The user's phone numbers.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoneNumber12060c61ecf5" }, "type": "array" }, "photos": { "description": "The user's photos.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoto2be7c3ae3f39" }, "type": "array" }, "preferred_language": { "description": "The User's preferred written or spoken language in the same format of the HTTP Accept-Language header, pursuant to Section 5.3.5 of RFC7231.", "type": "string" }, "timezone": { "description": "The User's current time zone in IANA database Olson format", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "username": { "description": "The unique identifier across Rippling used by the User for direct authentication into their associated company. Globally unique.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "User", "type": "object" }, "user_id": { "description": "The worker's associated user.", "type": "string" }, "work_email": { "description": "The worker's associated work email address.", "type": "string" }, "work_schedule": { "additionalProperties": { "$ref": "#/components/schemas/OutputRestApiWorkScheduleDay938f88d94f20" }, "description": "The worker's scheduled working hours for each day of the week.", "type": "object" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Worker", "type": "object" }, "worker_id": { "description": "The ID of the worker associated with the time card.", "type": "string" } }, "required": [ "created_at", "id", "updated_at", "worker_id" ], "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Retrieve a specific time card", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "time-cards.read" ] } }, "/time-entries/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/list-time-entries" }, "operationId": "rippling.rest_api.list_time_entries", "parameters": [ { "in": "query", "name": "filter", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "expand", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 100, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "__meta": { "$ref": "#/components/schemas/OutputRestApiRedactedFields9f7657dc2a2f" }, "next_link": { "description": "A link to the next page of responses.", "format": "uri", "type": "string" }, "results": { "items": { "$ref": "#/components/schemas/OutputRestApiTimeEntryc217c7a2a3ac" }, "type": "array" } }, "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "List time entries", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "time-entries.read" ] }, "post": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/create-time-entries" }, "operationId": "rippling.rest_api.create_time_entries", "parameters": [ { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiTimeEntryRequeste575cc21e300" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "breaks": { "description": "The breaks taken during the time entry.", "items": { "$ref": "#/components/schemas/OutputRestApiBreak50f807167b82" }, "type": "array" }, "comments": { "description": "The comments associated with the time entry.", "items": { "$ref": "#/components/schemas/OutputRestApiTimeEntryCommente521151255bf" }, "type": "array" }, "create_extra_hours_run": { "description": "Whether the time entry should create an extra hours run.", "type": "boolean" }, "created_at": { "description": "Record creation date", "type": "string" }, "end_time": { "description": "The end time of the time entry.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "idempotency_key": { "description": "The unique key of the time entry in an outside system. If set, no other time entry with the same key can be created.", "type": "string" }, "job_shifts": { "description": "The job shifts worked during the time entry.", "items": { "$ref": "#/components/schemas/OutputRestApiJobShift87137d8a0daa" }, "type": "array" }, "pay_period": { "description": "The pay period associated with the time card.", "properties": { "end_date": { "description": "The end date of the pay period.", "type": "string" }, "pay_schedule_id": { "description": "The ID of the pay schedule associated with the pay period.", "type": "string" }, "start_date": { "description": "The start date of the pay period.", "type": "string" } }, "title": "PayPeriod", "type": "object" }, "piece_rate_premiums": { "description": "The piece-rate premiums earned during the time entry.", "items": { "$ref": "#/components/schemas/OutputRestApiPieceRatePremiumsd68380854608" }, "type": "array" }, "premiums": { "description": "The premiums earned during the time entry.", "items": { "$ref": "#/components/schemas/OutputRestApiPremiumsecd81efd722e" }, "type": "array" }, "segments": { "description": "The pay rates for each segment of the time entry.", "items": { "$ref": "#/components/schemas/OutputRestApiSegmentse33b0ae25a0a" }, "type": "array" }, "shift_input_values": { "description": "Arbitrary shift inputs collected on the time entry", "items": { "$ref": "#/components/schemas/OutputRestApiShiftInputValued170635510cb" }, "type": "array" }, "start_time": { "description": "The start time of the time entry.", "type": "string" }, "status": { "description": "The status of the time entry.", "type": "string" }, "tags": { "description": "The tags associated with the time entry.", "items": { "type": "string" }, "type": "array" }, "time_card": { "description": "The time card associated with the time entry.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "pay_period": { "description": "The pay period associated with the time card.", "properties": { "end_date": { "description": "The end date of the pay period.", "type": "string" }, "pay_schedule_id": { "description": "The ID of the pay schedule associated with the pay period.", "type": "string" }, "start_date": { "description": "The start date of the pay period.", "type": "string" } }, "title": "PayPeriod", "type": "object" }, "summary": { "description": "The summary of the time card.", "properties": { "approved_hours": { "anyOf": [ { "description": "The approved hours for the pay period.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "double_overtime_hours": { "anyOf": [ { "description": "The total number of doubletime hours worked during the pay period.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "earnings": { "anyOf": [ { "description": "The earnings for the pay period.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "hours_worked_by_job_code": { "description": "The amount of hours worked for each job code for the pay period.", "items": { "$ref": "#/components/schemas/OutputRestApiJobCodeSummary73cdc3312543" }, "type": "array" }, "overtime_hours": { "anyOf": [ { "description": "The total number of overtime hours worked during the pay period.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "paid_hours": { "anyOf": [ { "description": "The paid hours for the pay period.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "premiums": { "anyOf": [ { "description": "The premiums for the pay period.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "regular_hours": { "anyOf": [ { "description": "The total number of regular hours worked during the pay period.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "total_holiday_hours": { "anyOf": [ { "description": "The total holiday hours for the pay period.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "total_hours": { "anyOf": [ { "description": "The total hours for the pay period.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "total_paid_time_off_hours": { "anyOf": [ { "description": "The total paid time off hours for the pay period.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "total_unpaid_time_off_hours": { "anyOf": [ { "description": "The total unpaid time off hours for the pay period.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "unpaid_break_hours_by_entry": { "anyOf": [ { "description": "The map of time entry to unpaidBreakHours in seconds", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "TimeCardSummary", "type": "object" }, "updated_at": { "description": "Record update date", "type": "string" }, "worker": { "description": "The worker associated with the time card.\n\nExpandable field", "properties": { "business_partners": { "description": "Worker's assigned business partners. This field is only populated when explicitly requested via the expand parameter (e.g., ?expand=business_partners). When expanded, returns an empty list ([]) if the worker has no business partners.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiBusinessPartner77b00a069c32" }, "type": "array" }, "business_partners_id": { "description": "Worker's assigned business partners unique identifiers. Returns an empty list ([]) if the worker has no business partners.", "items": { "type": "string" }, "type": "array" }, "citizenship": { "description": "The countries that the worker has citizenship in.", "type": "string" }, "compensation": { "description": "The compensation package for the worker.\n\nExpandable field", "properties": { "annual_compensation": { "description": "The worker's annual compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "annual_salary_equivalent": { "description": "The worker's annual salary equivalent, for insurance purposes. It will be equal to the worker's annual compensation, except for owners that are receiving no cashcompensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "bonus_schedule": { "description": "The worker's bonus schedule.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "hourly_wage": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "id": { "description": "Identifier field", "type": "string" }, "monthly_compensation": { "description": "The worker's monthly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "on_target_commission": { "description": "The worker's on-target commission.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "payment_terms": { "description": "The payment terms for an worker's compensation.", "type": "string" }, "payment_type": { "description": "The payment type for an worker's compensation.", "type": "string" }, "relocation_reimbursement": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "salary_effective_date": { "description": "Salary effective date", "type": "string" }, "signing_bonus": { "description": "The worker's signing bonus.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus": { "description": "The worker's target annual bonus amount.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus_percent": { "anyOf": [ { "description": "The worker's target annual bonus as a percent of annual compensation.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" }, "weekly_compensation": { "description": "The worker's weekly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "worker": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's details.\n\nExpandable field", "type": "object" }, "worker_id": { "description": "The worker's ID.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Compensation", "type": "object" }, "compensation_grade": { "description": "The compensation grade assigned to the worker, if any.", "properties": { "id": { "description": "The compensation grade's unique identifier.", "type": "string" }, "label": { "description": "The compensation grade's label.", "type": "string" } }, "title": "WorkerCompensationGrade", "type": "object" }, "compensation_id": { "description": "The compensation package for the worker.", "type": "string" }, "country": { "description": "The worker's country.", "type": "string" }, "country_fields": { "description": "Country level fields for the worker.", "properties": { "ca": { "description": "Country-wise regional fields for Canada", "properties": { "sin": { "description": "Social Insurance Number (SIN) for Canada employees.", "type": "string" } }, "title": "CanadaFields", "type": "object" }, "nz": { "description": "Country-wise regional fields for New Zealand", "properties": { "ird_number": { "description": "Inland Revenue Department (IRD) number for New Zealand employees.", "type": "string" } }, "title": "NewZealandFields", "type": "object" }, "us": { "description": "Country-wise regional fields for USA", "properties": { "ssn": { "description": "Social Security Number (SSN) for US employees.", "type": "string" } }, "title": "USFields", "type": "object" } }, "title": "CountryFields", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "custom_fields": { "description": "Custom field values defined on the Employee object for this worker\n\nExpandable field", "items": { "additionalProperties": {} }, "type": "array" }, "date_of_birth": { "description": "The worker's date of birth.", "type": "string" }, "department": { "description": "The worker's assigned department.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "department_hierarchy": { "description": "List of departments in the department hierarchy. Refer department_hierarchy_ids for department hierarchy order.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestDepartment" }, "type": "array" }, "department_hierarchy_id": { "description": "The identifier of departments in the department hierarchy ordered from parent department to child department.", "items": { "type": "string" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the department.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestDepartment", "description": "The parent department.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent department.", "type": "string" }, "reference_code": { "description": "Reference code of the department.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Department", "type": "object" }, "department_id": { "description": "The worker's assigned department.", "type": "string" }, "employment_type": { "description": "The worker's employment type.\n\nExpandable field", "properties": { "amount_worked": { "description": "The amount worked for the employment type. * `FULL-TIME`: Full-time is at least 30 hours per week. Full-time workers will typically be eligible for benefits. * `PART-TIME`: Part-time is less than 30 hours per week. These workers may be eligible for benefits, depending on company settings and hours worked. * `TEMPORARY`: These workers are hired on a temporary basis. You can specify how each worker with this employment type will be paid individually.", "type": "string" }, "compensation_time_period": { "description": "The compensation period for the employment type. * `SALARIED`: Employees that are paid a fixed amount per year. * `HOURLY`: Employees that are paid a wage per hour worked.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "label": { "description": "The display label of the employment type.", "type": "string" }, "name": { "description": "The name of the employment type for non-custom employment types.", "type": "string" }, "type": { "description": "The classification of the worker by the company. * `CONTRACTOR`: Contractors are self-employed workers who provide services on a short-term or per-project basis and are not eligible for tax-withholding or benefits. * `EMPLOYEE`: Employees are hired and managed by an employer, work under the employer's direct supervision and control, and are protected by law for wages and employment rights.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "label", "updated_at" ], "title": "CompanyEmploymentType", "type": "object" }, "employment_type_id": { "description": "The worker's employment type.", "type": "string" }, "end_date": { "description": "The end date of the worker.", "type": "string" }, "ethnicity": { "description": "The identified ethnicity of the worker, if specified.", "type": "string" }, "gender": { "description": "The gender of the worker, if specified.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_manager": { "description": "Whether the worker is a manager", "type": "boolean" }, "job_function": { "description": "The worker's job function. When expanded, this field requires `job-functions.read`.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "Displayed name of the job function", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "JobFunction", "type": "object" }, "job_function_id": { "description": "ID of the worker's job function.", "type": "string" }, "legal_entity": { "description": "The worker's associated legal entity.\n\nExpandable field", "properties": { "company": { "description": "The company or organization associated with the legal entity\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "doing_business_as_name": { "description": "The doing business as name for the company.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_entities": { "description": "A list of the company's entities.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestLegalEntity" }, "type": "array" }, "legal_entities_id": { "description": "A list of the company's entities.", "items": { "type": "string" }, "type": "array" }, "legal_name": { "description": "The legal name of the company.", "type": "string" }, "name": { "description": "The name of the company.", "type": "string" }, "parent_legal_entity": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The company's ultimate holding entity.\n\nExpandable field", "type": "object" }, "parent_legal_entity_id": { "description": "The company's ultimate holding entity.", "type": "string" }, "phone": { "description": "The phone number for the company.", "type": "string" }, "physical_address": { "description": "The physical address of the holding entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "primary_email": { "description": "The email address used when registering this company.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "legal_entities", "legal_entities_id", "name", "updated_at" ], "title": "Company", "type": "object" }, "company_id": { "description": "The company or organization associated with the legal entity", "type": "string" }, "country": { "description": "The country the legal entity is based in.", "properties": { "code": { "description": "The code of the country.", "type": "string" } }, "required": [ "code" ], "title": "Country", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "entity_level": { "description": "The legal entity's level in a hierarchy. * `PARENT`: The legal entity is considered the ultimate holding entity. * `SUBSIDIARY`: The legal entity is considered a subsidiary, fully or partially held by another. * `BRANCH`: The legal entity is considered a branch, associated with a parent legal entity.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_name": { "description": "The legal name of the legal entity.", "type": "string" }, "mailing_address": { "description": "The mailing address of the legal entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "management_type": { "description": "The legal entity management type in the case of an employer of record (EOR) or professional employment organization (PEO). * `PEO`: The legal entity is considered a Professional Employment Organization (PEO). * `EOR`: The legal entity is considered an Employer of Record (EOR).", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The parent legal entity.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent legal entity.", "type": "string" }, "physical_address": { "description": "The physical address of the legal entity, if it differs from the mailing address.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "registration_date": { "description": "The registration date of the entity.", "type": "string" }, "tax_identifier": { "description": "The tax identifier for the legal entity.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "LegalEntity", "type": "object" }, "legal_entity_id": { "description": "The worker's associated legal entity.", "type": "string" }, "level": { "description": "The level of the worker.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "description": { "description": "The description of the level.", "type": "string" }, "experience_requirements": { "description": "The experience requirements for the level.", "type": "string" }, "global_level": { "anyOf": [ { "description": "Global level is used to track the seniority of levels. The higher up a level is placed on the page, the more senior and higher-ranked the level. Global level is used in workflows, policies, and reports that use the level attribute (e.g., you can use Level Lookup to set up a workflow that notifies the nearest person in an worker's management chain at or above the specified level).", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the level. Must be unique within the company or organization.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLevel", "description": "The parent level.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent level.", "type": "string" }, "rank": { "anyOf": [ { "description": "The rank of the level within its track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "scope_of_responsibilities": { "description": "The scope of responsibilities for the level.", "type": "string" }, "track": { "description": "The track associated with the level, if it's not a global level.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_default": { "description": "Whether this is the company's default track.", "type": "boolean" }, "name": { "description": "The name of the track. Must be unique within the company or organization.", "type": "string" }, "order": { "anyOf": [ { "description": "The one-based horizontal display order of the track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "start_global_level": { "anyOf": [ { "description": "The highest global level occupied by this track. Empty tracks return null.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Track", "type": "object" }, "track_id": { "description": "The track associated with the level. Required during creation. Include global_level when changing it.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Level", "type": "object" }, "level_id": { "description": "The level of the worker.", "type": "string" }, "location": { "description": "The location that the worker is mapped to for tax purposes. In the case that a worker is remote, the location's type is remote.", "properties": { "type": { "description": "The type of location.", "type": "string" }, "work_location_id": { "description": "The work location, if the worker isn't remote.", "type": "string" } }, "required": [ "type", "work_location_id" ], "title": "WorkerLocation", "type": "object" }, "manager": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's manager.\n\nExpandable field", "type": "object" }, "manager_id": { "description": "The worker's manager.", "type": "string" }, "number": { "anyOf": [ { "description": "The worker's number within the organization.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "original_start_date": { "description": "The worker's earliest start date across their employment history, excluding INIT roles.", "type": "string" }, "overtime_exemption": { "description": "The worker's overtime exemption status.", "type": "string" }, "pay_schedule_id": { "description": "The ID of the pay schedule currently associated with the worker.", "type": "string" }, "personal_email": { "description": "The worker's associated personal email address.", "type": "string" }, "race": { "description": "The identified race of the worker, if specified.", "type": "string" }, "start_date": { "description": "The start date of the worker.", "type": "string" }, "status": { "description": "The worker's status within the organization.", "type": "string" }, "teams": { "description": "The worker's assigned teams.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiTeamcb26bc28f32f" }, "type": "array" }, "teams_id": { "description": "The worker's assigned teams.", "items": { "type": "string" }, "type": "array" }, "termination_details": { "description": "The details of the worker's termination, if applicable.", "properties": { "reason": { "description": "This is a description that will be custom to each Rippling company.", "type": "string" }, "type": { "description": "The termination type indicates whether the termination was voluntary or involuntary.", "type": "string" } }, "title": "TerminationDetails", "type": "object" }, "title": { "description": "The worker's title.", "type": "string" }, "title_effective_date": { "description": "Title effective date", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "user": { "description": "The worker's associated user.\n\nExpandable field", "properties": { "active": { "description": "Whether the user is able to access company resources, typically when they are in actively engaged with the company and not after off-boarding.", "type": "boolean" }, "addresses": { "description": "The user's addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiUserAddressedd59b9ba9a1" }, "type": "array" }, "created_at": { "description": "Record creation date", "type": "string" }, "display_name": { "description": "The display name of the user using either the concatenated preferred given and family name or username depending on availability.", "type": "string" }, "emails": { "description": "The user's email addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiEmail5284c8258dc3" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "locale": { "description": "The User's default location for purposes of localization of currency, date time format, or numerical representations pursuant to RFC5646.", "type": "string" }, "name": { "description": "The user's name.", "properties": { "family_name": { "description": "The legal family name of the user, or last name in most Western languages.", "type": "string" }, "formatted": { "description": "The user's full name.", "type": "string" }, "given_name": { "description": "The given legal name of the user, or first name in most Western languages.", "type": "string" }, "middle_name": { "description": "The middle name(s) of the user.", "type": "string" }, "preferred_family_name": { "description": "The preferred family name, or last name in most Western languages, by the user.", "type": "string" }, "preferred_given_name": { "description": "The preferred given name, or first name in most Western languages, by the user.", "type": "string" } }, "title": "UserName", "type": "object" }, "number": { "description": "The permanent profile number of the user.", "type": "string" }, "phone_numbers": { "description": "The user's phone numbers.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoneNumber12060c61ecf5" }, "type": "array" }, "photos": { "description": "The user's photos.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoto2be7c3ae3f39" }, "type": "array" }, "preferred_language": { "description": "The User's preferred written or spoken language in the same format of the HTTP Accept-Language header, pursuant to Section 5.3.5 of RFC7231.", "type": "string" }, "timezone": { "description": "The User's current time zone in IANA database Olson format", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "username": { "description": "The unique identifier across Rippling used by the User for direct authentication into their associated company. Globally unique.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "User", "type": "object" }, "user_id": { "description": "The worker's associated user.", "type": "string" }, "work_email": { "description": "The worker's associated work email address.", "type": "string" }, "work_schedule": { "additionalProperties": { "$ref": "#/components/schemas/OutputRestApiWorkScheduleDay938f88d94f20" }, "description": "The worker's scheduled working hours for each day of the week.", "type": "object" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Worker", "type": "object" }, "worker_id": { "description": "The ID of the worker associated with the time card.", "type": "string" } }, "required": [ "created_at", "id", "updated_at", "worker_id" ], "title": "TimeCard", "type": "object" }, "time_card_id": { "description": "The ID of the time card associated with the time entry.", "type": "string" }, "time_entry_summary": { "description": "A summary of the time entry.", "properties": { "double_over_time_hours": { "anyOf": [ { "description": "The number of double overtime hours worked during this time entry.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "duration": { "anyOf": [ { "description": "The duration of the time entry.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "over_time_hours": { "anyOf": [ { "description": "The number of overtime hours worked during this time entry.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "regular_hours": { "anyOf": [ { "description": "The number of regular hours worked during this time entry.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "TimeEntrySummary", "type": "object" }, "updated_at": { "description": "Record update date", "type": "string" }, "worker": { "description": "The worker associated with the time entry.\n\nExpandable field", "properties": { "business_partners": { "description": "Worker's assigned business partners. This field is only populated when explicitly requested via the expand parameter (e.g., ?expand=business_partners). When expanded, returns an empty list ([]) if the worker has no business partners.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiBusinessPartner77b00a069c32" }, "type": "array" }, "business_partners_id": { "description": "Worker's assigned business partners unique identifiers. Returns an empty list ([]) if the worker has no business partners.", "items": { "type": "string" }, "type": "array" }, "citizenship": { "description": "The countries that the worker has citizenship in.", "type": "string" }, "compensation": { "description": "The compensation package for the worker.\n\nExpandable field", "properties": { "annual_compensation": { "description": "The worker's annual compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "annual_salary_equivalent": { "description": "The worker's annual salary equivalent, for insurance purposes. It will be equal to the worker's annual compensation, except for owners that are receiving no cashcompensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "bonus_schedule": { "description": "The worker's bonus schedule.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "hourly_wage": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "id": { "description": "Identifier field", "type": "string" }, "monthly_compensation": { "description": "The worker's monthly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "on_target_commission": { "description": "The worker's on-target commission.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "payment_terms": { "description": "The payment terms for an worker's compensation.", "type": "string" }, "payment_type": { "description": "The payment type for an worker's compensation.", "type": "string" }, "relocation_reimbursement": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "salary_effective_date": { "description": "Salary effective date", "type": "string" }, "signing_bonus": { "description": "The worker's signing bonus.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus": { "description": "The worker's target annual bonus amount.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus_percent": { "anyOf": [ { "description": "The worker's target annual bonus as a percent of annual compensation.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" }, "weekly_compensation": { "description": "The worker's weekly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "worker": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's details.\n\nExpandable field", "type": "object" }, "worker_id": { "description": "The worker's ID.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Compensation", "type": "object" }, "compensation_grade": { "description": "The compensation grade assigned to the worker, if any.", "properties": { "id": { "description": "The compensation grade's unique identifier.", "type": "string" }, "label": { "description": "The compensation grade's label.", "type": "string" } }, "title": "WorkerCompensationGrade", "type": "object" }, "compensation_id": { "description": "The compensation package for the worker.", "type": "string" }, "country": { "description": "The worker's country.", "type": "string" }, "country_fields": { "description": "Country level fields for the worker.", "properties": { "ca": { "description": "Country-wise regional fields for Canada", "properties": { "sin": { "description": "Social Insurance Number (SIN) for Canada employees.", "type": "string" } }, "title": "CanadaFields", "type": "object" }, "nz": { "description": "Country-wise regional fields for New Zealand", "properties": { "ird_number": { "description": "Inland Revenue Department (IRD) number for New Zealand employees.", "type": "string" } }, "title": "NewZealandFields", "type": "object" }, "us": { "description": "Country-wise regional fields for USA", "properties": { "ssn": { "description": "Social Security Number (SSN) for US employees.", "type": "string" } }, "title": "USFields", "type": "object" } }, "title": "CountryFields", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "custom_fields": { "description": "Custom field values defined on the Employee object for this worker\n\nExpandable field", "items": { "additionalProperties": {} }, "type": "array" }, "date_of_birth": { "description": "The worker's date of birth.", "type": "string" }, "department": { "description": "The worker's assigned department.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "department_hierarchy": { "description": "List of departments in the department hierarchy. Refer department_hierarchy_ids for department hierarchy order.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestDepartment" }, "type": "array" }, "department_hierarchy_id": { "description": "The identifier of departments in the department hierarchy ordered from parent department to child department.", "items": { "type": "string" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the department.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestDepartment", "description": "The parent department.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent department.", "type": "string" }, "reference_code": { "description": "Reference code of the department.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Department", "type": "object" }, "department_id": { "description": "The worker's assigned department.", "type": "string" }, "employment_type": { "description": "The worker's employment type.\n\nExpandable field", "properties": { "amount_worked": { "description": "The amount worked for the employment type. * `FULL-TIME`: Full-time is at least 30 hours per week. Full-time workers will typically be eligible for benefits. * `PART-TIME`: Part-time is less than 30 hours per week. These workers may be eligible for benefits, depending on company settings and hours worked. * `TEMPORARY`: These workers are hired on a temporary basis. You can specify how each worker with this employment type will be paid individually.", "type": "string" }, "compensation_time_period": { "description": "The compensation period for the employment type. * `SALARIED`: Employees that are paid a fixed amount per year. * `HOURLY`: Employees that are paid a wage per hour worked.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "label": { "description": "The display label of the employment type.", "type": "string" }, "name": { "description": "The name of the employment type for non-custom employment types.", "type": "string" }, "type": { "description": "The classification of the worker by the company. * `CONTRACTOR`: Contractors are self-employed workers who provide services on a short-term or per-project basis and are not eligible for tax-withholding or benefits. * `EMPLOYEE`: Employees are hired and managed by an employer, work under the employer's direct supervision and control, and are protected by law for wages and employment rights.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "label", "updated_at" ], "title": "CompanyEmploymentType", "type": "object" }, "employment_type_id": { "description": "The worker's employment type.", "type": "string" }, "end_date": { "description": "The end date of the worker.", "type": "string" }, "ethnicity": { "description": "The identified ethnicity of the worker, if specified.", "type": "string" }, "gender": { "description": "The gender of the worker, if specified.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_manager": { "description": "Whether the worker is a manager", "type": "boolean" }, "job_function": { "description": "The worker's job function. When expanded, this field requires `job-functions.read`.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "Displayed name of the job function", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "JobFunction", "type": "object" }, "job_function_id": { "description": "ID of the worker's job function.", "type": "string" }, "legal_entity": { "description": "The worker's associated legal entity.\n\nExpandable field", "properties": { "company": { "description": "The company or organization associated with the legal entity\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "doing_business_as_name": { "description": "The doing business as name for the company.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_entities": { "description": "A list of the company's entities.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestLegalEntity" }, "type": "array" }, "legal_entities_id": { "description": "A list of the company's entities.", "items": { "type": "string" }, "type": "array" }, "legal_name": { "description": "The legal name of the company.", "type": "string" }, "name": { "description": "The name of the company.", "type": "string" }, "parent_legal_entity": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The company's ultimate holding entity.\n\nExpandable field", "type": "object" }, "parent_legal_entity_id": { "description": "The company's ultimate holding entity.", "type": "string" }, "phone": { "description": "The phone number for the company.", "type": "string" }, "physical_address": { "description": "The physical address of the holding entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "primary_email": { "description": "The email address used when registering this company.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "legal_entities", "legal_entities_id", "name", "updated_at" ], "title": "Company", "type": "object" }, "company_id": { "description": "The company or organization associated with the legal entity", "type": "string" }, "country": { "description": "The country the legal entity is based in.", "properties": { "code": { "description": "The code of the country.", "type": "string" } }, "required": [ "code" ], "title": "Country", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "entity_level": { "description": "The legal entity's level in a hierarchy. * `PARENT`: The legal entity is considered the ultimate holding entity. * `SUBSIDIARY`: The legal entity is considered a subsidiary, fully or partially held by another. * `BRANCH`: The legal entity is considered a branch, associated with a parent legal entity.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_name": { "description": "The legal name of the legal entity.", "type": "string" }, "mailing_address": { "description": "The mailing address of the legal entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "management_type": { "description": "The legal entity management type in the case of an employer of record (EOR) or professional employment organization (PEO). * `PEO`: The legal entity is considered a Professional Employment Organization (PEO). * `EOR`: The legal entity is considered an Employer of Record (EOR).", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The parent legal entity.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent legal entity.", "type": "string" }, "physical_address": { "description": "The physical address of the legal entity, if it differs from the mailing address.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "registration_date": { "description": "The registration date of the entity.", "type": "string" }, "tax_identifier": { "description": "The tax identifier for the legal entity.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "LegalEntity", "type": "object" }, "legal_entity_id": { "description": "The worker's associated legal entity.", "type": "string" }, "level": { "description": "The level of the worker.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "description": { "description": "The description of the level.", "type": "string" }, "experience_requirements": { "description": "The experience requirements for the level.", "type": "string" }, "global_level": { "anyOf": [ { "description": "Global level is used to track the seniority of levels. The higher up a level is placed on the page, the more senior and higher-ranked the level. Global level is used in workflows, policies, and reports that use the level attribute (e.g., you can use Level Lookup to set up a workflow that notifies the nearest person in an worker's management chain at or above the specified level).", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the level. Must be unique within the company or organization.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLevel", "description": "The parent level.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent level.", "type": "string" }, "rank": { "anyOf": [ { "description": "The rank of the level within its track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "scope_of_responsibilities": { "description": "The scope of responsibilities for the level.", "type": "string" }, "track": { "description": "The track associated with the level, if it's not a global level.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_default": { "description": "Whether this is the company's default track.", "type": "boolean" }, "name": { "description": "The name of the track. Must be unique within the company or organization.", "type": "string" }, "order": { "anyOf": [ { "description": "The one-based horizontal display order of the track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "start_global_level": { "anyOf": [ { "description": "The highest global level occupied by this track. Empty tracks return null.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Track", "type": "object" }, "track_id": { "description": "The track associated with the level. Required during creation. Include global_level when changing it.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Level", "type": "object" }, "level_id": { "description": "The level of the worker.", "type": "string" }, "location": { "description": "The location that the worker is mapped to for tax purposes. In the case that a worker is remote, the location's type is remote.", "properties": { "type": { "description": "The type of location.", "type": "string" }, "work_location_id": { "description": "The work location, if the worker isn't remote.", "type": "string" } }, "required": [ "type", "work_location_id" ], "title": "WorkerLocation", "type": "object" }, "manager": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's manager.\n\nExpandable field", "type": "object" }, "manager_id": { "description": "The worker's manager.", "type": "string" }, "number": { "anyOf": [ { "description": "The worker's number within the organization.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "original_start_date": { "description": "The worker's earliest start date across their employment history, excluding INIT roles.", "type": "string" }, "overtime_exemption": { "description": "The worker's overtime exemption status.", "type": "string" }, "pay_schedule_id": { "description": "The ID of the pay schedule currently associated with the worker.", "type": "string" }, "personal_email": { "description": "The worker's associated personal email address.", "type": "string" }, "race": { "description": "The identified race of the worker, if specified.", "type": "string" }, "start_date": { "description": "The start date of the worker.", "type": "string" }, "status": { "description": "The worker's status within the organization.", "type": "string" }, "teams": { "description": "The worker's assigned teams.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiTeamcb26bc28f32f" }, "type": "array" }, "teams_id": { "description": "The worker's assigned teams.", "items": { "type": "string" }, "type": "array" }, "termination_details": { "description": "The details of the worker's termination, if applicable.", "properties": { "reason": { "description": "This is a description that will be custom to each Rippling company.", "type": "string" }, "type": { "description": "The termination type indicates whether the termination was voluntary or involuntary.", "type": "string" } }, "title": "TerminationDetails", "type": "object" }, "title": { "description": "The worker's title.", "type": "string" }, "title_effective_date": { "description": "Title effective date", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "user": { "description": "The worker's associated user.\n\nExpandable field", "properties": { "active": { "description": "Whether the user is able to access company resources, typically when they are in actively engaged with the company and not after off-boarding.", "type": "boolean" }, "addresses": { "description": "The user's addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiUserAddressedd59b9ba9a1" }, "type": "array" }, "created_at": { "description": "Record creation date", "type": "string" }, "display_name": { "description": "The display name of the user using either the concatenated preferred given and family name or username depending on availability.", "type": "string" }, "emails": { "description": "The user's email addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiEmail5284c8258dc3" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "locale": { "description": "The User's default location for purposes of localization of currency, date time format, or numerical representations pursuant to RFC5646.", "type": "string" }, "name": { "description": "The user's name.", "properties": { "family_name": { "description": "The legal family name of the user, or last name in most Western languages.", "type": "string" }, "formatted": { "description": "The user's full name.", "type": "string" }, "given_name": { "description": "The given legal name of the user, or first name in most Western languages.", "type": "string" }, "middle_name": { "description": "The middle name(s) of the user.", "type": "string" }, "preferred_family_name": { "description": "The preferred family name, or last name in most Western languages, by the user.", "type": "string" }, "preferred_given_name": { "description": "The preferred given name, or first name in most Western languages, by the user.", "type": "string" } }, "title": "UserName", "type": "object" }, "number": { "description": "The permanent profile number of the user.", "type": "string" }, "phone_numbers": { "description": "The user's phone numbers.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoneNumber12060c61ecf5" }, "type": "array" }, "photos": { "description": "The user's photos.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoto2be7c3ae3f39" }, "type": "array" }, "preferred_language": { "description": "The User's preferred written or spoken language in the same format of the HTTP Accept-Language header, pursuant to Section 5.3.5 of RFC7231.", "type": "string" }, "timezone": { "description": "The User's current time zone in IANA database Olson format", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "username": { "description": "The unique identifier across Rippling used by the User for direct authentication into their associated company. Globally unique.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "User", "type": "object" }, "user_id": { "description": "The worker's associated user.", "type": "string" }, "work_email": { "description": "The worker's associated work email address.", "type": "string" }, "work_schedule": { "additionalProperties": { "$ref": "#/components/schemas/OutputRestApiWorkScheduleDay938f88d94f20" }, "description": "The worker's scheduled working hours for each day of the week.", "type": "object" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Worker", "type": "object" }, "worker_id": { "description": "The ID of the worker associated with the time entry.", "type": "string" } }, "required": [ "created_at", "id", "updated_at", "worker_id" ], "title": "TimeEntry", "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Create a new time entry", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "time-entries.read-write" ] } }, "/time-entries/{id}/": { "delete": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/delete-time-entries" }, "operationId": "rippling.rest_api.delete_time_entries", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "id", "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "204": { "description": "The resource was deleted successfully" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Delete a time entry", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "time-entries.read-write" ] }, "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/get-time-entries" }, "operationId": "rippling.rest_api.get_time_entries", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "id", "type": "string" } }, { "in": "query", "name": "expand", "required": false, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "__meta": { "properties": { "redacted_fields": { "items": { "$ref": "#/components/schemas/OutputRestApiRedactedField21788a25ef22" }, "type": "array" } }, "type": "object" }, "breaks": { "description": "The breaks taken during the time entry.", "items": { "$ref": "#/components/schemas/OutputRestApiBreak50f807167b82" }, "type": "array" }, "comments": { "description": "The comments associated with the time entry.", "items": { "$ref": "#/components/schemas/OutputRestApiTimeEntryCommente521151255bf" }, "type": "array" }, "create_extra_hours_run": { "description": "Whether the time entry should create an extra hours run.", "type": "boolean" }, "created_at": { "description": "Record creation date", "type": "string" }, "end_time": { "description": "The end time of the time entry.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "idempotency_key": { "description": "The unique key of the time entry in an outside system. If set, no other time entry with the same key can be created.", "type": "string" }, "job_shifts": { "description": "The job shifts worked during the time entry.", "items": { "$ref": "#/components/schemas/OutputRestApiJobShift87137d8a0daa" }, "type": "array" }, "pay_period": { "description": "The pay period associated with the time card.", "properties": { "end_date": { "description": "The end date of the pay period.", "type": "string" }, "pay_schedule_id": { "description": "The ID of the pay schedule associated with the pay period.", "type": "string" }, "start_date": { "description": "The start date of the pay period.", "type": "string" } }, "title": "PayPeriod", "type": "object" }, "piece_rate_premiums": { "description": "The piece-rate premiums earned during the time entry.", "items": { "$ref": "#/components/schemas/OutputRestApiPieceRatePremiumsd68380854608" }, "type": "array" }, "premiums": { "description": "The premiums earned during the time entry.", "items": { "$ref": "#/components/schemas/OutputRestApiPremiumsecd81efd722e" }, "type": "array" }, "segments": { "description": "The pay rates for each segment of the time entry.", "items": { "$ref": "#/components/schemas/OutputRestApiSegmentse33b0ae25a0a" }, "type": "array" }, "shift_input_values": { "description": "Arbitrary shift inputs collected on the time entry", "items": { "$ref": "#/components/schemas/OutputRestApiShiftInputValued170635510cb" }, "type": "array" }, "start_time": { "description": "The start time of the time entry.", "type": "string" }, "status": { "description": "The status of the time entry.", "type": "string" }, "tags": { "description": "The tags associated with the time entry.", "items": { "type": "string" }, "type": "array" }, "time_card": { "description": "The time card associated with the time entry.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "pay_period": { "description": "The pay period associated with the time card.", "properties": { "end_date": { "description": "The end date of the pay period.", "type": "string" }, "pay_schedule_id": { "description": "The ID of the pay schedule associated with the pay period.", "type": "string" }, "start_date": { "description": "The start date of the pay period.", "type": "string" } }, "title": "PayPeriod", "type": "object" }, "summary": { "description": "The summary of the time card.", "properties": { "approved_hours": { "anyOf": [ { "description": "The approved hours for the pay period.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "double_overtime_hours": { "anyOf": [ { "description": "The total number of doubletime hours worked during the pay period.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "earnings": { "anyOf": [ { "description": "The earnings for the pay period.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "hours_worked_by_job_code": { "description": "The amount of hours worked for each job code for the pay period.", "items": { "$ref": "#/components/schemas/OutputRestApiJobCodeSummary73cdc3312543" }, "type": "array" }, "overtime_hours": { "anyOf": [ { "description": "The total number of overtime hours worked during the pay period.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "paid_hours": { "anyOf": [ { "description": "The paid hours for the pay period.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "premiums": { "anyOf": [ { "description": "The premiums for the pay period.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "regular_hours": { "anyOf": [ { "description": "The total number of regular hours worked during the pay period.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "total_holiday_hours": { "anyOf": [ { "description": "The total holiday hours for the pay period.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "total_hours": { "anyOf": [ { "description": "The total hours for the pay period.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "total_paid_time_off_hours": { "anyOf": [ { "description": "The total paid time off hours for the pay period.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "total_unpaid_time_off_hours": { "anyOf": [ { "description": "The total unpaid time off hours for the pay period.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "unpaid_break_hours_by_entry": { "anyOf": [ { "description": "The map of time entry to unpaidBreakHours in seconds", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "TimeCardSummary", "type": "object" }, "updated_at": { "description": "Record update date", "type": "string" }, "worker": { "description": "The worker associated with the time card.\n\nExpandable field", "properties": { "business_partners": { "description": "Worker's assigned business partners. This field is only populated when explicitly requested via the expand parameter (e.g., ?expand=business_partners). When expanded, returns an empty list ([]) if the worker has no business partners.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiBusinessPartner77b00a069c32" }, "type": "array" }, "business_partners_id": { "description": "Worker's assigned business partners unique identifiers. Returns an empty list ([]) if the worker has no business partners.", "items": { "type": "string" }, "type": "array" }, "citizenship": { "description": "The countries that the worker has citizenship in.", "type": "string" }, "compensation": { "description": "The compensation package for the worker.\n\nExpandable field", "properties": { "annual_compensation": { "description": "The worker's annual compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "annual_salary_equivalent": { "description": "The worker's annual salary equivalent, for insurance purposes. It will be equal to the worker's annual compensation, except for owners that are receiving no cashcompensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "bonus_schedule": { "description": "The worker's bonus schedule.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "hourly_wage": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "id": { "description": "Identifier field", "type": "string" }, "monthly_compensation": { "description": "The worker's monthly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "on_target_commission": { "description": "The worker's on-target commission.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "payment_terms": { "description": "The payment terms for an worker's compensation.", "type": "string" }, "payment_type": { "description": "The payment type for an worker's compensation.", "type": "string" }, "relocation_reimbursement": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "salary_effective_date": { "description": "Salary effective date", "type": "string" }, "signing_bonus": { "description": "The worker's signing bonus.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus": { "description": "The worker's target annual bonus amount.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus_percent": { "anyOf": [ { "description": "The worker's target annual bonus as a percent of annual compensation.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" }, "weekly_compensation": { "description": "The worker's weekly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "worker": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's details.\n\nExpandable field", "type": "object" }, "worker_id": { "description": "The worker's ID.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Compensation", "type": "object" }, "compensation_grade": { "description": "The compensation grade assigned to the worker, if any.", "properties": { "id": { "description": "The compensation grade's unique identifier.", "type": "string" }, "label": { "description": "The compensation grade's label.", "type": "string" } }, "title": "WorkerCompensationGrade", "type": "object" }, "compensation_id": { "description": "The compensation package for the worker.", "type": "string" }, "country": { "description": "The worker's country.", "type": "string" }, "country_fields": { "description": "Country level fields for the worker.", "properties": { "ca": { "description": "Country-wise regional fields for Canada", "properties": { "sin": { "description": "Social Insurance Number (SIN) for Canada employees.", "type": "string" } }, "title": "CanadaFields", "type": "object" }, "nz": { "description": "Country-wise regional fields for New Zealand", "properties": { "ird_number": { "description": "Inland Revenue Department (IRD) number for New Zealand employees.", "type": "string" } }, "title": "NewZealandFields", "type": "object" }, "us": { "description": "Country-wise regional fields for USA", "properties": { "ssn": { "description": "Social Security Number (SSN) for US employees.", "type": "string" } }, "title": "USFields", "type": "object" } }, "title": "CountryFields", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "custom_fields": { "description": "Custom field values defined on the Employee object for this worker\n\nExpandable field", "items": { "additionalProperties": {} }, "type": "array" }, "date_of_birth": { "description": "The worker's date of birth.", "type": "string" }, "department": { "description": "The worker's assigned department.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "department_hierarchy": { "description": "List of departments in the department hierarchy. Refer department_hierarchy_ids for department hierarchy order.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestDepartment" }, "type": "array" }, "department_hierarchy_id": { "description": "The identifier of departments in the department hierarchy ordered from parent department to child department.", "items": { "type": "string" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the department.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestDepartment", "description": "The parent department.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent department.", "type": "string" }, "reference_code": { "description": "Reference code of the department.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Department", "type": "object" }, "department_id": { "description": "The worker's assigned department.", "type": "string" }, "employment_type": { "description": "The worker's employment type.\n\nExpandable field", "properties": { "amount_worked": { "description": "The amount worked for the employment type. * `FULL-TIME`: Full-time is at least 30 hours per week. Full-time workers will typically be eligible for benefits. * `PART-TIME`: Part-time is less than 30 hours per week. These workers may be eligible for benefits, depending on company settings and hours worked. * `TEMPORARY`: These workers are hired on a temporary basis. You can specify how each worker with this employment type will be paid individually.", "type": "string" }, "compensation_time_period": { "description": "The compensation period for the employment type. * `SALARIED`: Employees that are paid a fixed amount per year. * `HOURLY`: Employees that are paid a wage per hour worked.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "label": { "description": "The display label of the employment type.", "type": "string" }, "name": { "description": "The name of the employment type for non-custom employment types.", "type": "string" }, "type": { "description": "The classification of the worker by the company. * `CONTRACTOR`: Contractors are self-employed workers who provide services on a short-term or per-project basis and are not eligible for tax-withholding or benefits. * `EMPLOYEE`: Employees are hired and managed by an employer, work under the employer's direct supervision and control, and are protected by law for wages and employment rights.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "label", "updated_at" ], "title": "CompanyEmploymentType", "type": "object" }, "employment_type_id": { "description": "The worker's employment type.", "type": "string" }, "end_date": { "description": "The end date of the worker.", "type": "string" }, "ethnicity": { "description": "The identified ethnicity of the worker, if specified.", "type": "string" }, "gender": { "description": "The gender of the worker, if specified.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_manager": { "description": "Whether the worker is a manager", "type": "boolean" }, "job_function": { "description": "The worker's job function. When expanded, this field requires `job-functions.read`.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "Displayed name of the job function", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "JobFunction", "type": "object" }, "job_function_id": { "description": "ID of the worker's job function.", "type": "string" }, "legal_entity": { "description": "The worker's associated legal entity.\n\nExpandable field", "properties": { "company": { "description": "The company or organization associated with the legal entity\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "doing_business_as_name": { "description": "The doing business as name for the company.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_entities": { "description": "A list of the company's entities.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestLegalEntity" }, "type": "array" }, "legal_entities_id": { "description": "A list of the company's entities.", "items": { "type": "string" }, "type": "array" }, "legal_name": { "description": "The legal name of the company.", "type": "string" }, "name": { "description": "The name of the company.", "type": "string" }, "parent_legal_entity": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The company's ultimate holding entity.\n\nExpandable field", "type": "object" }, "parent_legal_entity_id": { "description": "The company's ultimate holding entity.", "type": "string" }, "phone": { "description": "The phone number for the company.", "type": "string" }, "physical_address": { "description": "The physical address of the holding entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "primary_email": { "description": "The email address used when registering this company.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "legal_entities", "legal_entities_id", "name", "updated_at" ], "title": "Company", "type": "object" }, "company_id": { "description": "The company or organization associated with the legal entity", "type": "string" }, "country": { "description": "The country the legal entity is based in.", "properties": { "code": { "description": "The code of the country.", "type": "string" } }, "required": [ "code" ], "title": "Country", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "entity_level": { "description": "The legal entity's level in a hierarchy. * `PARENT`: The legal entity is considered the ultimate holding entity. * `SUBSIDIARY`: The legal entity is considered a subsidiary, fully or partially held by another. * `BRANCH`: The legal entity is considered a branch, associated with a parent legal entity.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_name": { "description": "The legal name of the legal entity.", "type": "string" }, "mailing_address": { "description": "The mailing address of the legal entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "management_type": { "description": "The legal entity management type in the case of an employer of record (EOR) or professional employment organization (PEO). * `PEO`: The legal entity is considered a Professional Employment Organization (PEO). * `EOR`: The legal entity is considered an Employer of Record (EOR).", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The parent legal entity.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent legal entity.", "type": "string" }, "physical_address": { "description": "The physical address of the legal entity, if it differs from the mailing address.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "registration_date": { "description": "The registration date of the entity.", "type": "string" }, "tax_identifier": { "description": "The tax identifier for the legal entity.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "LegalEntity", "type": "object" }, "legal_entity_id": { "description": "The worker's associated legal entity.", "type": "string" }, "level": { "description": "The level of the worker.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "description": { "description": "The description of the level.", "type": "string" }, "experience_requirements": { "description": "The experience requirements for the level.", "type": "string" }, "global_level": { "anyOf": [ { "description": "Global level is used to track the seniority of levels. The higher up a level is placed on the page, the more senior and higher-ranked the level. Global level is used in workflows, policies, and reports that use the level attribute (e.g., you can use Level Lookup to set up a workflow that notifies the nearest person in an worker's management chain at or above the specified level).", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the level. Must be unique within the company or organization.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLevel", "description": "The parent level.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent level.", "type": "string" }, "rank": { "anyOf": [ { "description": "The rank of the level within its track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "scope_of_responsibilities": { "description": "The scope of responsibilities for the level.", "type": "string" }, "track": { "description": "The track associated with the level, if it's not a global level.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_default": { "description": "Whether this is the company's default track.", "type": "boolean" }, "name": { "description": "The name of the track. Must be unique within the company or organization.", "type": "string" }, "order": { "anyOf": [ { "description": "The one-based horizontal display order of the track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "start_global_level": { "anyOf": [ { "description": "The highest global level occupied by this track. Empty tracks return null.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Track", "type": "object" }, "track_id": { "description": "The track associated with the level. Required during creation. Include global_level when changing it.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Level", "type": "object" }, "level_id": { "description": "The level of the worker.", "type": "string" }, "location": { "description": "The location that the worker is mapped to for tax purposes. In the case that a worker is remote, the location's type is remote.", "properties": { "type": { "description": "The type of location.", "type": "string" }, "work_location_id": { "description": "The work location, if the worker isn't remote.", "type": "string" } }, "required": [ "type", "work_location_id" ], "title": "WorkerLocation", "type": "object" }, "manager": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's manager.\n\nExpandable field", "type": "object" }, "manager_id": { "description": "The worker's manager.", "type": "string" }, "number": { "anyOf": [ { "description": "The worker's number within the organization.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "original_start_date": { "description": "The worker's earliest start date across their employment history, excluding INIT roles.", "type": "string" }, "overtime_exemption": { "description": "The worker's overtime exemption status.", "type": "string" }, "pay_schedule_id": { "description": "The ID of the pay schedule currently associated with the worker.", "type": "string" }, "personal_email": { "description": "The worker's associated personal email address.", "type": "string" }, "race": { "description": "The identified race of the worker, if specified.", "type": "string" }, "start_date": { "description": "The start date of the worker.", "type": "string" }, "status": { "description": "The worker's status within the organization.", "type": "string" }, "teams": { "description": "The worker's assigned teams.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiTeamcb26bc28f32f" }, "type": "array" }, "teams_id": { "description": "The worker's assigned teams.", "items": { "type": "string" }, "type": "array" }, "termination_details": { "description": "The details of the worker's termination, if applicable.", "properties": { "reason": { "description": "This is a description that will be custom to each Rippling company.", "type": "string" }, "type": { "description": "The termination type indicates whether the termination was voluntary or involuntary.", "type": "string" } }, "title": "TerminationDetails", "type": "object" }, "title": { "description": "The worker's title.", "type": "string" }, "title_effective_date": { "description": "Title effective date", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "user": { "description": "The worker's associated user.\n\nExpandable field", "properties": { "active": { "description": "Whether the user is able to access company resources, typically when they are in actively engaged with the company and not after off-boarding.", "type": "boolean" }, "addresses": { "description": "The user's addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiUserAddressedd59b9ba9a1" }, "type": "array" }, "created_at": { "description": "Record creation date", "type": "string" }, "display_name": { "description": "The display name of the user using either the concatenated preferred given and family name or username depending on availability.", "type": "string" }, "emails": { "description": "The user's email addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiEmail5284c8258dc3" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "locale": { "description": "The User's default location for purposes of localization of currency, date time format, or numerical representations pursuant to RFC5646.", "type": "string" }, "name": { "description": "The user's name.", "properties": { "family_name": { "description": "The legal family name of the user, or last name in most Western languages.", "type": "string" }, "formatted": { "description": "The user's full name.", "type": "string" }, "given_name": { "description": "The given legal name of the user, or first name in most Western languages.", "type": "string" }, "middle_name": { "description": "The middle name(s) of the user.", "type": "string" }, "preferred_family_name": { "description": "The preferred family name, or last name in most Western languages, by the user.", "type": "string" }, "preferred_given_name": { "description": "The preferred given name, or first name in most Western languages, by the user.", "type": "string" } }, "title": "UserName", "type": "object" }, "number": { "description": "The permanent profile number of the user.", "type": "string" }, "phone_numbers": { "description": "The user's phone numbers.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoneNumber12060c61ecf5" }, "type": "array" }, "photos": { "description": "The user's photos.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoto2be7c3ae3f39" }, "type": "array" }, "preferred_language": { "description": "The User's preferred written or spoken language in the same format of the HTTP Accept-Language header, pursuant to Section 5.3.5 of RFC7231.", "type": "string" }, "timezone": { "description": "The User's current time zone in IANA database Olson format", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "username": { "description": "The unique identifier across Rippling used by the User for direct authentication into their associated company. Globally unique.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "User", "type": "object" }, "user_id": { "description": "The worker's associated user.", "type": "string" }, "work_email": { "description": "The worker's associated work email address.", "type": "string" }, "work_schedule": { "additionalProperties": { "$ref": "#/components/schemas/OutputRestApiWorkScheduleDay938f88d94f20" }, "description": "The worker's scheduled working hours for each day of the week.", "type": "object" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Worker", "type": "object" }, "worker_id": { "description": "The ID of the worker associated with the time card.", "type": "string" } }, "required": [ "created_at", "id", "updated_at", "worker_id" ], "title": "TimeCard", "type": "object" }, "time_card_id": { "description": "The ID of the time card associated with the time entry.", "type": "string" }, "time_entry_summary": { "description": "A summary of the time entry.", "properties": { "double_over_time_hours": { "anyOf": [ { "description": "The number of double overtime hours worked during this time entry.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "duration": { "anyOf": [ { "description": "The duration of the time entry.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "over_time_hours": { "anyOf": [ { "description": "The number of overtime hours worked during this time entry.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "regular_hours": { "anyOf": [ { "description": "The number of regular hours worked during this time entry.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "TimeEntrySummary", "type": "object" }, "updated_at": { "description": "Record update date", "type": "string" }, "worker": { "description": "The worker associated with the time entry.\n\nExpandable field", "properties": { "business_partners": { "description": "Worker's assigned business partners. This field is only populated when explicitly requested via the expand parameter (e.g., ?expand=business_partners). When expanded, returns an empty list ([]) if the worker has no business partners.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiBusinessPartner77b00a069c32" }, "type": "array" }, "business_partners_id": { "description": "Worker's assigned business partners unique identifiers. Returns an empty list ([]) if the worker has no business partners.", "items": { "type": "string" }, "type": "array" }, "citizenship": { "description": "The countries that the worker has citizenship in.", "type": "string" }, "compensation": { "description": "The compensation package for the worker.\n\nExpandable field", "properties": { "annual_compensation": { "description": "The worker's annual compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "annual_salary_equivalent": { "description": "The worker's annual salary equivalent, for insurance purposes. It will be equal to the worker's annual compensation, except for owners that are receiving no cashcompensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "bonus_schedule": { "description": "The worker's bonus schedule.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "hourly_wage": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "id": { "description": "Identifier field", "type": "string" }, "monthly_compensation": { "description": "The worker's monthly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "on_target_commission": { "description": "The worker's on-target commission.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "payment_terms": { "description": "The payment terms for an worker's compensation.", "type": "string" }, "payment_type": { "description": "The payment type for an worker's compensation.", "type": "string" }, "relocation_reimbursement": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "salary_effective_date": { "description": "Salary effective date", "type": "string" }, "signing_bonus": { "description": "The worker's signing bonus.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus": { "description": "The worker's target annual bonus amount.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus_percent": { "anyOf": [ { "description": "The worker's target annual bonus as a percent of annual compensation.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" }, "weekly_compensation": { "description": "The worker's weekly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "worker": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's details.\n\nExpandable field", "type": "object" }, "worker_id": { "description": "The worker's ID.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Compensation", "type": "object" }, "compensation_grade": { "description": "The compensation grade assigned to the worker, if any.", "properties": { "id": { "description": "The compensation grade's unique identifier.", "type": "string" }, "label": { "description": "The compensation grade's label.", "type": "string" } }, "title": "WorkerCompensationGrade", "type": "object" }, "compensation_id": { "description": "The compensation package for the worker.", "type": "string" }, "country": { "description": "The worker's country.", "type": "string" }, "country_fields": { "description": "Country level fields for the worker.", "properties": { "ca": { "description": "Country-wise regional fields for Canada", "properties": { "sin": { "description": "Social Insurance Number (SIN) for Canada employees.", "type": "string" } }, "title": "CanadaFields", "type": "object" }, "nz": { "description": "Country-wise regional fields for New Zealand", "properties": { "ird_number": { "description": "Inland Revenue Department (IRD) number for New Zealand employees.", "type": "string" } }, "title": "NewZealandFields", "type": "object" }, "us": { "description": "Country-wise regional fields for USA", "properties": { "ssn": { "description": "Social Security Number (SSN) for US employees.", "type": "string" } }, "title": "USFields", "type": "object" } }, "title": "CountryFields", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "custom_fields": { "description": "Custom field values defined on the Employee object for this worker\n\nExpandable field", "items": { "additionalProperties": {} }, "type": "array" }, "date_of_birth": { "description": "The worker's date of birth.", "type": "string" }, "department": { "description": "The worker's assigned department.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "department_hierarchy": { "description": "List of departments in the department hierarchy. Refer department_hierarchy_ids for department hierarchy order.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestDepartment" }, "type": "array" }, "department_hierarchy_id": { "description": "The identifier of departments in the department hierarchy ordered from parent department to child department.", "items": { "type": "string" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the department.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestDepartment", "description": "The parent department.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent department.", "type": "string" }, "reference_code": { "description": "Reference code of the department.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Department", "type": "object" }, "department_id": { "description": "The worker's assigned department.", "type": "string" }, "employment_type": { "description": "The worker's employment type.\n\nExpandable field", "properties": { "amount_worked": { "description": "The amount worked for the employment type. * `FULL-TIME`: Full-time is at least 30 hours per week. Full-time workers will typically be eligible for benefits. * `PART-TIME`: Part-time is less than 30 hours per week. These workers may be eligible for benefits, depending on company settings and hours worked. * `TEMPORARY`: These workers are hired on a temporary basis. You can specify how each worker with this employment type will be paid individually.", "type": "string" }, "compensation_time_period": { "description": "The compensation period for the employment type. * `SALARIED`: Employees that are paid a fixed amount per year. * `HOURLY`: Employees that are paid a wage per hour worked.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "label": { "description": "The display label of the employment type.", "type": "string" }, "name": { "description": "The name of the employment type for non-custom employment types.", "type": "string" }, "type": { "description": "The classification of the worker by the company. * `CONTRACTOR`: Contractors are self-employed workers who provide services on a short-term or per-project basis and are not eligible for tax-withholding or benefits. * `EMPLOYEE`: Employees are hired and managed by an employer, work under the employer's direct supervision and control, and are protected by law for wages and employment rights.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "label", "updated_at" ], "title": "CompanyEmploymentType", "type": "object" }, "employment_type_id": { "description": "The worker's employment type.", "type": "string" }, "end_date": { "description": "The end date of the worker.", "type": "string" }, "ethnicity": { "description": "The identified ethnicity of the worker, if specified.", "type": "string" }, "gender": { "description": "The gender of the worker, if specified.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_manager": { "description": "Whether the worker is a manager", "type": "boolean" }, "job_function": { "description": "The worker's job function. When expanded, this field requires `job-functions.read`.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "Displayed name of the job function", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "JobFunction", "type": "object" }, "job_function_id": { "description": "ID of the worker's job function.", "type": "string" }, "legal_entity": { "description": "The worker's associated legal entity.\n\nExpandable field", "properties": { "company": { "description": "The company or organization associated with the legal entity\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "doing_business_as_name": { "description": "The doing business as name for the company.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_entities": { "description": "A list of the company's entities.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestLegalEntity" }, "type": "array" }, "legal_entities_id": { "description": "A list of the company's entities.", "items": { "type": "string" }, "type": "array" }, "legal_name": { "description": "The legal name of the company.", "type": "string" }, "name": { "description": "The name of the company.", "type": "string" }, "parent_legal_entity": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The company's ultimate holding entity.\n\nExpandable field", "type": "object" }, "parent_legal_entity_id": { "description": "The company's ultimate holding entity.", "type": "string" }, "phone": { "description": "The phone number for the company.", "type": "string" }, "physical_address": { "description": "The physical address of the holding entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "primary_email": { "description": "The email address used when registering this company.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "legal_entities", "legal_entities_id", "name", "updated_at" ], "title": "Company", "type": "object" }, "company_id": { "description": "The company or organization associated with the legal entity", "type": "string" }, "country": { "description": "The country the legal entity is based in.", "properties": { "code": { "description": "The code of the country.", "type": "string" } }, "required": [ "code" ], "title": "Country", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "entity_level": { "description": "The legal entity's level in a hierarchy. * `PARENT`: The legal entity is considered the ultimate holding entity. * `SUBSIDIARY`: The legal entity is considered a subsidiary, fully or partially held by another. * `BRANCH`: The legal entity is considered a branch, associated with a parent legal entity.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_name": { "description": "The legal name of the legal entity.", "type": "string" }, "mailing_address": { "description": "The mailing address of the legal entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "management_type": { "description": "The legal entity management type in the case of an employer of record (EOR) or professional employment organization (PEO). * `PEO`: The legal entity is considered a Professional Employment Organization (PEO). * `EOR`: The legal entity is considered an Employer of Record (EOR).", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The parent legal entity.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent legal entity.", "type": "string" }, "physical_address": { "description": "The physical address of the legal entity, if it differs from the mailing address.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "registration_date": { "description": "The registration date of the entity.", "type": "string" }, "tax_identifier": { "description": "The tax identifier for the legal entity.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "LegalEntity", "type": "object" }, "legal_entity_id": { "description": "The worker's associated legal entity.", "type": "string" }, "level": { "description": "The level of the worker.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "description": { "description": "The description of the level.", "type": "string" }, "experience_requirements": { "description": "The experience requirements for the level.", "type": "string" }, "global_level": { "anyOf": [ { "description": "Global level is used to track the seniority of levels. The higher up a level is placed on the page, the more senior and higher-ranked the level. Global level is used in workflows, policies, and reports that use the level attribute (e.g., you can use Level Lookup to set up a workflow that notifies the nearest person in an worker's management chain at or above the specified level).", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the level. Must be unique within the company or organization.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLevel", "description": "The parent level.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent level.", "type": "string" }, "rank": { "anyOf": [ { "description": "The rank of the level within its track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "scope_of_responsibilities": { "description": "The scope of responsibilities for the level.", "type": "string" }, "track": { "description": "The track associated with the level, if it's not a global level.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_default": { "description": "Whether this is the company's default track.", "type": "boolean" }, "name": { "description": "The name of the track. Must be unique within the company or organization.", "type": "string" }, "order": { "anyOf": [ { "description": "The one-based horizontal display order of the track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "start_global_level": { "anyOf": [ { "description": "The highest global level occupied by this track. Empty tracks return null.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Track", "type": "object" }, "track_id": { "description": "The track associated with the level. Required during creation. Include global_level when changing it.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Level", "type": "object" }, "level_id": { "description": "The level of the worker.", "type": "string" }, "location": { "description": "The location that the worker is mapped to for tax purposes. In the case that a worker is remote, the location's type is remote.", "properties": { "type": { "description": "The type of location.", "type": "string" }, "work_location_id": { "description": "The work location, if the worker isn't remote.", "type": "string" } }, "required": [ "type", "work_location_id" ], "title": "WorkerLocation", "type": "object" }, "manager": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's manager.\n\nExpandable field", "type": "object" }, "manager_id": { "description": "The worker's manager.", "type": "string" }, "number": { "anyOf": [ { "description": "The worker's number within the organization.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "original_start_date": { "description": "The worker's earliest start date across their employment history, excluding INIT roles.", "type": "string" }, "overtime_exemption": { "description": "The worker's overtime exemption status.", "type": "string" }, "pay_schedule_id": { "description": "The ID of the pay schedule currently associated with the worker.", "type": "string" }, "personal_email": { "description": "The worker's associated personal email address.", "type": "string" }, "race": { "description": "The identified race of the worker, if specified.", "type": "string" }, "start_date": { "description": "The start date of the worker.", "type": "string" }, "status": { "description": "The worker's status within the organization.", "type": "string" }, "teams": { "description": "The worker's assigned teams.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiTeamcb26bc28f32f" }, "type": "array" }, "teams_id": { "description": "The worker's assigned teams.", "items": { "type": "string" }, "type": "array" }, "termination_details": { "description": "The details of the worker's termination, if applicable.", "properties": { "reason": { "description": "This is a description that will be custom to each Rippling company.", "type": "string" }, "type": { "description": "The termination type indicates whether the termination was voluntary or involuntary.", "type": "string" } }, "title": "TerminationDetails", "type": "object" }, "title": { "description": "The worker's title.", "type": "string" }, "title_effective_date": { "description": "Title effective date", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "user": { "description": "The worker's associated user.\n\nExpandable field", "properties": { "active": { "description": "Whether the user is able to access company resources, typically when they are in actively engaged with the company and not after off-boarding.", "type": "boolean" }, "addresses": { "description": "The user's addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiUserAddressedd59b9ba9a1" }, "type": "array" }, "created_at": { "description": "Record creation date", "type": "string" }, "display_name": { "description": "The display name of the user using either the concatenated preferred given and family name or username depending on availability.", "type": "string" }, "emails": { "description": "The user's email addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiEmail5284c8258dc3" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "locale": { "description": "The User's default location for purposes of localization of currency, date time format, or numerical representations pursuant to RFC5646.", "type": "string" }, "name": { "description": "The user's name.", "properties": { "family_name": { "description": "The legal family name of the user, or last name in most Western languages.", "type": "string" }, "formatted": { "description": "The user's full name.", "type": "string" }, "given_name": { "description": "The given legal name of the user, or first name in most Western languages.", "type": "string" }, "middle_name": { "description": "The middle name(s) of the user.", "type": "string" }, "preferred_family_name": { "description": "The preferred family name, or last name in most Western languages, by the user.", "type": "string" }, "preferred_given_name": { "description": "The preferred given name, or first name in most Western languages, by the user.", "type": "string" } }, "title": "UserName", "type": "object" }, "number": { "description": "The permanent profile number of the user.", "type": "string" }, "phone_numbers": { "description": "The user's phone numbers.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoneNumber12060c61ecf5" }, "type": "array" }, "photos": { "description": "The user's photos.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoto2be7c3ae3f39" }, "type": "array" }, "preferred_language": { "description": "The User's preferred written or spoken language in the same format of the HTTP Accept-Language header, pursuant to Section 5.3.5 of RFC7231.", "type": "string" }, "timezone": { "description": "The User's current time zone in IANA database Olson format", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "username": { "description": "The unique identifier across Rippling used by the User for direct authentication into their associated company. Globally unique.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "User", "type": "object" }, "user_id": { "description": "The worker's associated user.", "type": "string" }, "work_email": { "description": "The worker's associated work email address.", "type": "string" }, "work_schedule": { "additionalProperties": { "$ref": "#/components/schemas/OutputRestApiWorkScheduleDay938f88d94f20" }, "description": "The worker's scheduled working hours for each day of the week.", "type": "object" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Worker", "type": "object" }, "worker_id": { "description": "The ID of the worker associated with the time entry.", "type": "string" } }, "required": [ "created_at", "id", "updated_at", "worker_id" ], "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Retrieve a specific time entry", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "time-entries.read" ] }, "patch": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/update-time-entries" }, "operationId": "rippling.rest_api.update_time_entries", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "id", "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiTimeEntryRequeste575cc21e300" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "breaks": { "description": "The breaks taken during the time entry.", "items": { "$ref": "#/components/schemas/OutputRestApiBreak50f807167b82" }, "type": "array" }, "comments": { "description": "The comments associated with the time entry.", "items": { "$ref": "#/components/schemas/OutputRestApiTimeEntryCommente521151255bf" }, "type": "array" }, "create_extra_hours_run": { "description": "Whether the time entry should create an extra hours run.", "type": "boolean" }, "created_at": { "description": "Record creation date", "type": "string" }, "end_time": { "description": "The end time of the time entry.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "idempotency_key": { "description": "The unique key of the time entry in an outside system. If set, no other time entry with the same key can be created.", "type": "string" }, "job_shifts": { "description": "The job shifts worked during the time entry.", "items": { "$ref": "#/components/schemas/OutputRestApiJobShift87137d8a0daa" }, "type": "array" }, "pay_period": { "description": "The pay period associated with the time card.", "properties": { "end_date": { "description": "The end date of the pay period.", "type": "string" }, "pay_schedule_id": { "description": "The ID of the pay schedule associated with the pay period.", "type": "string" }, "start_date": { "description": "The start date of the pay period.", "type": "string" } }, "title": "PayPeriod", "type": "object" }, "piece_rate_premiums": { "description": "The piece-rate premiums earned during the time entry.", "items": { "$ref": "#/components/schemas/OutputRestApiPieceRatePremiumsd68380854608" }, "type": "array" }, "premiums": { "description": "The premiums earned during the time entry.", "items": { "$ref": "#/components/schemas/OutputRestApiPremiumsecd81efd722e" }, "type": "array" }, "segments": { "description": "The pay rates for each segment of the time entry.", "items": { "$ref": "#/components/schemas/OutputRestApiSegmentse33b0ae25a0a" }, "type": "array" }, "shift_input_values": { "description": "Arbitrary shift inputs collected on the time entry", "items": { "$ref": "#/components/schemas/OutputRestApiShiftInputValued170635510cb" }, "type": "array" }, "start_time": { "description": "The start time of the time entry.", "type": "string" }, "status": { "description": "The status of the time entry.", "type": "string" }, "tags": { "description": "The tags associated with the time entry.", "items": { "type": "string" }, "type": "array" }, "time_card": { "description": "The time card associated with the time entry.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "pay_period": { "description": "The pay period associated with the time card.", "properties": { "end_date": { "description": "The end date of the pay period.", "type": "string" }, "pay_schedule_id": { "description": "The ID of the pay schedule associated with the pay period.", "type": "string" }, "start_date": { "description": "The start date of the pay period.", "type": "string" } }, "title": "PayPeriod", "type": "object" }, "summary": { "description": "The summary of the time card.", "properties": { "approved_hours": { "anyOf": [ { "description": "The approved hours for the pay period.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "double_overtime_hours": { "anyOf": [ { "description": "The total number of doubletime hours worked during the pay period.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "earnings": { "anyOf": [ { "description": "The earnings for the pay period.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "hours_worked_by_job_code": { "description": "The amount of hours worked for each job code for the pay period.", "items": { "$ref": "#/components/schemas/OutputRestApiJobCodeSummary73cdc3312543" }, "type": "array" }, "overtime_hours": { "anyOf": [ { "description": "The total number of overtime hours worked during the pay period.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "paid_hours": { "anyOf": [ { "description": "The paid hours for the pay period.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "premiums": { "anyOf": [ { "description": "The premiums for the pay period.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "regular_hours": { "anyOf": [ { "description": "The total number of regular hours worked during the pay period.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "total_holiday_hours": { "anyOf": [ { "description": "The total holiday hours for the pay period.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "total_hours": { "anyOf": [ { "description": "The total hours for the pay period.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "total_paid_time_off_hours": { "anyOf": [ { "description": "The total paid time off hours for the pay period.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "total_unpaid_time_off_hours": { "anyOf": [ { "description": "The total unpaid time off hours for the pay period.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "unpaid_break_hours_by_entry": { "anyOf": [ { "description": "The map of time entry to unpaidBreakHours in seconds", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "TimeCardSummary", "type": "object" }, "updated_at": { "description": "Record update date", "type": "string" }, "worker": { "description": "The worker associated with the time card.\n\nExpandable field", "properties": { "business_partners": { "description": "Worker's assigned business partners. This field is only populated when explicitly requested via the expand parameter (e.g., ?expand=business_partners). When expanded, returns an empty list ([]) if the worker has no business partners.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiBusinessPartner77b00a069c32" }, "type": "array" }, "business_partners_id": { "description": "Worker's assigned business partners unique identifiers. Returns an empty list ([]) if the worker has no business partners.", "items": { "type": "string" }, "type": "array" }, "citizenship": { "description": "The countries that the worker has citizenship in.", "type": "string" }, "compensation": { "description": "The compensation package for the worker.\n\nExpandable field", "properties": { "annual_compensation": { "description": "The worker's annual compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "annual_salary_equivalent": { "description": "The worker's annual salary equivalent, for insurance purposes. It will be equal to the worker's annual compensation, except for owners that are receiving no cashcompensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "bonus_schedule": { "description": "The worker's bonus schedule.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "hourly_wage": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "id": { "description": "Identifier field", "type": "string" }, "monthly_compensation": { "description": "The worker's monthly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "on_target_commission": { "description": "The worker's on-target commission.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "payment_terms": { "description": "The payment terms for an worker's compensation.", "type": "string" }, "payment_type": { "description": "The payment type for an worker's compensation.", "type": "string" }, "relocation_reimbursement": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "salary_effective_date": { "description": "Salary effective date", "type": "string" }, "signing_bonus": { "description": "The worker's signing bonus.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus": { "description": "The worker's target annual bonus amount.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus_percent": { "anyOf": [ { "description": "The worker's target annual bonus as a percent of annual compensation.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" }, "weekly_compensation": { "description": "The worker's weekly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "worker": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's details.\n\nExpandable field", "type": "object" }, "worker_id": { "description": "The worker's ID.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Compensation", "type": "object" }, "compensation_grade": { "description": "The compensation grade assigned to the worker, if any.", "properties": { "id": { "description": "The compensation grade's unique identifier.", "type": "string" }, "label": { "description": "The compensation grade's label.", "type": "string" } }, "title": "WorkerCompensationGrade", "type": "object" }, "compensation_id": { "description": "The compensation package for the worker.", "type": "string" }, "country": { "description": "The worker's country.", "type": "string" }, "country_fields": { "description": "Country level fields for the worker.", "properties": { "ca": { "description": "Country-wise regional fields for Canada", "properties": { "sin": { "description": "Social Insurance Number (SIN) for Canada employees.", "type": "string" } }, "title": "CanadaFields", "type": "object" }, "nz": { "description": "Country-wise regional fields for New Zealand", "properties": { "ird_number": { "description": "Inland Revenue Department (IRD) number for New Zealand employees.", "type": "string" } }, "title": "NewZealandFields", "type": "object" }, "us": { "description": "Country-wise regional fields for USA", "properties": { "ssn": { "description": "Social Security Number (SSN) for US employees.", "type": "string" } }, "title": "USFields", "type": "object" } }, "title": "CountryFields", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "custom_fields": { "description": "Custom field values defined on the Employee object for this worker\n\nExpandable field", "items": { "additionalProperties": {} }, "type": "array" }, "date_of_birth": { "description": "The worker's date of birth.", "type": "string" }, "department": { "description": "The worker's assigned department.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "department_hierarchy": { "description": "List of departments in the department hierarchy. Refer department_hierarchy_ids for department hierarchy order.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestDepartment" }, "type": "array" }, "department_hierarchy_id": { "description": "The identifier of departments in the department hierarchy ordered from parent department to child department.", "items": { "type": "string" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the department.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestDepartment", "description": "The parent department.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent department.", "type": "string" }, "reference_code": { "description": "Reference code of the department.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Department", "type": "object" }, "department_id": { "description": "The worker's assigned department.", "type": "string" }, "employment_type": { "description": "The worker's employment type.\n\nExpandable field", "properties": { "amount_worked": { "description": "The amount worked for the employment type. * `FULL-TIME`: Full-time is at least 30 hours per week. Full-time workers will typically be eligible for benefits. * `PART-TIME`: Part-time is less than 30 hours per week. These workers may be eligible for benefits, depending on company settings and hours worked. * `TEMPORARY`: These workers are hired on a temporary basis. You can specify how each worker with this employment type will be paid individually.", "type": "string" }, "compensation_time_period": { "description": "The compensation period for the employment type. * `SALARIED`: Employees that are paid a fixed amount per year. * `HOURLY`: Employees that are paid a wage per hour worked.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "label": { "description": "The display label of the employment type.", "type": "string" }, "name": { "description": "The name of the employment type for non-custom employment types.", "type": "string" }, "type": { "description": "The classification of the worker by the company. * `CONTRACTOR`: Contractors are self-employed workers who provide services on a short-term or per-project basis and are not eligible for tax-withholding or benefits. * `EMPLOYEE`: Employees are hired and managed by an employer, work under the employer's direct supervision and control, and are protected by law for wages and employment rights.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "label", "updated_at" ], "title": "CompanyEmploymentType", "type": "object" }, "employment_type_id": { "description": "The worker's employment type.", "type": "string" }, "end_date": { "description": "The end date of the worker.", "type": "string" }, "ethnicity": { "description": "The identified ethnicity of the worker, if specified.", "type": "string" }, "gender": { "description": "The gender of the worker, if specified.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_manager": { "description": "Whether the worker is a manager", "type": "boolean" }, "job_function": { "description": "The worker's job function. When expanded, this field requires `job-functions.read`.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "Displayed name of the job function", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "JobFunction", "type": "object" }, "job_function_id": { "description": "ID of the worker's job function.", "type": "string" }, "legal_entity": { "description": "The worker's associated legal entity.\n\nExpandable field", "properties": { "company": { "description": "The company or organization associated with the legal entity\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "doing_business_as_name": { "description": "The doing business as name for the company.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_entities": { "description": "A list of the company's entities.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestLegalEntity" }, "type": "array" }, "legal_entities_id": { "description": "A list of the company's entities.", "items": { "type": "string" }, "type": "array" }, "legal_name": { "description": "The legal name of the company.", "type": "string" }, "name": { "description": "The name of the company.", "type": "string" }, "parent_legal_entity": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The company's ultimate holding entity.\n\nExpandable field", "type": "object" }, "parent_legal_entity_id": { "description": "The company's ultimate holding entity.", "type": "string" }, "phone": { "description": "The phone number for the company.", "type": "string" }, "physical_address": { "description": "The physical address of the holding entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "primary_email": { "description": "The email address used when registering this company.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "legal_entities", "legal_entities_id", "name", "updated_at" ], "title": "Company", "type": "object" }, "company_id": { "description": "The company or organization associated with the legal entity", "type": "string" }, "country": { "description": "The country the legal entity is based in.", "properties": { "code": { "description": "The code of the country.", "type": "string" } }, "required": [ "code" ], "title": "Country", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "entity_level": { "description": "The legal entity's level in a hierarchy. * `PARENT`: The legal entity is considered the ultimate holding entity. * `SUBSIDIARY`: The legal entity is considered a subsidiary, fully or partially held by another. * `BRANCH`: The legal entity is considered a branch, associated with a parent legal entity.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_name": { "description": "The legal name of the legal entity.", "type": "string" }, "mailing_address": { "description": "The mailing address of the legal entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "management_type": { "description": "The legal entity management type in the case of an employer of record (EOR) or professional employment organization (PEO). * `PEO`: The legal entity is considered a Professional Employment Organization (PEO). * `EOR`: The legal entity is considered an Employer of Record (EOR).", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The parent legal entity.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent legal entity.", "type": "string" }, "physical_address": { "description": "The physical address of the legal entity, if it differs from the mailing address.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "registration_date": { "description": "The registration date of the entity.", "type": "string" }, "tax_identifier": { "description": "The tax identifier for the legal entity.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "LegalEntity", "type": "object" }, "legal_entity_id": { "description": "The worker's associated legal entity.", "type": "string" }, "level": { "description": "The level of the worker.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "description": { "description": "The description of the level.", "type": "string" }, "experience_requirements": { "description": "The experience requirements for the level.", "type": "string" }, "global_level": { "anyOf": [ { "description": "Global level is used to track the seniority of levels. The higher up a level is placed on the page, the more senior and higher-ranked the level. Global level is used in workflows, policies, and reports that use the level attribute (e.g., you can use Level Lookup to set up a workflow that notifies the nearest person in an worker's management chain at or above the specified level).", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the level. Must be unique within the company or organization.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLevel", "description": "The parent level.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent level.", "type": "string" }, "rank": { "anyOf": [ { "description": "The rank of the level within its track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "scope_of_responsibilities": { "description": "The scope of responsibilities for the level.", "type": "string" }, "track": { "description": "The track associated with the level, if it's not a global level.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_default": { "description": "Whether this is the company's default track.", "type": "boolean" }, "name": { "description": "The name of the track. Must be unique within the company or organization.", "type": "string" }, "order": { "anyOf": [ { "description": "The one-based horizontal display order of the track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "start_global_level": { "anyOf": [ { "description": "The highest global level occupied by this track. Empty tracks return null.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Track", "type": "object" }, "track_id": { "description": "The track associated with the level. Required during creation. Include global_level when changing it.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Level", "type": "object" }, "level_id": { "description": "The level of the worker.", "type": "string" }, "location": { "description": "The location that the worker is mapped to for tax purposes. In the case that a worker is remote, the location's type is remote.", "properties": { "type": { "description": "The type of location.", "type": "string" }, "work_location_id": { "description": "The work location, if the worker isn't remote.", "type": "string" } }, "required": [ "type", "work_location_id" ], "title": "WorkerLocation", "type": "object" }, "manager": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's manager.\n\nExpandable field", "type": "object" }, "manager_id": { "description": "The worker's manager.", "type": "string" }, "number": { "anyOf": [ { "description": "The worker's number within the organization.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "original_start_date": { "description": "The worker's earliest start date across their employment history, excluding INIT roles.", "type": "string" }, "overtime_exemption": { "description": "The worker's overtime exemption status.", "type": "string" }, "pay_schedule_id": { "description": "The ID of the pay schedule currently associated with the worker.", "type": "string" }, "personal_email": { "description": "The worker's associated personal email address.", "type": "string" }, "race": { "description": "The identified race of the worker, if specified.", "type": "string" }, "start_date": { "description": "The start date of the worker.", "type": "string" }, "status": { "description": "The worker's status within the organization.", "type": "string" }, "teams": { "description": "The worker's assigned teams.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiTeamcb26bc28f32f" }, "type": "array" }, "teams_id": { "description": "The worker's assigned teams.", "items": { "type": "string" }, "type": "array" }, "termination_details": { "description": "The details of the worker's termination, if applicable.", "properties": { "reason": { "description": "This is a description that will be custom to each Rippling company.", "type": "string" }, "type": { "description": "The termination type indicates whether the termination was voluntary or involuntary.", "type": "string" } }, "title": "TerminationDetails", "type": "object" }, "title": { "description": "The worker's title.", "type": "string" }, "title_effective_date": { "description": "Title effective date", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "user": { "description": "The worker's associated user.\n\nExpandable field", "properties": { "active": { "description": "Whether the user is able to access company resources, typically when they are in actively engaged with the company and not after off-boarding.", "type": "boolean" }, "addresses": { "description": "The user's addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiUserAddressedd59b9ba9a1" }, "type": "array" }, "created_at": { "description": "Record creation date", "type": "string" }, "display_name": { "description": "The display name of the user using either the concatenated preferred given and family name or username depending on availability.", "type": "string" }, "emails": { "description": "The user's email addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiEmail5284c8258dc3" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "locale": { "description": "The User's default location for purposes of localization of currency, date time format, or numerical representations pursuant to RFC5646.", "type": "string" }, "name": { "description": "The user's name.", "properties": { "family_name": { "description": "The legal family name of the user, or last name in most Western languages.", "type": "string" }, "formatted": { "description": "The user's full name.", "type": "string" }, "given_name": { "description": "The given legal name of the user, or first name in most Western languages.", "type": "string" }, "middle_name": { "description": "The middle name(s) of the user.", "type": "string" }, "preferred_family_name": { "description": "The preferred family name, or last name in most Western languages, by the user.", "type": "string" }, "preferred_given_name": { "description": "The preferred given name, or first name in most Western languages, by the user.", "type": "string" } }, "title": "UserName", "type": "object" }, "number": { "description": "The permanent profile number of the user.", "type": "string" }, "phone_numbers": { "description": "The user's phone numbers.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoneNumber12060c61ecf5" }, "type": "array" }, "photos": { "description": "The user's photos.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoto2be7c3ae3f39" }, "type": "array" }, "preferred_language": { "description": "The User's preferred written or spoken language in the same format of the HTTP Accept-Language header, pursuant to Section 5.3.5 of RFC7231.", "type": "string" }, "timezone": { "description": "The User's current time zone in IANA database Olson format", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "username": { "description": "The unique identifier across Rippling used by the User for direct authentication into their associated company. Globally unique.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "User", "type": "object" }, "user_id": { "description": "The worker's associated user.", "type": "string" }, "work_email": { "description": "The worker's associated work email address.", "type": "string" }, "work_schedule": { "additionalProperties": { "$ref": "#/components/schemas/OutputRestApiWorkScheduleDay938f88d94f20" }, "description": "The worker's scheduled working hours for each day of the week.", "type": "object" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Worker", "type": "object" }, "worker_id": { "description": "The ID of the worker associated with the time card.", "type": "string" } }, "required": [ "created_at", "id", "updated_at", "worker_id" ], "title": "TimeCard", "type": "object" }, "time_card_id": { "description": "The ID of the time card associated with the time entry.", "type": "string" }, "time_entry_summary": { "description": "A summary of the time entry.", "properties": { "double_over_time_hours": { "anyOf": [ { "description": "The number of double overtime hours worked during this time entry.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "duration": { "anyOf": [ { "description": "The duration of the time entry.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "over_time_hours": { "anyOf": [ { "description": "The number of overtime hours worked during this time entry.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "regular_hours": { "anyOf": [ { "description": "The number of regular hours worked during this time entry.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "TimeEntrySummary", "type": "object" }, "updated_at": { "description": "Record update date", "type": "string" }, "worker": { "description": "The worker associated with the time entry.\n\nExpandable field", "properties": { "business_partners": { "description": "Worker's assigned business partners. This field is only populated when explicitly requested via the expand parameter (e.g., ?expand=business_partners). When expanded, returns an empty list ([]) if the worker has no business partners.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiBusinessPartner77b00a069c32" }, "type": "array" }, "business_partners_id": { "description": "Worker's assigned business partners unique identifiers. Returns an empty list ([]) if the worker has no business partners.", "items": { "type": "string" }, "type": "array" }, "citizenship": { "description": "The countries that the worker has citizenship in.", "type": "string" }, "compensation": { "description": "The compensation package for the worker.\n\nExpandable field", "properties": { "annual_compensation": { "description": "The worker's annual compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "annual_salary_equivalent": { "description": "The worker's annual salary equivalent, for insurance purposes. It will be equal to the worker's annual compensation, except for owners that are receiving no cashcompensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "bonus_schedule": { "description": "The worker's bonus schedule.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "hourly_wage": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "id": { "description": "Identifier field", "type": "string" }, "monthly_compensation": { "description": "The worker's monthly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "on_target_commission": { "description": "The worker's on-target commission.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "payment_terms": { "description": "The payment terms for an worker's compensation.", "type": "string" }, "payment_type": { "description": "The payment type for an worker's compensation.", "type": "string" }, "relocation_reimbursement": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "salary_effective_date": { "description": "Salary effective date", "type": "string" }, "signing_bonus": { "description": "The worker's signing bonus.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus": { "description": "The worker's target annual bonus amount.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus_percent": { "anyOf": [ { "description": "The worker's target annual bonus as a percent of annual compensation.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" }, "weekly_compensation": { "description": "The worker's weekly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "worker": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's details.\n\nExpandable field", "type": "object" }, "worker_id": { "description": "The worker's ID.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Compensation", "type": "object" }, "compensation_grade": { "description": "The compensation grade assigned to the worker, if any.", "properties": { "id": { "description": "The compensation grade's unique identifier.", "type": "string" }, "label": { "description": "The compensation grade's label.", "type": "string" } }, "title": "WorkerCompensationGrade", "type": "object" }, "compensation_id": { "description": "The compensation package for the worker.", "type": "string" }, "country": { "description": "The worker's country.", "type": "string" }, "country_fields": { "description": "Country level fields for the worker.", "properties": { "ca": { "description": "Country-wise regional fields for Canada", "properties": { "sin": { "description": "Social Insurance Number (SIN) for Canada employees.", "type": "string" } }, "title": "CanadaFields", "type": "object" }, "nz": { "description": "Country-wise regional fields for New Zealand", "properties": { "ird_number": { "description": "Inland Revenue Department (IRD) number for New Zealand employees.", "type": "string" } }, "title": "NewZealandFields", "type": "object" }, "us": { "description": "Country-wise regional fields for USA", "properties": { "ssn": { "description": "Social Security Number (SSN) for US employees.", "type": "string" } }, "title": "USFields", "type": "object" } }, "title": "CountryFields", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "custom_fields": { "description": "Custom field values defined on the Employee object for this worker\n\nExpandable field", "items": { "additionalProperties": {} }, "type": "array" }, "date_of_birth": { "description": "The worker's date of birth.", "type": "string" }, "department": { "description": "The worker's assigned department.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "department_hierarchy": { "description": "List of departments in the department hierarchy. Refer department_hierarchy_ids for department hierarchy order.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestDepartment" }, "type": "array" }, "department_hierarchy_id": { "description": "The identifier of departments in the department hierarchy ordered from parent department to child department.", "items": { "type": "string" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the department.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestDepartment", "description": "The parent department.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent department.", "type": "string" }, "reference_code": { "description": "Reference code of the department.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Department", "type": "object" }, "department_id": { "description": "The worker's assigned department.", "type": "string" }, "employment_type": { "description": "The worker's employment type.\n\nExpandable field", "properties": { "amount_worked": { "description": "The amount worked for the employment type. * `FULL-TIME`: Full-time is at least 30 hours per week. Full-time workers will typically be eligible for benefits. * `PART-TIME`: Part-time is less than 30 hours per week. These workers may be eligible for benefits, depending on company settings and hours worked. * `TEMPORARY`: These workers are hired on a temporary basis. You can specify how each worker with this employment type will be paid individually.", "type": "string" }, "compensation_time_period": { "description": "The compensation period for the employment type. * `SALARIED`: Employees that are paid a fixed amount per year. * `HOURLY`: Employees that are paid a wage per hour worked.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "label": { "description": "The display label of the employment type.", "type": "string" }, "name": { "description": "The name of the employment type for non-custom employment types.", "type": "string" }, "type": { "description": "The classification of the worker by the company. * `CONTRACTOR`: Contractors are self-employed workers who provide services on a short-term or per-project basis and are not eligible for tax-withholding or benefits. * `EMPLOYEE`: Employees are hired and managed by an employer, work under the employer's direct supervision and control, and are protected by law for wages and employment rights.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "label", "updated_at" ], "title": "CompanyEmploymentType", "type": "object" }, "employment_type_id": { "description": "The worker's employment type.", "type": "string" }, "end_date": { "description": "The end date of the worker.", "type": "string" }, "ethnicity": { "description": "The identified ethnicity of the worker, if specified.", "type": "string" }, "gender": { "description": "The gender of the worker, if specified.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_manager": { "description": "Whether the worker is a manager", "type": "boolean" }, "job_function": { "description": "The worker's job function. When expanded, this field requires `job-functions.read`.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "Displayed name of the job function", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "JobFunction", "type": "object" }, "job_function_id": { "description": "ID of the worker's job function.", "type": "string" }, "legal_entity": { "description": "The worker's associated legal entity.\n\nExpandable field", "properties": { "company": { "description": "The company or organization associated with the legal entity\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "doing_business_as_name": { "description": "The doing business as name for the company.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_entities": { "description": "A list of the company's entities.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestLegalEntity" }, "type": "array" }, "legal_entities_id": { "description": "A list of the company's entities.", "items": { "type": "string" }, "type": "array" }, "legal_name": { "description": "The legal name of the company.", "type": "string" }, "name": { "description": "The name of the company.", "type": "string" }, "parent_legal_entity": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The company's ultimate holding entity.\n\nExpandable field", "type": "object" }, "parent_legal_entity_id": { "description": "The company's ultimate holding entity.", "type": "string" }, "phone": { "description": "The phone number for the company.", "type": "string" }, "physical_address": { "description": "The physical address of the holding entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "primary_email": { "description": "The email address used when registering this company.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "legal_entities", "legal_entities_id", "name", "updated_at" ], "title": "Company", "type": "object" }, "company_id": { "description": "The company or organization associated with the legal entity", "type": "string" }, "country": { "description": "The country the legal entity is based in.", "properties": { "code": { "description": "The code of the country.", "type": "string" } }, "required": [ "code" ], "title": "Country", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "entity_level": { "description": "The legal entity's level in a hierarchy. * `PARENT`: The legal entity is considered the ultimate holding entity. * `SUBSIDIARY`: The legal entity is considered a subsidiary, fully or partially held by another. * `BRANCH`: The legal entity is considered a branch, associated with a parent legal entity.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_name": { "description": "The legal name of the legal entity.", "type": "string" }, "mailing_address": { "description": "The mailing address of the legal entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "management_type": { "description": "The legal entity management type in the case of an employer of record (EOR) or professional employment organization (PEO). * `PEO`: The legal entity is considered a Professional Employment Organization (PEO). * `EOR`: The legal entity is considered an Employer of Record (EOR).", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The parent legal entity.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent legal entity.", "type": "string" }, "physical_address": { "description": "The physical address of the legal entity, if it differs from the mailing address.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "registration_date": { "description": "The registration date of the entity.", "type": "string" }, "tax_identifier": { "description": "The tax identifier for the legal entity.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "LegalEntity", "type": "object" }, "legal_entity_id": { "description": "The worker's associated legal entity.", "type": "string" }, "level": { "description": "The level of the worker.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "description": { "description": "The description of the level.", "type": "string" }, "experience_requirements": { "description": "The experience requirements for the level.", "type": "string" }, "global_level": { "anyOf": [ { "description": "Global level is used to track the seniority of levels. The higher up a level is placed on the page, the more senior and higher-ranked the level. Global level is used in workflows, policies, and reports that use the level attribute (e.g., you can use Level Lookup to set up a workflow that notifies the nearest person in an worker's management chain at or above the specified level).", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the level. Must be unique within the company or organization.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLevel", "description": "The parent level.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent level.", "type": "string" }, "rank": { "anyOf": [ { "description": "The rank of the level within its track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "scope_of_responsibilities": { "description": "The scope of responsibilities for the level.", "type": "string" }, "track": { "description": "The track associated with the level, if it's not a global level.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_default": { "description": "Whether this is the company's default track.", "type": "boolean" }, "name": { "description": "The name of the track. Must be unique within the company or organization.", "type": "string" }, "order": { "anyOf": [ { "description": "The one-based horizontal display order of the track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "start_global_level": { "anyOf": [ { "description": "The highest global level occupied by this track. Empty tracks return null.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Track", "type": "object" }, "track_id": { "description": "The track associated with the level. Required during creation. Include global_level when changing it.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Level", "type": "object" }, "level_id": { "description": "The level of the worker.", "type": "string" }, "location": { "description": "The location that the worker is mapped to for tax purposes. In the case that a worker is remote, the location's type is remote.", "properties": { "type": { "description": "The type of location.", "type": "string" }, "work_location_id": { "description": "The work location, if the worker isn't remote.", "type": "string" } }, "required": [ "type", "work_location_id" ], "title": "WorkerLocation", "type": "object" }, "manager": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's manager.\n\nExpandable field", "type": "object" }, "manager_id": { "description": "The worker's manager.", "type": "string" }, "number": { "anyOf": [ { "description": "The worker's number within the organization.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "original_start_date": { "description": "The worker's earliest start date across their employment history, excluding INIT roles.", "type": "string" }, "overtime_exemption": { "description": "The worker's overtime exemption status.", "type": "string" }, "pay_schedule_id": { "description": "The ID of the pay schedule currently associated with the worker.", "type": "string" }, "personal_email": { "description": "The worker's associated personal email address.", "type": "string" }, "race": { "description": "The identified race of the worker, if specified.", "type": "string" }, "start_date": { "description": "The start date of the worker.", "type": "string" }, "status": { "description": "The worker's status within the organization.", "type": "string" }, "teams": { "description": "The worker's assigned teams.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiTeamcb26bc28f32f" }, "type": "array" }, "teams_id": { "description": "The worker's assigned teams.", "items": { "type": "string" }, "type": "array" }, "termination_details": { "description": "The details of the worker's termination, if applicable.", "properties": { "reason": { "description": "This is a description that will be custom to each Rippling company.", "type": "string" }, "type": { "description": "The termination type indicates whether the termination was voluntary or involuntary.", "type": "string" } }, "title": "TerminationDetails", "type": "object" }, "title": { "description": "The worker's title.", "type": "string" }, "title_effective_date": { "description": "Title effective date", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "user": { "description": "The worker's associated user.\n\nExpandable field", "properties": { "active": { "description": "Whether the user is able to access company resources, typically when they are in actively engaged with the company and not after off-boarding.", "type": "boolean" }, "addresses": { "description": "The user's addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiUserAddressedd59b9ba9a1" }, "type": "array" }, "created_at": { "description": "Record creation date", "type": "string" }, "display_name": { "description": "The display name of the user using either the concatenated preferred given and family name or username depending on availability.", "type": "string" }, "emails": { "description": "The user's email addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiEmail5284c8258dc3" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "locale": { "description": "The User's default location for purposes of localization of currency, date time format, or numerical representations pursuant to RFC5646.", "type": "string" }, "name": { "description": "The user's name.", "properties": { "family_name": { "description": "The legal family name of the user, or last name in most Western languages.", "type": "string" }, "formatted": { "description": "The user's full name.", "type": "string" }, "given_name": { "description": "The given legal name of the user, or first name in most Western languages.", "type": "string" }, "middle_name": { "description": "The middle name(s) of the user.", "type": "string" }, "preferred_family_name": { "description": "The preferred family name, or last name in most Western languages, by the user.", "type": "string" }, "preferred_given_name": { "description": "The preferred given name, or first name in most Western languages, by the user.", "type": "string" } }, "title": "UserName", "type": "object" }, "number": { "description": "The permanent profile number of the user.", "type": "string" }, "phone_numbers": { "description": "The user's phone numbers.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoneNumber12060c61ecf5" }, "type": "array" }, "photos": { "description": "The user's photos.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoto2be7c3ae3f39" }, "type": "array" }, "preferred_language": { "description": "The User's preferred written or spoken language in the same format of the HTTP Accept-Language header, pursuant to Section 5.3.5 of RFC7231.", "type": "string" }, "timezone": { "description": "The User's current time zone in IANA database Olson format", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "username": { "description": "The unique identifier across Rippling used by the User for direct authentication into their associated company. Globally unique.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "User", "type": "object" }, "user_id": { "description": "The worker's associated user.", "type": "string" }, "work_email": { "description": "The worker's associated work email address.", "type": "string" }, "work_schedule": { "additionalProperties": { "$ref": "#/components/schemas/OutputRestApiWorkScheduleDay938f88d94f20" }, "description": "The worker's scheduled working hours for each day of the week.", "type": "object" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Worker", "type": "object" }, "worker_id": { "description": "The ID of the worker associated with the time entry.", "type": "string" } }, "required": [ "created_at", "id", "updated_at", "worker_id" ], "title": "TimeEntry", "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Update a time entry", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "time-entries.read-write" ] } }, "/titles/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/list-titles" }, "operationId": "rippling.rest_api.list_titles", "parameters": [ { "in": "query", "name": "order_by", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 100, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "__meta": { "$ref": "#/components/schemas/OutputRestApiRedactedFields9f7657dc2a2f" }, "next_link": { "description": "A link to the next page of responses.", "format": "uri", "type": "string" }, "results": { "items": { "$ref": "#/components/schemas/OutputRestApiTitled2a56118f5cc" }, "type": "array" } }, "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "List titles", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "titles.read" ] }, "post": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/create-titles" }, "operationId": "rippling.rest_api.create_titles", "parameters": [ { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiTitleRequest91f324257cba" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the title.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Title", "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Create a new title", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "titles.read-write" ] } }, "/titles/{id}/": { "delete": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/delete-titles" }, "operationId": "rippling.rest_api.delete_titles", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "id", "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "204": { "description": "The resource was deleted successfully" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Delete a title", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "titles.read-write" ] }, "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/get-titles" }, "operationId": "rippling.rest_api.get_titles", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "id", "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "__meta": { "properties": { "redacted_fields": { "items": { "$ref": "#/components/schemas/OutputRestApiRedactedField21788a25ef22" }, "type": "array" } }, "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the title.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Retrieve a specific title", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "titles.read" ] }, "patch": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/update-titles" }, "operationId": "rippling.rest_api.update_titles", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "id", "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiTitleRequest91f324257cba" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the title.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Title", "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Update a title", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "titles.read-write" ] } }, "/tracks/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/list-tracks" }, "operationId": "rippling.rest_api.list_tracks", "parameters": [ { "in": "query", "name": "order_by", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 100, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "__meta": { "$ref": "#/components/schemas/OutputRestApiRedactedFields9f7657dc2a2f" }, "next_link": { "description": "A link to the next page of responses.", "format": "uri", "type": "string" }, "results": { "items": { "$ref": "#/components/schemas/OutputRestApiTrack10bd1355aacd" }, "type": "array" } }, "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "List tracks", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "tracks.read" ] }, "post": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/create-tracks" }, "operationId": "rippling.rest_api.create_tracks", "parameters": [ { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiTrackRequest27dec0cf6b01" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_default": { "description": "Whether this is the company's default track.", "type": "boolean" }, "name": { "description": "The name of the track. Must be unique within the company or organization.", "type": "string" }, "order": { "anyOf": [ { "description": "The one-based horizontal display order of the track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "start_global_level": { "anyOf": [ { "description": "The highest global level occupied by this track. Empty tracks return null.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Track", "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Create a new track", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "tracks.read-write" ] } }, "/tracks/{id}/": { "delete": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/delete-tracks" }, "operationId": "rippling.rest_api.delete_tracks", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "id", "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "204": { "description": "The resource was deleted successfully" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Delete a track", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "tracks.read-write" ] }, "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/get-tracks" }, "operationId": "rippling.rest_api.get_tracks", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "id", "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "__meta": { "properties": { "redacted_fields": { "items": { "$ref": "#/components/schemas/OutputRestApiRedactedField21788a25ef22" }, "type": "array" } }, "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_default": { "description": "Whether this is the company's default track.", "type": "boolean" }, "name": { "description": "The name of the track. Must be unique within the company or organization.", "type": "string" }, "order": { "anyOf": [ { "description": "The one-based horizontal display order of the track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "start_global_level": { "anyOf": [ { "description": "The highest global level occupied by this track. Empty tracks return null.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Retrieve a specific track", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "tracks.read" ] }, "patch": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/update-tracks" }, "operationId": "rippling.rest_api.update_tracks", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "id", "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiTrackUpdateRequesta319ed221f17" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_default": { "description": "Whether this is the company's default track.", "type": "boolean" }, "name": { "description": "The name of the track. Must be unique within the company or organization.", "type": "string" }, "order": { "anyOf": [ { "description": "The one-based horizontal display order of the track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "start_global_level": { "anyOf": [ { "description": "The highest global level occupied by this track. Empty tracks return null.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Track", "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Update a track", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "tracks.read-write" ] } }, "/unassignedshifts/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/list-unassignedshifts" }, "operationId": "rippling.rest_api.list_unassignedshifts", "parameters": [ { "in": "query", "name": "filter", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "expand", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 100, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "__meta": { "$ref": "#/components/schemas/OutputRestApiRedactedFields9f7657dc2a2f" }, "next_link": { "description": "A link to the next page of responses.", "format": "uri", "type": "string" }, "results": { "items": { "$ref": "#/components/schemas/OutputRestApiUnassignedShift1e04623002e0" }, "type": "array" } }, "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "List unassigned shifts", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "unassignedshifts.read" ] }, "post": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/create-unassignedshifts" }, "operationId": "rippling.rest_api.create_unassignedshifts", "parameters": [ { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiUnassignedShiftRequest78ce5687262e" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "assigned_count": { "anyOf": [ { "description": "The number of assigned shifts", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "assigned_shift_ids": { "description": "The IDs of the assigned shifts that are part of this unassigned shift", "items": { "type": "string" }, "type": "array" }, "created_at": { "description": "Record creation date", "type": "string" }, "custom_fields": { "description": "Custom fields for the unassigned shift", "items": { "additionalProperties": {} }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "is_published": { "description": "Whether the shift is published", "type": "boolean" }, "open_shift_config": { "description": "Configuration for an open shift. If present, this is an open shift (workers can sign up). If absent/None, this is an empty shift (placeholder).", "properties": {}, "title": "OpenShiftConfig", "type": "object" }, "published_version": { "description": "The published version of the shift", "properties": { "end_time": { "description": "The end time of the shift", "type": "string" }, "notes": { "description": "Notes for the shift, max length 256 characters", "maxLength": 256, "type": "string" }, "shift_breaks": { "description": "The breaks of the shift", "items": { "$ref": "#/components/schemas/OutputRestApiShiftBreak314820414f10" }, "type": "array" }, "shift_segments": { "description": "The segments of the shift", "items": { "$ref": "#/components/schemas/OutputRestApiShiftSegment2a530a829033" }, "type": "array" }, "start_time": { "description": "The start time of the shift", "type": "string" } }, "required": [ "end_time", "start_time" ], "title": "ShiftData", "type": "object" }, "schedule": { "description": "The schedule\n\nExpandable field", "properties": { "can_edit": { "description": "Whether the requesting role can edit the schedule.", "type": "boolean" }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "managers": { "description": "The managers of the schedule.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiWorker75ef4092b644" }, "type": "array" }, "managers_id": { "description": "The IDs of the managers of the schedule.", "items": { "type": "string" }, "type": "array" }, "members": { "description": "The members of the schedule.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiWorker75ef4092b644" }, "type": "array" }, "members_id": { "description": "The IDs of the members of the schedule.", "items": { "type": "string" }, "type": "array" }, "name": { "description": "The name of the schedule.", "type": "string" }, "observers": { "description": "The observers of the schedule.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiWorker75ef4092b644" }, "type": "array" }, "observers_id": { "description": "The IDs of the observers of the schedule.", "items": { "type": "string" }, "type": "array" }, "settings": { "description": "The settings of the schedule.", "properties": { "timezone": { "description": "The IANA timezone identifier for the schedule (e.g., 'America/New_York'). Accepted values are defined by the tz database, listed here: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones", "type": "string" } }, "title": "ScheduleSettings", "type": "object" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Schedule", "type": "object" }, "schedule_id": { "description": "The ID of the schedule", "type": "string" }, "shift_data": { "description": "The data of the shift", "properties": { "end_time": { "description": "The end time of the shift", "type": "string" }, "notes": { "description": "Notes for the shift, max length 256 characters", "maxLength": 256, "type": "string" }, "shift_breaks": { "description": "The breaks of the shift", "items": { "$ref": "#/components/schemas/OutputRestApiShiftBreak314820414f10" }, "type": "array" }, "shift_segments": { "description": "The segments of the shift", "items": { "$ref": "#/components/schemas/OutputRestApiShiftSegment2a530a829033" }, "type": "array" }, "start_time": { "description": "The start time of the shift", "type": "string" } }, "required": [ "end_time", "start_time" ], "title": "ShiftData", "type": "object" }, "target_count": { "anyOf": [ { "description": "The target count of the shift", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "is_published", "schedule_id", "shift_data", "target_count", "updated_at" ], "title": "UnassignedShift", "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Create a new unassigned shift", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "unassignedshifts.read-write" ] } }, "/unassignedshifts/{id}/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/get-unassignedshifts" }, "operationId": "rippling.rest_api.get_unassignedshifts", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "id", "type": "string" } }, { "in": "query", "name": "expand", "required": false, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "__meta": { "properties": { "redacted_fields": { "items": { "$ref": "#/components/schemas/OutputRestApiRedactedField21788a25ef22" }, "type": "array" } }, "type": "object" }, "assigned_count": { "anyOf": [ { "description": "The number of assigned shifts", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "assigned_shift_ids": { "description": "The IDs of the assigned shifts that are part of this unassigned shift", "items": { "type": "string" }, "type": "array" }, "created_at": { "description": "Record creation date", "type": "string" }, "custom_fields": { "description": "Custom fields for the unassigned shift", "items": { "additionalProperties": {} }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "is_published": { "description": "Whether the shift is published", "type": "boolean" }, "open_shift_config": { "description": "Configuration for an open shift. If present, this is an open shift (workers can sign up). If absent/None, this is an empty shift (placeholder).", "properties": {}, "title": "OpenShiftConfig", "type": "object" }, "published_version": { "description": "The published version of the shift", "properties": { "end_time": { "description": "The end time of the shift", "type": "string" }, "notes": { "description": "Notes for the shift, max length 256 characters", "maxLength": 256, "type": "string" }, "shift_breaks": { "description": "The breaks of the shift", "items": { "$ref": "#/components/schemas/OutputRestApiShiftBreak314820414f10" }, "type": "array" }, "shift_segments": { "description": "The segments of the shift", "items": { "$ref": "#/components/schemas/OutputRestApiShiftSegment2a530a829033" }, "type": "array" }, "start_time": { "description": "The start time of the shift", "type": "string" } }, "required": [ "end_time", "start_time" ], "title": "ShiftData", "type": "object" }, "schedule": { "description": "The schedule\n\nExpandable field", "properties": { "can_edit": { "description": "Whether the requesting role can edit the schedule.", "type": "boolean" }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "managers": { "description": "The managers of the schedule.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiWorker75ef4092b644" }, "type": "array" }, "managers_id": { "description": "The IDs of the managers of the schedule.", "items": { "type": "string" }, "type": "array" }, "members": { "description": "The members of the schedule.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiWorker75ef4092b644" }, "type": "array" }, "members_id": { "description": "The IDs of the members of the schedule.", "items": { "type": "string" }, "type": "array" }, "name": { "description": "The name of the schedule.", "type": "string" }, "observers": { "description": "The observers of the schedule.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiWorker75ef4092b644" }, "type": "array" }, "observers_id": { "description": "The IDs of the observers of the schedule.", "items": { "type": "string" }, "type": "array" }, "settings": { "description": "The settings of the schedule.", "properties": { "timezone": { "description": "The IANA timezone identifier for the schedule (e.g., 'America/New_York'). Accepted values are defined by the tz database, listed here: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones", "type": "string" } }, "title": "ScheduleSettings", "type": "object" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Schedule", "type": "object" }, "schedule_id": { "description": "The ID of the schedule", "type": "string" }, "shift_data": { "description": "The data of the shift", "properties": { "end_time": { "description": "The end time of the shift", "type": "string" }, "notes": { "description": "Notes for the shift, max length 256 characters", "maxLength": 256, "type": "string" }, "shift_breaks": { "description": "The breaks of the shift", "items": { "$ref": "#/components/schemas/OutputRestApiShiftBreak314820414f10" }, "type": "array" }, "shift_segments": { "description": "The segments of the shift", "items": { "$ref": "#/components/schemas/OutputRestApiShiftSegment2a530a829033" }, "type": "array" }, "start_time": { "description": "The start time of the shift", "type": "string" } }, "required": [ "end_time", "start_time" ], "title": "ShiftData", "type": "object" }, "target_count": { "anyOf": [ { "description": "The target count of the shift", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "is_published", "schedule_id", "shift_data", "target_count", "updated_at" ], "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Retrieve a specific unassigned shift", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "unassignedshifts.read" ] }, "patch": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/update-unassignedshifts" }, "operationId": "rippling.rest_api.update_unassignedshifts", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "id", "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiUnassignedShiftUpdateRequesteed03fbd95e9" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "assigned_count": { "anyOf": [ { "description": "The number of assigned shifts", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "assigned_shift_ids": { "description": "The IDs of the assigned shifts that are part of this unassigned shift", "items": { "type": "string" }, "type": "array" }, "created_at": { "description": "Record creation date", "type": "string" }, "custom_fields": { "description": "Custom fields for the unassigned shift", "items": { "additionalProperties": {} }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "is_published": { "description": "Whether the shift is published", "type": "boolean" }, "open_shift_config": { "description": "Configuration for an open shift. If present, this is an open shift (workers can sign up). If absent/None, this is an empty shift (placeholder).", "properties": {}, "title": "OpenShiftConfig", "type": "object" }, "published_version": { "description": "The published version of the shift", "properties": { "end_time": { "description": "The end time of the shift", "type": "string" }, "notes": { "description": "Notes for the shift, max length 256 characters", "maxLength": 256, "type": "string" }, "shift_breaks": { "description": "The breaks of the shift", "items": { "$ref": "#/components/schemas/OutputRestApiShiftBreak314820414f10" }, "type": "array" }, "shift_segments": { "description": "The segments of the shift", "items": { "$ref": "#/components/schemas/OutputRestApiShiftSegment2a530a829033" }, "type": "array" }, "start_time": { "description": "The start time of the shift", "type": "string" } }, "required": [ "end_time", "start_time" ], "title": "ShiftData", "type": "object" }, "schedule": { "description": "The schedule\n\nExpandable field", "properties": { "can_edit": { "description": "Whether the requesting role can edit the schedule.", "type": "boolean" }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "managers": { "description": "The managers of the schedule.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiWorker75ef4092b644" }, "type": "array" }, "managers_id": { "description": "The IDs of the managers of the schedule.", "items": { "type": "string" }, "type": "array" }, "members": { "description": "The members of the schedule.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiWorker75ef4092b644" }, "type": "array" }, "members_id": { "description": "The IDs of the members of the schedule.", "items": { "type": "string" }, "type": "array" }, "name": { "description": "The name of the schedule.", "type": "string" }, "observers": { "description": "The observers of the schedule.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiWorker75ef4092b644" }, "type": "array" }, "observers_id": { "description": "The IDs of the observers of the schedule.", "items": { "type": "string" }, "type": "array" }, "settings": { "description": "The settings of the schedule.", "properties": { "timezone": { "description": "The IANA timezone identifier for the schedule (e.g., 'America/New_York'). Accepted values are defined by the tz database, listed here: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones", "type": "string" } }, "title": "ScheduleSettings", "type": "object" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Schedule", "type": "object" }, "schedule_id": { "description": "The ID of the schedule", "type": "string" }, "shift_data": { "description": "The data of the shift", "properties": { "end_time": { "description": "The end time of the shift", "type": "string" }, "notes": { "description": "Notes for the shift, max length 256 characters", "maxLength": 256, "type": "string" }, "shift_breaks": { "description": "The breaks of the shift", "items": { "$ref": "#/components/schemas/OutputRestApiShiftBreak314820414f10" }, "type": "array" }, "shift_segments": { "description": "The segments of the shift", "items": { "$ref": "#/components/schemas/OutputRestApiShiftSegment2a530a829033" }, "type": "array" }, "start_time": { "description": "The start time of the shift", "type": "string" } }, "required": [ "end_time", "start_time" ], "title": "ShiftData", "type": "object" }, "target_count": { "anyOf": [ { "description": "The target count of the shift", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "is_published", "schedule_id", "shift_data", "target_count", "updated_at" ], "title": "UnassignedShift", "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Update a unassigned shift", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "unassignedshifts.read-write" ] } }, "/unassignedshifts/{id}/assign/": { "post": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/assign-unassignedshifts" }, "operationId": "rippling.rest_api.assign_unassignedshifts", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "worker_id": { "description": "The ID of the worker (role) to assign to the shift", "type": "string" } }, "required": [ "worker_id" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "assigned_count": { "anyOf": [ { "description": "The current number of assigned workers for this shift", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "assigned_shift_ids": { "description": "List of shift assignment IDs for this shift", "items": { "type": "string" }, "type": "array" }, "assignment_id": { "description": "The ID of the newly created shift assignment", "type": "string" }, "target_count": { "anyOf": [ { "description": "The target number of workers for this shift", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Assign a worker to an unassigned shift", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "unassignedshifts.read-write" ] } }, "/unassignedshifts/{id}/customfields/": { "patch": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/update-unassignedshifts-customfields" }, "operationId": "rippling.rest_api.update_unassignedshifts_customfields", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "description": "Dictionary mapping custom field names to their values. Field names are dynamic and depend on your company's custom field configuration.", "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "__meta": { "properties": { "redacted_fields": { "items": { "$ref": "#/components/schemas/OutputRestApiRedactedField21788a25ef22" }, "type": "array" } }, "type": "object" }, "assigned_count": { "anyOf": [ { "description": "The number of assigned shifts", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "assigned_shift_ids": { "description": "The IDs of the assigned shifts that are part of this unassigned shift", "items": { "type": "string" }, "type": "array" }, "created_at": { "description": "Record creation date", "type": "string" }, "custom_fields": { "description": "Custom fields for the unassigned shift", "items": { "additionalProperties": {} }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "is_published": { "description": "Whether the shift is published", "type": "boolean" }, "open_shift_config": { "description": "Configuration for an open shift. If present, this is an open shift (workers can sign up). If absent/None, this is an empty shift (placeholder).", "properties": {}, "title": "OpenShiftConfig", "type": "object" }, "published_version": { "description": "The published version of the shift", "properties": { "end_time": { "description": "The end time of the shift", "type": "string" }, "notes": { "description": "Notes for the shift, max length 256 characters", "maxLength": 256, "type": "string" }, "shift_breaks": { "description": "The breaks of the shift", "items": { "$ref": "#/components/schemas/OutputRestApiShiftBreak314820414f10" }, "type": "array" }, "shift_segments": { "description": "The segments of the shift", "items": { "$ref": "#/components/schemas/OutputRestApiShiftSegment2a530a829033" }, "type": "array" }, "start_time": { "description": "The start time of the shift", "type": "string" } }, "required": [ "end_time", "start_time" ], "title": "ShiftData", "type": "object" }, "schedule": { "description": "The schedule\n\nExpandable field", "properties": { "can_edit": { "description": "Whether the requesting role can edit the schedule.", "type": "boolean" }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "managers": { "description": "The managers of the schedule.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiWorker75ef4092b644" }, "type": "array" }, "managers_id": { "description": "The IDs of the managers of the schedule.", "items": { "type": "string" }, "type": "array" }, "members": { "description": "The members of the schedule.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiWorker75ef4092b644" }, "type": "array" }, "members_id": { "description": "The IDs of the members of the schedule.", "items": { "type": "string" }, "type": "array" }, "name": { "description": "The name of the schedule.", "type": "string" }, "observers": { "description": "The observers of the schedule.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiWorker75ef4092b644" }, "type": "array" }, "observers_id": { "description": "The IDs of the observers of the schedule.", "items": { "type": "string" }, "type": "array" }, "settings": { "description": "The settings of the schedule.", "properties": { "timezone": { "description": "The IANA timezone identifier for the schedule (e.g., 'America/New_York'). Accepted values are defined by the tz database, listed here: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones", "type": "string" } }, "title": "ScheduleSettings", "type": "object" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Schedule", "type": "object" }, "schedule_id": { "description": "The ID of the schedule", "type": "string" }, "shift_data": { "description": "The data of the shift", "properties": { "end_time": { "description": "The end time of the shift", "type": "string" }, "notes": { "description": "Notes for the shift, max length 256 characters", "maxLength": 256, "type": "string" }, "shift_breaks": { "description": "The breaks of the shift", "items": { "$ref": "#/components/schemas/OutputRestApiShiftBreak314820414f10" }, "type": "array" }, "shift_segments": { "description": "The segments of the shift", "items": { "$ref": "#/components/schemas/OutputRestApiShiftSegment2a530a829033" }, "type": "array" }, "start_time": { "description": "The start time of the shift", "type": "string" } }, "required": [ "end_time", "start_time" ], "title": "ShiftData", "type": "object" }, "target_count": { "anyOf": [ { "description": "The target count of the shift", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "is_published", "schedule_id", "shift_data", "target_count", "updated_at" ], "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Update custom fields for a unassigned shift", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "unassignedshifts.read-write" ] } }, "/users/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/list-users" }, "operationId": "rippling.rest_api.list_users", "parameters": [ { "in": "query", "name": "order_by", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 100, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "__meta": { "$ref": "#/components/schemas/OutputRestApiRedactedFields9f7657dc2a2f" }, "next_link": { "description": "A link to the next page of responses.", "format": "uri", "type": "string" }, "results": { "items": { "$ref": "#/components/schemas/OutputRestApiUser48488eefe451" }, "type": "array" } }, "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "List users", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "users.read" ] } }, "/users/{id}/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/get-users" }, "operationId": "rippling.rest_api.get_users", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "id", "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "__meta": { "properties": { "redacted_fields": { "items": { "$ref": "#/components/schemas/OutputRestApiRedactedField21788a25ef22" }, "type": "array" } }, "type": "object" }, "active": { "description": "Whether the user is able to access company resources, typically when they are in actively engaged with the company and not after off-boarding.", "type": "boolean" }, "addresses": { "description": "The user's addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiUserAddressedd59b9ba9a1" }, "type": "array" }, "created_at": { "description": "Record creation date", "type": "string" }, "display_name": { "description": "The display name of the user using either the concatenated preferred given and family name or username depending on availability.", "type": "string" }, "emails": { "description": "The user's email addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiEmail5284c8258dc3" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "locale": { "description": "The User's default location for purposes of localization of currency, date time format, or numerical representations pursuant to RFC5646.", "type": "string" }, "name": { "description": "The user's name.", "properties": { "family_name": { "description": "The legal family name of the user, or last name in most Western languages.", "type": "string" }, "formatted": { "description": "The user's full name.", "type": "string" }, "given_name": { "description": "The given legal name of the user, or first name in most Western languages.", "type": "string" }, "middle_name": { "description": "The middle name(s) of the user.", "type": "string" }, "preferred_family_name": { "description": "The preferred family name, or last name in most Western languages, by the user.", "type": "string" }, "preferred_given_name": { "description": "The preferred given name, or first name in most Western languages, by the user.", "type": "string" } }, "title": "UserName", "type": "object" }, "number": { "description": "The permanent profile number of the user.", "type": "string" }, "phone_numbers": { "description": "The user's phone numbers.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoneNumber12060c61ecf5" }, "type": "array" }, "photos": { "description": "The user's photos.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoto2be7c3ae3f39" }, "type": "array" }, "preferred_language": { "description": "The User's preferred written or spoken language in the same format of the HTTP Accept-Language header, pursuant to Section 5.3.5 of RFC7231.", "type": "string" }, "timezone": { "description": "The User's current time zone in IANA database Olson format", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "username": { "description": "The unique identifier across Rippling used by the User for direct authentication into their associated company. Globally unique.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Retrieve a specific user", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "users.read" ] } }, "/variable-compensation-payout-labels/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/list-variable-compensation-payout-labels" }, "operationId": "rippling.rest_api.list_variable_compensation_payout_labels", "parameters": [ { "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "client", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "external_id", "required": false, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "__meta": { "$ref": "#/components/schemas/OutputRestApiRedactedFields9f7657dc2a2f" }, "next_link": { "description": "A link to the next page of responses.", "format": "uri", "type": "string" }, "results": { "items": { "$ref": "#/components/schemas/OutputRestApiVariableCompensationPayoutLabelac9fd58b0f9b" }, "type": "array" } }, "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "List variable compensation payout labels", "x-rippling-entitlements": [ "Variable_Compensation_Scheduled_Payouts_API" ], "x-rippling-required-scopes": [ "variable-compensation-payout-labels.read" ] }, "post": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/create-variable-compensation-payout-labels" }, "operationId": "rippling.rest_api.create_variable_compensation_payout_labels", "parameters": [ { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiVariableCompensationPayoutLabelRequest60f3ef2b1788" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "client": { "description": "Client system that created the label.", "type": "string" }, "external_id": { "description": "External identifier unique per company and client.", "type": "string" }, "id": { "description": "Unique identifier of the payout label.", "type": "string" }, "name": { "description": "Display name of the label.", "type": "string" } }, "required": [ "client", "external_id", "id", "name" ], "title": "VariableCompensationPayoutLabel", "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Create a new variable compensation payout label", "x-rippling-entitlements": [ "Variable_Compensation_Scheduled_Payouts_API" ], "x-rippling-required-scopes": [ "variable-compensation-payout-labels.read-write" ] } }, "/variable-compensation-payout-labels/{id}/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/get-variable-compensation-payout-labels" }, "operationId": "rippling.rest_api.get_variable_compensation_payout_labels", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "id", "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "__meta": { "properties": { "redacted_fields": { "items": { "$ref": "#/components/schemas/OutputRestApiRedactedField21788a25ef22" }, "type": "array" } }, "type": "object" }, "client": { "description": "Client system that created the label.", "type": "string" }, "external_id": { "description": "External identifier unique per company and client.", "type": "string" }, "id": { "description": "Unique identifier of the payout label.", "type": "string" }, "name": { "description": "Display name of the label.", "type": "string" } }, "required": [ "client", "external_id", "id", "name" ], "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Retrieve a specific variable compensation payout label", "x-rippling-entitlements": [ "Variable_Compensation_Scheduled_Payouts_API" ], "x-rippling-required-scopes": [ "variable-compensation-payout-labels.read" ] }, "patch": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/update-variable-compensation-payout-labels" }, "operationId": "rippling.rest_api.update_variable_compensation_payout_labels", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "id", "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiVariableCompensationPayoutLabelRequest60f3ef2b1788" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "client": { "description": "Client system that created the label.", "type": "string" }, "external_id": { "description": "External identifier unique per company and client.", "type": "string" }, "id": { "description": "Unique identifier of the payout label.", "type": "string" }, "name": { "description": "Display name of the label.", "type": "string" } }, "required": [ "client", "external_id", "id", "name" ], "title": "VariableCompensationPayoutLabel", "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Update a variable compensation payout label", "x-rippling-entitlements": [ "Variable_Compensation_Scheduled_Payouts_API" ], "x-rippling-required-scopes": [ "variable-compensation-payout-labels.read-write" ] } }, "/variable-compensation-payout-types/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/list-variable-compensation-payout-types" }, "operationId": "rippling.rest_api.list_variable_compensation_payout_types", "parameters": [ { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "__meta": { "$ref": "#/components/schemas/OutputRestApiRedactedFields9f7657dc2a2f" }, "next_link": { "description": "A link to the next page of responses.", "format": "uri", "type": "string" }, "results": { "items": { "$ref": "#/components/schemas/OutputRestApiVariableCompensationPayoutTypee8efc0d38fe3" }, "type": "array" } }, "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "List variable compensation payout types", "x-rippling-entitlements": [ "Variable_Compensation_Scheduled_Payouts_API" ], "x-rippling-required-scopes": [ "variable-compensation-payout-types.read" ] }, "post": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/create-variable-compensation-payout-types" }, "operationId": "rippling.rest_api.create_variable_compensation_payout_types", "parameters": [ { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiVariableCompensationPayoutTypeRequest4e2e227a6620" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "created_by": { "description": "ID of the worker who created this custom payout type.", "type": "string" }, "display_name": { "description": "Display name of the payout type.", "type": "string" }, "id": { "description": "Unique identifier of the payout type. Same as key.", "type": "string" }, "is_system": { "description": "Whether this is a built-in payout type.", "type": "boolean" }, "key": { "description": "Stable payout type key assigned by the server on create.", "type": "string" }, "mappings": { "description": "Per-entity earning code mappings.", "items": { "$ref": "#/components/schemas/OutputRestApiVariableCompensationPayoutTypeMapping70ecab311989" }, "type": "array" } }, "required": [ "display_name", "id", "is_system", "key" ], "title": "VariableCompensationPayoutType", "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Create a new variable compensation payout type", "x-rippling-entitlements": [ "Variable_Compensation_Scheduled_Payouts_API" ], "x-rippling-required-scopes": [ "variable-compensation-payout-types.read-write" ] } }, "/variable-compensation-payout-types/{id}/": { "delete": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/delete-variable-compensation-payout-types" }, "operationId": "rippling.rest_api.delete_variable_compensation_payout_types", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "id", "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "204": { "description": "The resource was deleted successfully" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Delete a variable compensation payout type", "x-rippling-entitlements": [ "Variable_Compensation_Scheduled_Payouts_API" ], "x-rippling-required-scopes": [ "variable-compensation-payout-types.read-write" ] }, "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/get-variable-compensation-payout-types" }, "operationId": "rippling.rest_api.get_variable_compensation_payout_types", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "id", "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "__meta": { "properties": { "redacted_fields": { "items": { "$ref": "#/components/schemas/OutputRestApiRedactedField21788a25ef22" }, "type": "array" } }, "type": "object" }, "created_by": { "description": "ID of the worker who created this custom payout type.", "type": "string" }, "display_name": { "description": "Display name of the payout type.", "type": "string" }, "id": { "description": "Unique identifier of the payout type. Same as key.", "type": "string" }, "is_system": { "description": "Whether this is a built-in payout type.", "type": "boolean" }, "key": { "description": "Stable payout type key assigned by the server on create.", "type": "string" }, "mappings": { "description": "Per-entity earning code mappings.", "items": { "$ref": "#/components/schemas/OutputRestApiVariableCompensationPayoutTypeMapping70ecab311989" }, "type": "array" } }, "required": [ "display_name", "id", "is_system", "key" ], "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Retrieve a specific variable compensation payout type", "x-rippling-entitlements": [ "Variable_Compensation_Scheduled_Payouts_API" ], "x-rippling-required-scopes": [ "variable-compensation-payout-types.read" ] }, "patch": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/update-variable-compensation-payout-types" }, "operationId": "rippling.rest_api.update_variable_compensation_payout_types", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "id", "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiVariableCompensationPayoutTypeRequest4e2e227a6620" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "created_by": { "description": "ID of the worker who created this custom payout type.", "type": "string" }, "display_name": { "description": "Display name of the payout type.", "type": "string" }, "id": { "description": "Unique identifier of the payout type. Same as key.", "type": "string" }, "is_system": { "description": "Whether this is a built-in payout type.", "type": "boolean" }, "key": { "description": "Stable payout type key assigned by the server on create.", "type": "string" }, "mappings": { "description": "Per-entity earning code mappings.", "items": { "$ref": "#/components/schemas/OutputRestApiVariableCompensationPayoutTypeMapping70ecab311989" }, "type": "array" } }, "required": [ "display_name", "id", "is_system", "key" ], "title": "VariableCompensationPayoutType", "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Update a variable compensation payout type", "x-rippling-entitlements": [ "Variable_Compensation_Scheduled_Payouts_API" ], "x-rippling-required-scopes": [ "variable-compensation-payout-types.read-write" ] } }, "/variable-compensation-payout-writes/": { "post": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/create-variable-compensation-payout-writes" }, "operationId": "rippling.rest_api.create_variable_compensation_payout_writes", "parameters": [ { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiVariableCompensationPayoutWriteRequest5967d891135e" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "ai_conditions_summary": { "description": "Optional markdown summary of the eligibility conditions.", "type": "string" }, "amount_base": { "description": "Payout amount.", "properties": { "currency_type": { "description": "Three-letter currency code.", "type": "string" }, "value": { "description": "Decimal payout amount encoded as a string.", "type": "string" } }, "required": [ "currency_type", "value" ], "title": "PayoutCurrency", "type": "object" }, "eligibility_sql": { "description": "SQL eligibility expression. Omit to use the active-role default.", "type": "string" }, "group_name": { "description": "Optional payout group label.", "type": "string" }, "payee_id": { "description": "ID of the worker who receives this payout.", "type": "string" }, "payment_type": { "description": "Key of the company payment type used for this payout.", "type": "string" }, "payout_id": { "description": "ID of the created payout.", "type": "string" }, "scheduled_date": { "description": "Date on which the payout is scheduled.", "type": "string" }, "status": { "description": "Resulting payout status.", "type": "string" } }, "required": [ "amount_base", "payee_id", "payment_type", "scheduled_date" ], "title": "VariableCompensationPayoutWrite", "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Create a new variable compensation payout write", "x-rippling-entitlements": [ "Internal_Testing" ], "x-rippling-required-scopes": [ "variable-compensation-payout-writes.read-write" ] } }, "/variable-compensation-payouts/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/list-variable-compensation-payouts" }, "operationId": "rippling.rest_api.list_variable_compensation_payouts", "parameters": [ { "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "payee_id", "required": false, "schema": { "format": "id", "type": "string" } }, { "in": "query", "name": "client", "required": false, "schema": { "enum": [ "VC_PLAN_CYCLE", "VC_EVENT_DRIVEN_PLAN", "CUSTOM", "MANUAL_PAYOUT", "HRIS_SIGN_ON", "OFFLINE_RECOMMENDATION" ], "type": "string" } }, { "in": "query", "name": "external_id", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "status", "required": false, "schema": { "enum": [ "DRAFT", "PENDING_APPROVAL", "APPROVAL_REJECTED", "SCHEDULED", "RELEASED", "PAID", "FORFEITED", "EVALUATION_FAILED", "CANCELLED" ], "type": "string" } }, { "in": "query", "name": "source_label_id", "required": false, "schema": { "format": "id", "type": "string" } }, { "in": "query", "name": "group_label_id", "required": false, "schema": { "format": "id", "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "__meta": { "$ref": "#/components/schemas/OutputRestApiRedactedFields9f7657dc2a2f" }, "next_link": { "description": "A link to the next page of responses.", "format": "uri", "type": "string" }, "results": { "items": { "$ref": "#/components/schemas/OutputRestApiObligationLedgerPayout543916963034" }, "type": "array" } }, "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "List variable compensation payouts", "x-rippling-entitlements": [ "Variable_Compensation_Scheduled_Payouts_API" ], "x-rippling-required-scopes": [ "variable-compensation-payouts.read" ] }, "post": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/create-variable-compensation-payouts" }, "operationId": "rippling.rest_api.create_variable_compensation_payouts", "parameters": [ { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiObligationLedgerPayoutRequest49ac5316604e" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "amount_base": { "description": "Payout amount in the worker's base currency.", "properties": { "currency_type": { "description": "Three-letter currency code.", "type": "string" }, "value": { "description": "Decimal amount encoded as a string.", "type": "string" } }, "required": [ "currency_type", "value" ], "title": "ObligationLedgerPayoutCurrency", "type": "object" }, "amount_usd": { "description": "Payout amount converted to USD.", "properties": { "currency_type": { "description": "Three-letter currency code.", "type": "string" }, "value": { "description": "Decimal amount encoded as a string.", "type": "string" } }, "required": [ "currency_type", "value" ], "title": "ObligationLedgerPayoutCurrency", "type": "object" }, "cancel_reason": { "description": "Reason provided when the payout was cancelled.", "type": "string" }, "client": { "description": "Client system that created the payout.", "type": "string" }, "created_at": { "description": "When the payout was created.", "type": "string" }, "description": { "description": "Optional payout description.", "type": "string" }, "effective_end_date": { "description": "End date of the covered pay period.", "type": "string" }, "effective_start_date": { "description": "Start date of the covered pay period.", "type": "string" }, "external_id": { "description": "External identifier unique per company and client.", "type": "string" }, "group_label_id": { "description": "Group label identifier attached to the payout. Expand is deferred from v1; use GET /variable-compensation-payout-labels/{id}/ when needed.", "type": "string" }, "id": { "description": "Unique identifier of the payout.", "type": "string" }, "name": { "description": "Optional payout name.", "type": "string" }, "pay_classification": { "description": "Payroll earning code resolved from the payout type.", "type": "string" }, "payee_id": { "description": "ID of the worker who receives this payout. Expandable payee (Worker DTO + workers.read) is deferred from v1; use GET /workers/{id}/ when needed.", "type": "string" }, "payout_type": { "description": "Key of the company payout type used for this payout. Expand is deferred from v1; enumerate valid keys via GET /variable-compensation-payout-types/.", "type": "string" }, "paystub_id": { "description": "Paystub identifier when the payout has been synced to payroll.", "type": "string" }, "scheduled_date": { "description": "Date on which the payout is scheduled.", "type": "string" }, "source_label_id": { "description": "Source label identifier attached to the payout. Expand is deferred from v1; use GET /variable-compensation-payout-labels/{id}/ when needed.", "type": "string" }, "status": { "description": "Current payout status.", "type": "string" }, "updated_at": { "description": "When the payout was last updated.", "type": "string" } }, "required": [ "amount_base", "amount_usd", "client", "created_at", "effective_end_date", "effective_start_date", "external_id", "id", "payee_id", "payout_type", "scheduled_date", "status", "updated_at" ], "title": "ObligationLedgerPayout", "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Create a new variable compensation payout", "x-rippling-entitlements": [ "Variable_Compensation_Scheduled_Payouts_API" ], "x-rippling-required-scopes": [ "variable-compensation-payouts.read-write" ] } }, "/variable-compensation-payouts/{id}/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/get-variable-compensation-payouts" }, "operationId": "rippling.rest_api.get_variable_compensation_payouts", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "id", "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "__meta": { "properties": { "redacted_fields": { "items": { "$ref": "#/components/schemas/OutputRestApiRedactedField21788a25ef22" }, "type": "array" } }, "type": "object" }, "amount_base": { "description": "Payout amount in the worker's base currency.", "properties": { "currency_type": { "description": "Three-letter currency code.", "type": "string" }, "value": { "description": "Decimal amount encoded as a string.", "type": "string" } }, "required": [ "currency_type", "value" ], "title": "ObligationLedgerPayoutCurrency", "type": "object" }, "amount_usd": { "description": "Payout amount converted to USD.", "properties": { "currency_type": { "description": "Three-letter currency code.", "type": "string" }, "value": { "description": "Decimal amount encoded as a string.", "type": "string" } }, "required": [ "currency_type", "value" ], "title": "ObligationLedgerPayoutCurrency", "type": "object" }, "cancel_reason": { "description": "Reason provided when the payout was cancelled.", "type": "string" }, "client": { "description": "Client system that created the payout.", "type": "string" }, "created_at": { "description": "When the payout was created.", "type": "string" }, "description": { "description": "Optional payout description.", "type": "string" }, "effective_end_date": { "description": "End date of the covered pay period.", "type": "string" }, "effective_start_date": { "description": "Start date of the covered pay period.", "type": "string" }, "external_id": { "description": "External identifier unique per company and client.", "type": "string" }, "group_label_id": { "description": "Group label identifier attached to the payout. Expand is deferred from v1; use GET /variable-compensation-payout-labels/{id}/ when needed.", "type": "string" }, "id": { "description": "Unique identifier of the payout.", "type": "string" }, "name": { "description": "Optional payout name.", "type": "string" }, "pay_classification": { "description": "Payroll earning code resolved from the payout type.", "type": "string" }, "payee_id": { "description": "ID of the worker who receives this payout. Expandable payee (Worker DTO + workers.read) is deferred from v1; use GET /workers/{id}/ when needed.", "type": "string" }, "payout_type": { "description": "Key of the company payout type used for this payout. Expand is deferred from v1; enumerate valid keys via GET /variable-compensation-payout-types/.", "type": "string" }, "paystub_id": { "description": "Paystub identifier when the payout has been synced to payroll.", "type": "string" }, "scheduled_date": { "description": "Date on which the payout is scheduled.", "type": "string" }, "source_label_id": { "description": "Source label identifier attached to the payout. Expand is deferred from v1; use GET /variable-compensation-payout-labels/{id}/ when needed.", "type": "string" }, "status": { "description": "Current payout status.", "type": "string" }, "updated_at": { "description": "When the payout was last updated.", "type": "string" } }, "required": [ "amount_base", "amount_usd", "client", "created_at", "effective_end_date", "effective_start_date", "external_id", "id", "payee_id", "payout_type", "scheduled_date", "status", "updated_at" ], "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Retrieve a specific variable compensation payout", "x-rippling-entitlements": [ "Variable_Compensation_Scheduled_Payouts_API" ], "x-rippling-required-scopes": [ "variable-compensation-payouts.read" ] } }, "/work-locations/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/list-work-locations" }, "operationId": "rippling.rest_api.list_work_locations", "parameters": [ { "in": "query", "name": "order_by", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 100, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "__meta": { "$ref": "#/components/schemas/OutputRestApiRedactedFields9f7657dc2a2f" }, "next_link": { "description": "A link to the next page of responses.", "format": "uri", "type": "string" }, "results": { "items": { "$ref": "#/components/schemas/OutputRestApiWorkLocation3725da8ca0f2" }, "type": "array" } }, "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "List work locations", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "work-locations.read" ] }, "post": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/create-work-locations" }, "operationId": "rippling.rest_api.create_work_locations", "parameters": [ { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiWorkLocationRequest56fb7cd83268" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "address": { "description": "The address for the work location.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the work location.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "address", "created_at", "id", "name", "updated_at" ], "title": "WorkLocation", "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Create a new work location", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "work-locations.read-write" ] } }, "/work-locations/{id}/": { "delete": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/delete-work-locations" }, "operationId": "rippling.rest_api.delete_work_locations", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "id", "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "204": { "description": "The resource was deleted successfully" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Delete a work location", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "work-locations.read-write" ] }, "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/get-work-locations" }, "operationId": "rippling.rest_api.get_work_locations", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "id", "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "__meta": { "properties": { "redacted_fields": { "items": { "$ref": "#/components/schemas/OutputRestApiRedactedField21788a25ef22" }, "type": "array" } }, "type": "object" }, "address": { "description": "The address for the work location.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the work location.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "address", "created_at", "id", "name", "updated_at" ], "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Retrieve a specific work location", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "work-locations.read" ] }, "patch": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/update-work-locations" }, "operationId": "rippling.rest_api.update_work_locations", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "id", "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiWorkLocationUpdateRequestc0188076a6d1" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "address": { "description": "The address for the work location.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the work location.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "address", "created_at", "id", "name", "updated_at" ], "title": "WorkLocation", "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Update a work location", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "work-locations.read-write" ] } }, "/worker-change-fields/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/list-worker-change-fields" }, "operationId": "rippling.rest_api.list_worker_change_fields", "parameters": [ { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "__meta": { "$ref": "#/components/schemas/OutputRestApiRedactedFields9f7657dc2a2f" }, "next_link": { "description": "A link to the next page of responses.", "format": "uri", "type": "string" }, "results": { "items": { "$ref": "#/components/schemas/OutputRestApiWorkerChangeField60803486a969" }, "type": "array" } }, "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "List worker change fields", "x-rippling-entitlements": [ "Worker_Changes_API" ], "x-rippling-required-scopes": [ "worker-change-fields.read" ] } }, "/worker-changes/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/list-worker-changes" }, "operationId": "rippling.rest_api.list_worker_changes", "parameters": [ { "in": "query", "name": "filter", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "expand", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 100, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "__meta": { "$ref": "#/components/schemas/OutputRestApiRedactedFields9f7657dc2a2f" }, "next_link": { "description": "A link to the next page of responses.", "format": "uri", "type": "string" }, "results": { "items": { "$ref": "#/components/schemas/OutputRestApiWorkerChange40379b30fd23" }, "type": "array" } }, "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "List worker changes", "x-rippling-entitlements": [ "Worker_Changes_API" ], "x-rippling-required-scopes": [ "worker-changes.read" ] } }, "/worker-changes/{id}/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/get-worker-changes" }, "operationId": "rippling.rest_api.get_worker_changes", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "id", "type": "string" } }, { "in": "query", "name": "expand", "required": false, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "__meta": { "properties": { "redacted_fields": { "items": { "$ref": "#/components/schemas/OutputRestApiRedactedField21788a25ef22" }, "type": "array" } }, "type": "object" }, "applied_on": { "description": "When the change was persisted (approval time for changes that went through an approval workflow). UTC. Monotonically increasing as new commits land; use as the cursor axis for incremental polling.", "type": "string" }, "changed_by": { "description": "The actor as the current Worker DTO. Returned only when expand=changed_by is requested.\n\nExpandable field", "properties": { "business_partners": { "description": "Worker's assigned business partners. This field is only populated when explicitly requested via the expand parameter (e.g., ?expand=business_partners). When expanded, returns an empty list ([]) if the worker has no business partners.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiBusinessPartner77b00a069c32" }, "type": "array" }, "business_partners_id": { "description": "Worker's assigned business partners unique identifiers. Returns an empty list ([]) if the worker has no business partners.", "items": { "type": "string" }, "type": "array" }, "citizenship": { "description": "The countries that the worker has citizenship in.", "type": "string" }, "compensation": { "description": "The compensation package for the worker.\n\nExpandable field", "properties": { "annual_compensation": { "description": "The worker's annual compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "annual_salary_equivalent": { "description": "The worker's annual salary equivalent, for insurance purposes. It will be equal to the worker's annual compensation, except for owners that are receiving no cashcompensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "bonus_schedule": { "description": "The worker's bonus schedule.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "hourly_wage": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "id": { "description": "Identifier field", "type": "string" }, "monthly_compensation": { "description": "The worker's monthly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "on_target_commission": { "description": "The worker's on-target commission.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "payment_terms": { "description": "The payment terms for an worker's compensation.", "type": "string" }, "payment_type": { "description": "The payment type for an worker's compensation.", "type": "string" }, "relocation_reimbursement": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "salary_effective_date": { "description": "Salary effective date", "type": "string" }, "signing_bonus": { "description": "The worker's signing bonus.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus": { "description": "The worker's target annual bonus amount.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus_percent": { "anyOf": [ { "description": "The worker's target annual bonus as a percent of annual compensation.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" }, "weekly_compensation": { "description": "The worker's weekly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "worker": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's details.\n\nExpandable field", "type": "object" }, "worker_id": { "description": "The worker's ID.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Compensation", "type": "object" }, "compensation_grade": { "description": "The compensation grade assigned to the worker, if any.", "properties": { "id": { "description": "The compensation grade's unique identifier.", "type": "string" }, "label": { "description": "The compensation grade's label.", "type": "string" } }, "title": "WorkerCompensationGrade", "type": "object" }, "compensation_id": { "description": "The compensation package for the worker.", "type": "string" }, "country": { "description": "The worker's country.", "type": "string" }, "country_fields": { "description": "Country level fields for the worker.", "properties": { "ca": { "description": "Country-wise regional fields for Canada", "properties": { "sin": { "description": "Social Insurance Number (SIN) for Canada employees.", "type": "string" } }, "title": "CanadaFields", "type": "object" }, "nz": { "description": "Country-wise regional fields for New Zealand", "properties": { "ird_number": { "description": "Inland Revenue Department (IRD) number for New Zealand employees.", "type": "string" } }, "title": "NewZealandFields", "type": "object" }, "us": { "description": "Country-wise regional fields for USA", "properties": { "ssn": { "description": "Social Security Number (SSN) for US employees.", "type": "string" } }, "title": "USFields", "type": "object" } }, "title": "CountryFields", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "custom_fields": { "description": "Custom field values defined on the Employee object for this worker\n\nExpandable field", "items": { "additionalProperties": {} }, "type": "array" }, "date_of_birth": { "description": "The worker's date of birth.", "type": "string" }, "department": { "description": "The worker's assigned department.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "department_hierarchy": { "description": "List of departments in the department hierarchy. Refer department_hierarchy_ids for department hierarchy order.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestDepartment" }, "type": "array" }, "department_hierarchy_id": { "description": "The identifier of departments in the department hierarchy ordered from parent department to child department.", "items": { "type": "string" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the department.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestDepartment", "description": "The parent department.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent department.", "type": "string" }, "reference_code": { "description": "Reference code of the department.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Department", "type": "object" }, "department_id": { "description": "The worker's assigned department.", "type": "string" }, "employment_type": { "description": "The worker's employment type.\n\nExpandable field", "properties": { "amount_worked": { "description": "The amount worked for the employment type. * `FULL-TIME`: Full-time is at least 30 hours per week. Full-time workers will typically be eligible for benefits. * `PART-TIME`: Part-time is less than 30 hours per week. These workers may be eligible for benefits, depending on company settings and hours worked. * `TEMPORARY`: These workers are hired on a temporary basis. You can specify how each worker with this employment type will be paid individually.", "type": "string" }, "compensation_time_period": { "description": "The compensation period for the employment type. * `SALARIED`: Employees that are paid a fixed amount per year. * `HOURLY`: Employees that are paid a wage per hour worked.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "label": { "description": "The display label of the employment type.", "type": "string" }, "name": { "description": "The name of the employment type for non-custom employment types.", "type": "string" }, "type": { "description": "The classification of the worker by the company. * `CONTRACTOR`: Contractors are self-employed workers who provide services on a short-term or per-project basis and are not eligible for tax-withholding or benefits. * `EMPLOYEE`: Employees are hired and managed by an employer, work under the employer's direct supervision and control, and are protected by law for wages and employment rights.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "label", "updated_at" ], "title": "CompanyEmploymentType", "type": "object" }, "employment_type_id": { "description": "The worker's employment type.", "type": "string" }, "end_date": { "description": "The end date of the worker.", "type": "string" }, "ethnicity": { "description": "The identified ethnicity of the worker, if specified.", "type": "string" }, "gender": { "description": "The gender of the worker, if specified.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_manager": { "description": "Whether the worker is a manager", "type": "boolean" }, "job_function": { "description": "The worker's job function. When expanded, this field requires `job-functions.read`.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "Displayed name of the job function", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "JobFunction", "type": "object" }, "job_function_id": { "description": "ID of the worker's job function.", "type": "string" }, "legal_entity": { "description": "The worker's associated legal entity.\n\nExpandable field", "properties": { "company": { "description": "The company or organization associated with the legal entity\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "doing_business_as_name": { "description": "The doing business as name for the company.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_entities": { "description": "A list of the company's entities.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestLegalEntity" }, "type": "array" }, "legal_entities_id": { "description": "A list of the company's entities.", "items": { "type": "string" }, "type": "array" }, "legal_name": { "description": "The legal name of the company.", "type": "string" }, "name": { "description": "The name of the company.", "type": "string" }, "parent_legal_entity": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The company's ultimate holding entity.\n\nExpandable field", "type": "object" }, "parent_legal_entity_id": { "description": "The company's ultimate holding entity.", "type": "string" }, "phone": { "description": "The phone number for the company.", "type": "string" }, "physical_address": { "description": "The physical address of the holding entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "primary_email": { "description": "The email address used when registering this company.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "legal_entities", "legal_entities_id", "name", "updated_at" ], "title": "Company", "type": "object" }, "company_id": { "description": "The company or organization associated with the legal entity", "type": "string" }, "country": { "description": "The country the legal entity is based in.", "properties": { "code": { "description": "The code of the country.", "type": "string" } }, "required": [ "code" ], "title": "Country", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "entity_level": { "description": "The legal entity's level in a hierarchy. * `PARENT`: The legal entity is considered the ultimate holding entity. * `SUBSIDIARY`: The legal entity is considered a subsidiary, fully or partially held by another. * `BRANCH`: The legal entity is considered a branch, associated with a parent legal entity.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_name": { "description": "The legal name of the legal entity.", "type": "string" }, "mailing_address": { "description": "The mailing address of the legal entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "management_type": { "description": "The legal entity management type in the case of an employer of record (EOR) or professional employment organization (PEO). * `PEO`: The legal entity is considered a Professional Employment Organization (PEO). * `EOR`: The legal entity is considered an Employer of Record (EOR).", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The parent legal entity.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent legal entity.", "type": "string" }, "physical_address": { "description": "The physical address of the legal entity, if it differs from the mailing address.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "registration_date": { "description": "The registration date of the entity.", "type": "string" }, "tax_identifier": { "description": "The tax identifier for the legal entity.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "LegalEntity", "type": "object" }, "legal_entity_id": { "description": "The worker's associated legal entity.", "type": "string" }, "level": { "description": "The level of the worker.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "description": { "description": "The description of the level.", "type": "string" }, "experience_requirements": { "description": "The experience requirements for the level.", "type": "string" }, "global_level": { "anyOf": [ { "description": "Global level is used to track the seniority of levels. The higher up a level is placed on the page, the more senior and higher-ranked the level. Global level is used in workflows, policies, and reports that use the level attribute (e.g., you can use Level Lookup to set up a workflow that notifies the nearest person in an worker's management chain at or above the specified level).", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the level. Must be unique within the company or organization.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLevel", "description": "The parent level.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent level.", "type": "string" }, "rank": { "anyOf": [ { "description": "The rank of the level within its track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "scope_of_responsibilities": { "description": "The scope of responsibilities for the level.", "type": "string" }, "track": { "description": "The track associated with the level, if it's not a global level.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_default": { "description": "Whether this is the company's default track.", "type": "boolean" }, "name": { "description": "The name of the track. Must be unique within the company or organization.", "type": "string" }, "order": { "anyOf": [ { "description": "The one-based horizontal display order of the track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "start_global_level": { "anyOf": [ { "description": "The highest global level occupied by this track. Empty tracks return null.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Track", "type": "object" }, "track_id": { "description": "The track associated with the level. Required during creation. Include global_level when changing it.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Level", "type": "object" }, "level_id": { "description": "The level of the worker.", "type": "string" }, "location": { "description": "The location that the worker is mapped to for tax purposes. In the case that a worker is remote, the location's type is remote.", "properties": { "type": { "description": "The type of location.", "type": "string" }, "work_location_id": { "description": "The work location, if the worker isn't remote.", "type": "string" } }, "required": [ "type", "work_location_id" ], "title": "WorkerLocation", "type": "object" }, "manager": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's manager.\n\nExpandable field", "type": "object" }, "manager_id": { "description": "The worker's manager.", "type": "string" }, "number": { "anyOf": [ { "description": "The worker's number within the organization.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "original_start_date": { "description": "The worker's earliest start date across their employment history, excluding INIT roles.", "type": "string" }, "overtime_exemption": { "description": "The worker's overtime exemption status.", "type": "string" }, "pay_schedule_id": { "description": "The ID of the pay schedule currently associated with the worker.", "type": "string" }, "personal_email": { "description": "The worker's associated personal email address.", "type": "string" }, "race": { "description": "The identified race of the worker, if specified.", "type": "string" }, "start_date": { "description": "The start date of the worker.", "type": "string" }, "status": { "description": "The worker's status within the organization.", "type": "string" }, "teams": { "description": "The worker's assigned teams.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiTeamcb26bc28f32f" }, "type": "array" }, "teams_id": { "description": "The worker's assigned teams.", "items": { "type": "string" }, "type": "array" }, "termination_details": { "description": "The details of the worker's termination, if applicable.", "properties": { "reason": { "description": "This is a description that will be custom to each Rippling company.", "type": "string" }, "type": { "description": "The termination type indicates whether the termination was voluntary or involuntary.", "type": "string" } }, "title": "TerminationDetails", "type": "object" }, "title": { "description": "The worker's title.", "type": "string" }, "title_effective_date": { "description": "Title effective date", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "user": { "description": "The worker's associated user.\n\nExpandable field", "properties": { "active": { "description": "Whether the user is able to access company resources, typically when they are in actively engaged with the company and not after off-boarding.", "type": "boolean" }, "addresses": { "description": "The user's addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiUserAddressedd59b9ba9a1" }, "type": "array" }, "created_at": { "description": "Record creation date", "type": "string" }, "display_name": { "description": "The display name of the user using either the concatenated preferred given and family name or username depending on availability.", "type": "string" }, "emails": { "description": "The user's email addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiEmail5284c8258dc3" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "locale": { "description": "The User's default location for purposes of localization of currency, date time format, or numerical representations pursuant to RFC5646.", "type": "string" }, "name": { "description": "The user's name.", "properties": { "family_name": { "description": "The legal family name of the user, or last name in most Western languages.", "type": "string" }, "formatted": { "description": "The user's full name.", "type": "string" }, "given_name": { "description": "The given legal name of the user, or first name in most Western languages.", "type": "string" }, "middle_name": { "description": "The middle name(s) of the user.", "type": "string" }, "preferred_family_name": { "description": "The preferred family name, or last name in most Western languages, by the user.", "type": "string" }, "preferred_given_name": { "description": "The preferred given name, or first name in most Western languages, by the user.", "type": "string" } }, "title": "UserName", "type": "object" }, "number": { "description": "The permanent profile number of the user.", "type": "string" }, "phone_numbers": { "description": "The user's phone numbers.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoneNumber12060c61ecf5" }, "type": "array" }, "photos": { "description": "The user's photos.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoto2be7c3ae3f39" }, "type": "array" }, "preferred_language": { "description": "The User's preferred written or spoken language in the same format of the HTTP Accept-Language header, pursuant to Section 5.3.5 of RFC7231.", "type": "string" }, "timezone": { "description": "The User's current time zone in IANA database Olson format", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "username": { "description": "The unique identifier across Rippling used by the User for direct authentication into their associated company. Globally unique.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "User", "type": "object" }, "user_id": { "description": "The worker's associated user.", "type": "string" }, "work_email": { "description": "The worker's associated work email address.", "type": "string" }, "work_schedule": { "additionalProperties": { "$ref": "#/components/schemas/OutputRestApiWorkScheduleDay938f88d94f20" }, "description": "The worker's scheduled working hours for each day of the week.", "type": "object" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Worker", "type": "object" }, "changed_by_id": { "description": "Actor who made the change. Null for system-initiated events.", "type": "string" }, "changes": { "description": "Field-level changes captured by this event. Per-field REDACTED entries appear for fields the caller cannot read so consumers can detect that a change occurred even when the value is hidden. Events where every changed field is invisible to the caller — either internal fields not exposed via the public Object Graph, or fields the caller's role has zero read permission on — are dropped from the response entirely (they never appear with an all-REDACTED changes array).", "items": { "$ref": "#/components/schemas/OutputRestApiWorkerChangeFieldChangede534fd042b2" }, "type": "array" }, "created_at": { "description": "Record creation date", "type": "string" }, "effective_on": { "description": "When the change is true in the business domain. Can be past, present, or future. Independent of applied_on. UTC.", "type": "string" }, "event_type": { "description": "The lifecycle event type this change represents. CHANGE is the catch-all for non-lifecycle field edits.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "import_type": { "description": "INITIAL (census import at company onboarding) or HISTORICAL (historical data imported later). Set only when event_type is IMPORT.", "type": "string" }, "reason_code": { "description": "Structured transition reason (e.g. 'PROMOTION', 'MARKET_ADJUSTMENT'). Populated only when the company has configured transition reasons and the change went through a role transition with one selected. Null for most companies and events.", "type": "string" }, "referenced_transaction_id": { "description": "For amendments or undos, the id of the worker-change event being modified.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "worker": { "description": "The affected worker as the current Worker DTO. Returned only when expand=worker is requested. Includes terminated employees.\n\nExpandable field", "properties": { "business_partners": { "description": "Worker's assigned business partners. This field is only populated when explicitly requested via the expand parameter (e.g., ?expand=business_partners). When expanded, returns an empty list ([]) if the worker has no business partners.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiBusinessPartner77b00a069c32" }, "type": "array" }, "business_partners_id": { "description": "Worker's assigned business partners unique identifiers. Returns an empty list ([]) if the worker has no business partners.", "items": { "type": "string" }, "type": "array" }, "citizenship": { "description": "The countries that the worker has citizenship in.", "type": "string" }, "compensation": { "description": "The compensation package for the worker.\n\nExpandable field", "properties": { "annual_compensation": { "description": "The worker's annual compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "annual_salary_equivalent": { "description": "The worker's annual salary equivalent, for insurance purposes. It will be equal to the worker's annual compensation, except for owners that are receiving no cashcompensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "bonus_schedule": { "description": "The worker's bonus schedule.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "hourly_wage": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "id": { "description": "Identifier field", "type": "string" }, "monthly_compensation": { "description": "The worker's monthly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "on_target_commission": { "description": "The worker's on-target commission.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "payment_terms": { "description": "The payment terms for an worker's compensation.", "type": "string" }, "payment_type": { "description": "The payment type for an worker's compensation.", "type": "string" }, "relocation_reimbursement": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "salary_effective_date": { "description": "Salary effective date", "type": "string" }, "signing_bonus": { "description": "The worker's signing bonus.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus": { "description": "The worker's target annual bonus amount.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus_percent": { "anyOf": [ { "description": "The worker's target annual bonus as a percent of annual compensation.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" }, "weekly_compensation": { "description": "The worker's weekly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "worker": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's details.\n\nExpandable field", "type": "object" }, "worker_id": { "description": "The worker's ID.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Compensation", "type": "object" }, "compensation_grade": { "description": "The compensation grade assigned to the worker, if any.", "properties": { "id": { "description": "The compensation grade's unique identifier.", "type": "string" }, "label": { "description": "The compensation grade's label.", "type": "string" } }, "title": "WorkerCompensationGrade", "type": "object" }, "compensation_id": { "description": "The compensation package for the worker.", "type": "string" }, "country": { "description": "The worker's country.", "type": "string" }, "country_fields": { "description": "Country level fields for the worker.", "properties": { "ca": { "description": "Country-wise regional fields for Canada", "properties": { "sin": { "description": "Social Insurance Number (SIN) for Canada employees.", "type": "string" } }, "title": "CanadaFields", "type": "object" }, "nz": { "description": "Country-wise regional fields for New Zealand", "properties": { "ird_number": { "description": "Inland Revenue Department (IRD) number for New Zealand employees.", "type": "string" } }, "title": "NewZealandFields", "type": "object" }, "us": { "description": "Country-wise regional fields for USA", "properties": { "ssn": { "description": "Social Security Number (SSN) for US employees.", "type": "string" } }, "title": "USFields", "type": "object" } }, "title": "CountryFields", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "custom_fields": { "description": "Custom field values defined on the Employee object for this worker\n\nExpandable field", "items": { "additionalProperties": {} }, "type": "array" }, "date_of_birth": { "description": "The worker's date of birth.", "type": "string" }, "department": { "description": "The worker's assigned department.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "department_hierarchy": { "description": "List of departments in the department hierarchy. Refer department_hierarchy_ids for department hierarchy order.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestDepartment" }, "type": "array" }, "department_hierarchy_id": { "description": "The identifier of departments in the department hierarchy ordered from parent department to child department.", "items": { "type": "string" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the department.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestDepartment", "description": "The parent department.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent department.", "type": "string" }, "reference_code": { "description": "Reference code of the department.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Department", "type": "object" }, "department_id": { "description": "The worker's assigned department.", "type": "string" }, "employment_type": { "description": "The worker's employment type.\n\nExpandable field", "properties": { "amount_worked": { "description": "The amount worked for the employment type. * `FULL-TIME`: Full-time is at least 30 hours per week. Full-time workers will typically be eligible for benefits. * `PART-TIME`: Part-time is less than 30 hours per week. These workers may be eligible for benefits, depending on company settings and hours worked. * `TEMPORARY`: These workers are hired on a temporary basis. You can specify how each worker with this employment type will be paid individually.", "type": "string" }, "compensation_time_period": { "description": "The compensation period for the employment type. * `SALARIED`: Employees that are paid a fixed amount per year. * `HOURLY`: Employees that are paid a wage per hour worked.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "label": { "description": "The display label of the employment type.", "type": "string" }, "name": { "description": "The name of the employment type for non-custom employment types.", "type": "string" }, "type": { "description": "The classification of the worker by the company. * `CONTRACTOR`: Contractors are self-employed workers who provide services on a short-term or per-project basis and are not eligible for tax-withholding or benefits. * `EMPLOYEE`: Employees are hired and managed by an employer, work under the employer's direct supervision and control, and are protected by law for wages and employment rights.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "label", "updated_at" ], "title": "CompanyEmploymentType", "type": "object" }, "employment_type_id": { "description": "The worker's employment type.", "type": "string" }, "end_date": { "description": "The end date of the worker.", "type": "string" }, "ethnicity": { "description": "The identified ethnicity of the worker, if specified.", "type": "string" }, "gender": { "description": "The gender of the worker, if specified.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_manager": { "description": "Whether the worker is a manager", "type": "boolean" }, "job_function": { "description": "The worker's job function. When expanded, this field requires `job-functions.read`.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "Displayed name of the job function", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "JobFunction", "type": "object" }, "job_function_id": { "description": "ID of the worker's job function.", "type": "string" }, "legal_entity": { "description": "The worker's associated legal entity.\n\nExpandable field", "properties": { "company": { "description": "The company or organization associated with the legal entity\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "doing_business_as_name": { "description": "The doing business as name for the company.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_entities": { "description": "A list of the company's entities.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestLegalEntity" }, "type": "array" }, "legal_entities_id": { "description": "A list of the company's entities.", "items": { "type": "string" }, "type": "array" }, "legal_name": { "description": "The legal name of the company.", "type": "string" }, "name": { "description": "The name of the company.", "type": "string" }, "parent_legal_entity": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The company's ultimate holding entity.\n\nExpandable field", "type": "object" }, "parent_legal_entity_id": { "description": "The company's ultimate holding entity.", "type": "string" }, "phone": { "description": "The phone number for the company.", "type": "string" }, "physical_address": { "description": "The physical address of the holding entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "primary_email": { "description": "The email address used when registering this company.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "legal_entities", "legal_entities_id", "name", "updated_at" ], "title": "Company", "type": "object" }, "company_id": { "description": "The company or organization associated with the legal entity", "type": "string" }, "country": { "description": "The country the legal entity is based in.", "properties": { "code": { "description": "The code of the country.", "type": "string" } }, "required": [ "code" ], "title": "Country", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "entity_level": { "description": "The legal entity's level in a hierarchy. * `PARENT`: The legal entity is considered the ultimate holding entity. * `SUBSIDIARY`: The legal entity is considered a subsidiary, fully or partially held by another. * `BRANCH`: The legal entity is considered a branch, associated with a parent legal entity.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_name": { "description": "The legal name of the legal entity.", "type": "string" }, "mailing_address": { "description": "The mailing address of the legal entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "management_type": { "description": "The legal entity management type in the case of an employer of record (EOR) or professional employment organization (PEO). * `PEO`: The legal entity is considered a Professional Employment Organization (PEO). * `EOR`: The legal entity is considered an Employer of Record (EOR).", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The parent legal entity.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent legal entity.", "type": "string" }, "physical_address": { "description": "The physical address of the legal entity, if it differs from the mailing address.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "registration_date": { "description": "The registration date of the entity.", "type": "string" }, "tax_identifier": { "description": "The tax identifier for the legal entity.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "LegalEntity", "type": "object" }, "legal_entity_id": { "description": "The worker's associated legal entity.", "type": "string" }, "level": { "description": "The level of the worker.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "description": { "description": "The description of the level.", "type": "string" }, "experience_requirements": { "description": "The experience requirements for the level.", "type": "string" }, "global_level": { "anyOf": [ { "description": "Global level is used to track the seniority of levels. The higher up a level is placed on the page, the more senior and higher-ranked the level. Global level is used in workflows, policies, and reports that use the level attribute (e.g., you can use Level Lookup to set up a workflow that notifies the nearest person in an worker's management chain at or above the specified level).", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the level. Must be unique within the company or organization.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLevel", "description": "The parent level.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent level.", "type": "string" }, "rank": { "anyOf": [ { "description": "The rank of the level within its track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "scope_of_responsibilities": { "description": "The scope of responsibilities for the level.", "type": "string" }, "track": { "description": "The track associated with the level, if it's not a global level.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_default": { "description": "Whether this is the company's default track.", "type": "boolean" }, "name": { "description": "The name of the track. Must be unique within the company or organization.", "type": "string" }, "order": { "anyOf": [ { "description": "The one-based horizontal display order of the track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "start_global_level": { "anyOf": [ { "description": "The highest global level occupied by this track. Empty tracks return null.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Track", "type": "object" }, "track_id": { "description": "The track associated with the level. Required during creation. Include global_level when changing it.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Level", "type": "object" }, "level_id": { "description": "The level of the worker.", "type": "string" }, "location": { "description": "The location that the worker is mapped to for tax purposes. In the case that a worker is remote, the location's type is remote.", "properties": { "type": { "description": "The type of location.", "type": "string" }, "work_location_id": { "description": "The work location, if the worker isn't remote.", "type": "string" } }, "required": [ "type", "work_location_id" ], "title": "WorkerLocation", "type": "object" }, "manager": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's manager.\n\nExpandable field", "type": "object" }, "manager_id": { "description": "The worker's manager.", "type": "string" }, "number": { "anyOf": [ { "description": "The worker's number within the organization.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "original_start_date": { "description": "The worker's earliest start date across their employment history, excluding INIT roles.", "type": "string" }, "overtime_exemption": { "description": "The worker's overtime exemption status.", "type": "string" }, "pay_schedule_id": { "description": "The ID of the pay schedule currently associated with the worker.", "type": "string" }, "personal_email": { "description": "The worker's associated personal email address.", "type": "string" }, "race": { "description": "The identified race of the worker, if specified.", "type": "string" }, "start_date": { "description": "The start date of the worker.", "type": "string" }, "status": { "description": "The worker's status within the organization.", "type": "string" }, "teams": { "description": "The worker's assigned teams.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiTeamcb26bc28f32f" }, "type": "array" }, "teams_id": { "description": "The worker's assigned teams.", "items": { "type": "string" }, "type": "array" }, "termination_details": { "description": "The details of the worker's termination, if applicable.", "properties": { "reason": { "description": "This is a description that will be custom to each Rippling company.", "type": "string" }, "type": { "description": "The termination type indicates whether the termination was voluntary or involuntary.", "type": "string" } }, "title": "TerminationDetails", "type": "object" }, "title": { "description": "The worker's title.", "type": "string" }, "title_effective_date": { "description": "Title effective date", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "user": { "description": "The worker's associated user.\n\nExpandable field", "properties": { "active": { "description": "Whether the user is able to access company resources, typically when they are in actively engaged with the company and not after off-boarding.", "type": "boolean" }, "addresses": { "description": "The user's addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiUserAddressedd59b9ba9a1" }, "type": "array" }, "created_at": { "description": "Record creation date", "type": "string" }, "display_name": { "description": "The display name of the user using either the concatenated preferred given and family name or username depending on availability.", "type": "string" }, "emails": { "description": "The user's email addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiEmail5284c8258dc3" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "locale": { "description": "The User's default location for purposes of localization of currency, date time format, or numerical representations pursuant to RFC5646.", "type": "string" }, "name": { "description": "The user's name.", "properties": { "family_name": { "description": "The legal family name of the user, or last name in most Western languages.", "type": "string" }, "formatted": { "description": "The user's full name.", "type": "string" }, "given_name": { "description": "The given legal name of the user, or first name in most Western languages.", "type": "string" }, "middle_name": { "description": "The middle name(s) of the user.", "type": "string" }, "preferred_family_name": { "description": "The preferred family name, or last name in most Western languages, by the user.", "type": "string" }, "preferred_given_name": { "description": "The preferred given name, or first name in most Western languages, by the user.", "type": "string" } }, "title": "UserName", "type": "object" }, "number": { "description": "The permanent profile number of the user.", "type": "string" }, "phone_numbers": { "description": "The user's phone numbers.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoneNumber12060c61ecf5" }, "type": "array" }, "photos": { "description": "The user's photos.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoto2be7c3ae3f39" }, "type": "array" }, "preferred_language": { "description": "The User's preferred written or spoken language in the same format of the HTTP Accept-Language header, pursuant to Section 5.3.5 of RFC7231.", "type": "string" }, "timezone": { "description": "The User's current time zone in IANA database Olson format", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "username": { "description": "The unique identifier across Rippling used by the User for direct authentication into their associated company. Globally unique.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "User", "type": "object" }, "user_id": { "description": "The worker's associated user.", "type": "string" }, "work_email": { "description": "The worker's associated work email address.", "type": "string" }, "work_schedule": { "additionalProperties": { "$ref": "#/components/schemas/OutputRestApiWorkScheduleDay938f88d94f20" }, "description": "The worker's scheduled working hours for each day of the week.", "type": "object" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Worker", "type": "object" }, "worker_id": { "description": "The worker affected by this change.", "type": "string" } }, "required": [ "applied_on", "changes", "created_at", "effective_on", "event_type", "id", "updated_at", "worker_id" ], "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Retrieve a specific worker change", "x-rippling-entitlements": [ "Worker_Changes_API" ], "x-rippling-required-scopes": [ "worker-changes.read" ] } }, "/worker-time-splits/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/list-worker-time-splits" }, "operationId": "rippling.rest_api.list_worker_time_splits", "parameters": [ { "in": "query", "name": "filter", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "expand", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 100, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "__meta": { "$ref": "#/components/schemas/OutputRestApiRedactedFields9f7657dc2a2f" }, "next_link": { "description": "A link to the next page of responses.", "format": "uri", "type": "string" }, "results": { "items": { "$ref": "#/components/schemas/OutputRestApiWorkerTimeSplit791318857508" }, "type": "array" } }, "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "List worker time splits", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "worker-time-splits.read" ] }, "post": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/create-worker-time-splits" }, "operationId": "rippling.rest_api.create_worker_time_splits", "parameters": [ { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiWorkerTimeSplitRequest9e21ee5b724e" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Worker time split configuration resource.", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_enabled": { "description": "Whether hard-coded time splits are active for this worker.", "type": "boolean" }, "job_codes": { "description": "The job codes referenced in this time split configuration. Use ?expand=job_codes to populate.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiJobCodeeda25ec6c9a8" }, "type": "array" }, "job_codes_id": { "description": "IDs of all unique job codes referenced across all split rows.", "items": { "type": "string" }, "type": "array" }, "splits": { "description": "The split rows defining time allocation percentages across job codes. Empty when is_enabled is false.", "items": { "$ref": "#/components/schemas/OutputRestApiSplit283f489e3a65" }, "type": "array" }, "updated_at": { "description": "Record update date", "type": "string" }, "worker": { "description": "The worker associated with this time split configuration.\n\nExpandable field", "properties": { "business_partners": { "description": "Worker's assigned business partners. This field is only populated when explicitly requested via the expand parameter (e.g., ?expand=business_partners). When expanded, returns an empty list ([]) if the worker has no business partners.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiBusinessPartner77b00a069c32" }, "type": "array" }, "business_partners_id": { "description": "Worker's assigned business partners unique identifiers. Returns an empty list ([]) if the worker has no business partners.", "items": { "type": "string" }, "type": "array" }, "citizenship": { "description": "The countries that the worker has citizenship in.", "type": "string" }, "compensation": { "description": "The compensation package for the worker.\n\nExpandable field", "properties": { "annual_compensation": { "description": "The worker's annual compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "annual_salary_equivalent": { "description": "The worker's annual salary equivalent, for insurance purposes. It will be equal to the worker's annual compensation, except for owners that are receiving no cashcompensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "bonus_schedule": { "description": "The worker's bonus schedule.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "hourly_wage": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "id": { "description": "Identifier field", "type": "string" }, "monthly_compensation": { "description": "The worker's monthly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "on_target_commission": { "description": "The worker's on-target commission.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "payment_terms": { "description": "The payment terms for an worker's compensation.", "type": "string" }, "payment_type": { "description": "The payment type for an worker's compensation.", "type": "string" }, "relocation_reimbursement": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "salary_effective_date": { "description": "Salary effective date", "type": "string" }, "signing_bonus": { "description": "The worker's signing bonus.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus": { "description": "The worker's target annual bonus amount.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus_percent": { "anyOf": [ { "description": "The worker's target annual bonus as a percent of annual compensation.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" }, "weekly_compensation": { "description": "The worker's weekly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "worker": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's details.\n\nExpandable field", "type": "object" }, "worker_id": { "description": "The worker's ID.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Compensation", "type": "object" }, "compensation_grade": { "description": "The compensation grade assigned to the worker, if any.", "properties": { "id": { "description": "The compensation grade's unique identifier.", "type": "string" }, "label": { "description": "The compensation grade's label.", "type": "string" } }, "title": "WorkerCompensationGrade", "type": "object" }, "compensation_id": { "description": "The compensation package for the worker.", "type": "string" }, "country": { "description": "The worker's country.", "type": "string" }, "country_fields": { "description": "Country level fields for the worker.", "properties": { "ca": { "description": "Country-wise regional fields for Canada", "properties": { "sin": { "description": "Social Insurance Number (SIN) for Canada employees.", "type": "string" } }, "title": "CanadaFields", "type": "object" }, "nz": { "description": "Country-wise regional fields for New Zealand", "properties": { "ird_number": { "description": "Inland Revenue Department (IRD) number for New Zealand employees.", "type": "string" } }, "title": "NewZealandFields", "type": "object" }, "us": { "description": "Country-wise regional fields for USA", "properties": { "ssn": { "description": "Social Security Number (SSN) for US employees.", "type": "string" } }, "title": "USFields", "type": "object" } }, "title": "CountryFields", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "custom_fields": { "description": "Custom field values defined on the Employee object for this worker\n\nExpandable field", "items": { "additionalProperties": {} }, "type": "array" }, "date_of_birth": { "description": "The worker's date of birth.", "type": "string" }, "department": { "description": "The worker's assigned department.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "department_hierarchy": { "description": "List of departments in the department hierarchy. Refer department_hierarchy_ids for department hierarchy order.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestDepartment" }, "type": "array" }, "department_hierarchy_id": { "description": "The identifier of departments in the department hierarchy ordered from parent department to child department.", "items": { "type": "string" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the department.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestDepartment", "description": "The parent department.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent department.", "type": "string" }, "reference_code": { "description": "Reference code of the department.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Department", "type": "object" }, "department_id": { "description": "The worker's assigned department.", "type": "string" }, "employment_type": { "description": "The worker's employment type.\n\nExpandable field", "properties": { "amount_worked": { "description": "The amount worked for the employment type. * `FULL-TIME`: Full-time is at least 30 hours per week. Full-time workers will typically be eligible for benefits. * `PART-TIME`: Part-time is less than 30 hours per week. These workers may be eligible for benefits, depending on company settings and hours worked. * `TEMPORARY`: These workers are hired on a temporary basis. You can specify how each worker with this employment type will be paid individually.", "type": "string" }, "compensation_time_period": { "description": "The compensation period for the employment type. * `SALARIED`: Employees that are paid a fixed amount per year. * `HOURLY`: Employees that are paid a wage per hour worked.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "label": { "description": "The display label of the employment type.", "type": "string" }, "name": { "description": "The name of the employment type for non-custom employment types.", "type": "string" }, "type": { "description": "The classification of the worker by the company. * `CONTRACTOR`: Contractors are self-employed workers who provide services on a short-term or per-project basis and are not eligible for tax-withholding or benefits. * `EMPLOYEE`: Employees are hired and managed by an employer, work under the employer's direct supervision and control, and are protected by law for wages and employment rights.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "label", "updated_at" ], "title": "CompanyEmploymentType", "type": "object" }, "employment_type_id": { "description": "The worker's employment type.", "type": "string" }, "end_date": { "description": "The end date of the worker.", "type": "string" }, "ethnicity": { "description": "The identified ethnicity of the worker, if specified.", "type": "string" }, "gender": { "description": "The gender of the worker, if specified.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_manager": { "description": "Whether the worker is a manager", "type": "boolean" }, "job_function": { "description": "The worker's job function. When expanded, this field requires `job-functions.read`.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "Displayed name of the job function", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "JobFunction", "type": "object" }, "job_function_id": { "description": "ID of the worker's job function.", "type": "string" }, "legal_entity": { "description": "The worker's associated legal entity.\n\nExpandable field", "properties": { "company": { "description": "The company or organization associated with the legal entity\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "doing_business_as_name": { "description": "The doing business as name for the company.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_entities": { "description": "A list of the company's entities.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestLegalEntity" }, "type": "array" }, "legal_entities_id": { "description": "A list of the company's entities.", "items": { "type": "string" }, "type": "array" }, "legal_name": { "description": "The legal name of the company.", "type": "string" }, "name": { "description": "The name of the company.", "type": "string" }, "parent_legal_entity": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The company's ultimate holding entity.\n\nExpandable field", "type": "object" }, "parent_legal_entity_id": { "description": "The company's ultimate holding entity.", "type": "string" }, "phone": { "description": "The phone number for the company.", "type": "string" }, "physical_address": { "description": "The physical address of the holding entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "primary_email": { "description": "The email address used when registering this company.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "legal_entities", "legal_entities_id", "name", "updated_at" ], "title": "Company", "type": "object" }, "company_id": { "description": "The company or organization associated with the legal entity", "type": "string" }, "country": { "description": "The country the legal entity is based in.", "properties": { "code": { "description": "The code of the country.", "type": "string" } }, "required": [ "code" ], "title": "Country", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "entity_level": { "description": "The legal entity's level in a hierarchy. * `PARENT`: The legal entity is considered the ultimate holding entity. * `SUBSIDIARY`: The legal entity is considered a subsidiary, fully or partially held by another. * `BRANCH`: The legal entity is considered a branch, associated with a parent legal entity.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_name": { "description": "The legal name of the legal entity.", "type": "string" }, "mailing_address": { "description": "The mailing address of the legal entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "management_type": { "description": "The legal entity management type in the case of an employer of record (EOR) or professional employment organization (PEO). * `PEO`: The legal entity is considered a Professional Employment Organization (PEO). * `EOR`: The legal entity is considered an Employer of Record (EOR).", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The parent legal entity.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent legal entity.", "type": "string" }, "physical_address": { "description": "The physical address of the legal entity, if it differs from the mailing address.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "registration_date": { "description": "The registration date of the entity.", "type": "string" }, "tax_identifier": { "description": "The tax identifier for the legal entity.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "LegalEntity", "type": "object" }, "legal_entity_id": { "description": "The worker's associated legal entity.", "type": "string" }, "level": { "description": "The level of the worker.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "description": { "description": "The description of the level.", "type": "string" }, "experience_requirements": { "description": "The experience requirements for the level.", "type": "string" }, "global_level": { "anyOf": [ { "description": "Global level is used to track the seniority of levels. The higher up a level is placed on the page, the more senior and higher-ranked the level. Global level is used in workflows, policies, and reports that use the level attribute (e.g., you can use Level Lookup to set up a workflow that notifies the nearest person in an worker's management chain at or above the specified level).", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the level. Must be unique within the company or organization.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLevel", "description": "The parent level.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent level.", "type": "string" }, "rank": { "anyOf": [ { "description": "The rank of the level within its track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "scope_of_responsibilities": { "description": "The scope of responsibilities for the level.", "type": "string" }, "track": { "description": "The track associated with the level, if it's not a global level.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_default": { "description": "Whether this is the company's default track.", "type": "boolean" }, "name": { "description": "The name of the track. Must be unique within the company or organization.", "type": "string" }, "order": { "anyOf": [ { "description": "The one-based horizontal display order of the track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "start_global_level": { "anyOf": [ { "description": "The highest global level occupied by this track. Empty tracks return null.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Track", "type": "object" }, "track_id": { "description": "The track associated with the level. Required during creation. Include global_level when changing it.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Level", "type": "object" }, "level_id": { "description": "The level of the worker.", "type": "string" }, "location": { "description": "The location that the worker is mapped to for tax purposes. In the case that a worker is remote, the location's type is remote.", "properties": { "type": { "description": "The type of location.", "type": "string" }, "work_location_id": { "description": "The work location, if the worker isn't remote.", "type": "string" } }, "required": [ "type", "work_location_id" ], "title": "WorkerLocation", "type": "object" }, "manager": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's manager.\n\nExpandable field", "type": "object" }, "manager_id": { "description": "The worker's manager.", "type": "string" }, "number": { "anyOf": [ { "description": "The worker's number within the organization.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "original_start_date": { "description": "The worker's earliest start date across their employment history, excluding INIT roles.", "type": "string" }, "overtime_exemption": { "description": "The worker's overtime exemption status.", "type": "string" }, "pay_schedule_id": { "description": "The ID of the pay schedule currently associated with the worker.", "type": "string" }, "personal_email": { "description": "The worker's associated personal email address.", "type": "string" }, "race": { "description": "The identified race of the worker, if specified.", "type": "string" }, "start_date": { "description": "The start date of the worker.", "type": "string" }, "status": { "description": "The worker's status within the organization.", "type": "string" }, "teams": { "description": "The worker's assigned teams.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiTeamcb26bc28f32f" }, "type": "array" }, "teams_id": { "description": "The worker's assigned teams.", "items": { "type": "string" }, "type": "array" }, "termination_details": { "description": "The details of the worker's termination, if applicable.", "properties": { "reason": { "description": "This is a description that will be custom to each Rippling company.", "type": "string" }, "type": { "description": "The termination type indicates whether the termination was voluntary or involuntary.", "type": "string" } }, "title": "TerminationDetails", "type": "object" }, "title": { "description": "The worker's title.", "type": "string" }, "title_effective_date": { "description": "Title effective date", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "user": { "description": "The worker's associated user.\n\nExpandable field", "properties": { "active": { "description": "Whether the user is able to access company resources, typically when they are in actively engaged with the company and not after off-boarding.", "type": "boolean" }, "addresses": { "description": "The user's addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiUserAddressedd59b9ba9a1" }, "type": "array" }, "created_at": { "description": "Record creation date", "type": "string" }, "display_name": { "description": "The display name of the user using either the concatenated preferred given and family name or username depending on availability.", "type": "string" }, "emails": { "description": "The user's email addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiEmail5284c8258dc3" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "locale": { "description": "The User's default location for purposes of localization of currency, date time format, or numerical representations pursuant to RFC5646.", "type": "string" }, "name": { "description": "The user's name.", "properties": { "family_name": { "description": "The legal family name of the user, or last name in most Western languages.", "type": "string" }, "formatted": { "description": "The user's full name.", "type": "string" }, "given_name": { "description": "The given legal name of the user, or first name in most Western languages.", "type": "string" }, "middle_name": { "description": "The middle name(s) of the user.", "type": "string" }, "preferred_family_name": { "description": "The preferred family name, or last name in most Western languages, by the user.", "type": "string" }, "preferred_given_name": { "description": "The preferred given name, or first name in most Western languages, by the user.", "type": "string" } }, "title": "UserName", "type": "object" }, "number": { "description": "The permanent profile number of the user.", "type": "string" }, "phone_numbers": { "description": "The user's phone numbers.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoneNumber12060c61ecf5" }, "type": "array" }, "photos": { "description": "The user's photos.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoto2be7c3ae3f39" }, "type": "array" }, "preferred_language": { "description": "The User's preferred written or spoken language in the same format of the HTTP Accept-Language header, pursuant to Section 5.3.5 of RFC7231.", "type": "string" }, "timezone": { "description": "The User's current time zone in IANA database Olson format", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "username": { "description": "The unique identifier across Rippling used by the User for direct authentication into their associated company. Globally unique.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "User", "type": "object" }, "user_id": { "description": "The worker's associated user.", "type": "string" }, "work_email": { "description": "The worker's associated work email address.", "type": "string" }, "work_schedule": { "additionalProperties": { "$ref": "#/components/schemas/OutputRestApiWorkScheduleDay938f88d94f20" }, "description": "The worker's scheduled working hours for each day of the week.", "type": "object" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Worker", "type": "object" }, "worker_id": { "description": "Identifier of the worker whose time split configuration this represents.", "type": "string" } }, "required": [ "created_at", "id", "updated_at", "worker_id" ], "title": "WorkerTimeSplit", "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Create a new worker time split", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "worker-time-splits.read-write" ] } }, "/worker-time-splits/{id}/": { "delete": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/delete-worker-time-splits" }, "operationId": "rippling.rest_api.delete_worker_time_splits", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "id", "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "204": { "description": "The resource was deleted successfully" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Delete a worker time split", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "worker-time-splits.read-write" ] }, "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/get-worker-time-splits" }, "operationId": "rippling.rest_api.get_worker_time_splits", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "id", "type": "string" } }, { "in": "query", "name": "expand", "required": false, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "__meta": { "properties": { "redacted_fields": { "items": { "$ref": "#/components/schemas/OutputRestApiRedactedField21788a25ef22" }, "type": "array" } }, "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_enabled": { "description": "Whether hard-coded time splits are active for this worker.", "type": "boolean" }, "job_codes": { "description": "The job codes referenced in this time split configuration. Use ?expand=job_codes to populate.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiJobCodeeda25ec6c9a8" }, "type": "array" }, "job_codes_id": { "description": "IDs of all unique job codes referenced across all split rows.", "items": { "type": "string" }, "type": "array" }, "splits": { "description": "The split rows defining time allocation percentages across job codes. Empty when is_enabled is false.", "items": { "$ref": "#/components/schemas/OutputRestApiSplit283f489e3a65" }, "type": "array" }, "updated_at": { "description": "Record update date", "type": "string" }, "worker": { "description": "The worker associated with this time split configuration.\n\nExpandable field", "properties": { "business_partners": { "description": "Worker's assigned business partners. This field is only populated when explicitly requested via the expand parameter (e.g., ?expand=business_partners). When expanded, returns an empty list ([]) if the worker has no business partners.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiBusinessPartner77b00a069c32" }, "type": "array" }, "business_partners_id": { "description": "Worker's assigned business partners unique identifiers. Returns an empty list ([]) if the worker has no business partners.", "items": { "type": "string" }, "type": "array" }, "citizenship": { "description": "The countries that the worker has citizenship in.", "type": "string" }, "compensation": { "description": "The compensation package for the worker.\n\nExpandable field", "properties": { "annual_compensation": { "description": "The worker's annual compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "annual_salary_equivalent": { "description": "The worker's annual salary equivalent, for insurance purposes. It will be equal to the worker's annual compensation, except for owners that are receiving no cashcompensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "bonus_schedule": { "description": "The worker's bonus schedule.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "hourly_wage": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "id": { "description": "Identifier field", "type": "string" }, "monthly_compensation": { "description": "The worker's monthly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "on_target_commission": { "description": "The worker's on-target commission.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "payment_terms": { "description": "The payment terms for an worker's compensation.", "type": "string" }, "payment_type": { "description": "The payment type for an worker's compensation.", "type": "string" }, "relocation_reimbursement": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "salary_effective_date": { "description": "Salary effective date", "type": "string" }, "signing_bonus": { "description": "The worker's signing bonus.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus": { "description": "The worker's target annual bonus amount.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus_percent": { "anyOf": [ { "description": "The worker's target annual bonus as a percent of annual compensation.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" }, "weekly_compensation": { "description": "The worker's weekly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "worker": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's details.\n\nExpandable field", "type": "object" }, "worker_id": { "description": "The worker's ID.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Compensation", "type": "object" }, "compensation_grade": { "description": "The compensation grade assigned to the worker, if any.", "properties": { "id": { "description": "The compensation grade's unique identifier.", "type": "string" }, "label": { "description": "The compensation grade's label.", "type": "string" } }, "title": "WorkerCompensationGrade", "type": "object" }, "compensation_id": { "description": "The compensation package for the worker.", "type": "string" }, "country": { "description": "The worker's country.", "type": "string" }, "country_fields": { "description": "Country level fields for the worker.", "properties": { "ca": { "description": "Country-wise regional fields for Canada", "properties": { "sin": { "description": "Social Insurance Number (SIN) for Canada employees.", "type": "string" } }, "title": "CanadaFields", "type": "object" }, "nz": { "description": "Country-wise regional fields for New Zealand", "properties": { "ird_number": { "description": "Inland Revenue Department (IRD) number for New Zealand employees.", "type": "string" } }, "title": "NewZealandFields", "type": "object" }, "us": { "description": "Country-wise regional fields for USA", "properties": { "ssn": { "description": "Social Security Number (SSN) for US employees.", "type": "string" } }, "title": "USFields", "type": "object" } }, "title": "CountryFields", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "custom_fields": { "description": "Custom field values defined on the Employee object for this worker\n\nExpandable field", "items": { "additionalProperties": {} }, "type": "array" }, "date_of_birth": { "description": "The worker's date of birth.", "type": "string" }, "department": { "description": "The worker's assigned department.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "department_hierarchy": { "description": "List of departments in the department hierarchy. Refer department_hierarchy_ids for department hierarchy order.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestDepartment" }, "type": "array" }, "department_hierarchy_id": { "description": "The identifier of departments in the department hierarchy ordered from parent department to child department.", "items": { "type": "string" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the department.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestDepartment", "description": "The parent department.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent department.", "type": "string" }, "reference_code": { "description": "Reference code of the department.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Department", "type": "object" }, "department_id": { "description": "The worker's assigned department.", "type": "string" }, "employment_type": { "description": "The worker's employment type.\n\nExpandable field", "properties": { "amount_worked": { "description": "The amount worked for the employment type. * `FULL-TIME`: Full-time is at least 30 hours per week. Full-time workers will typically be eligible for benefits. * `PART-TIME`: Part-time is less than 30 hours per week. These workers may be eligible for benefits, depending on company settings and hours worked. * `TEMPORARY`: These workers are hired on a temporary basis. You can specify how each worker with this employment type will be paid individually.", "type": "string" }, "compensation_time_period": { "description": "The compensation period for the employment type. * `SALARIED`: Employees that are paid a fixed amount per year. * `HOURLY`: Employees that are paid a wage per hour worked.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "label": { "description": "The display label of the employment type.", "type": "string" }, "name": { "description": "The name of the employment type for non-custom employment types.", "type": "string" }, "type": { "description": "The classification of the worker by the company. * `CONTRACTOR`: Contractors are self-employed workers who provide services on a short-term or per-project basis and are not eligible for tax-withholding or benefits. * `EMPLOYEE`: Employees are hired and managed by an employer, work under the employer's direct supervision and control, and are protected by law for wages and employment rights.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "label", "updated_at" ], "title": "CompanyEmploymentType", "type": "object" }, "employment_type_id": { "description": "The worker's employment type.", "type": "string" }, "end_date": { "description": "The end date of the worker.", "type": "string" }, "ethnicity": { "description": "The identified ethnicity of the worker, if specified.", "type": "string" }, "gender": { "description": "The gender of the worker, if specified.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_manager": { "description": "Whether the worker is a manager", "type": "boolean" }, "job_function": { "description": "The worker's job function. When expanded, this field requires `job-functions.read`.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "Displayed name of the job function", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "JobFunction", "type": "object" }, "job_function_id": { "description": "ID of the worker's job function.", "type": "string" }, "legal_entity": { "description": "The worker's associated legal entity.\n\nExpandable field", "properties": { "company": { "description": "The company or organization associated with the legal entity\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "doing_business_as_name": { "description": "The doing business as name for the company.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_entities": { "description": "A list of the company's entities.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestLegalEntity" }, "type": "array" }, "legal_entities_id": { "description": "A list of the company's entities.", "items": { "type": "string" }, "type": "array" }, "legal_name": { "description": "The legal name of the company.", "type": "string" }, "name": { "description": "The name of the company.", "type": "string" }, "parent_legal_entity": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The company's ultimate holding entity.\n\nExpandable field", "type": "object" }, "parent_legal_entity_id": { "description": "The company's ultimate holding entity.", "type": "string" }, "phone": { "description": "The phone number for the company.", "type": "string" }, "physical_address": { "description": "The physical address of the holding entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "primary_email": { "description": "The email address used when registering this company.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "legal_entities", "legal_entities_id", "name", "updated_at" ], "title": "Company", "type": "object" }, "company_id": { "description": "The company or organization associated with the legal entity", "type": "string" }, "country": { "description": "The country the legal entity is based in.", "properties": { "code": { "description": "The code of the country.", "type": "string" } }, "required": [ "code" ], "title": "Country", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "entity_level": { "description": "The legal entity's level in a hierarchy. * `PARENT`: The legal entity is considered the ultimate holding entity. * `SUBSIDIARY`: The legal entity is considered a subsidiary, fully or partially held by another. * `BRANCH`: The legal entity is considered a branch, associated with a parent legal entity.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_name": { "description": "The legal name of the legal entity.", "type": "string" }, "mailing_address": { "description": "The mailing address of the legal entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "management_type": { "description": "The legal entity management type in the case of an employer of record (EOR) or professional employment organization (PEO). * `PEO`: The legal entity is considered a Professional Employment Organization (PEO). * `EOR`: The legal entity is considered an Employer of Record (EOR).", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The parent legal entity.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent legal entity.", "type": "string" }, "physical_address": { "description": "The physical address of the legal entity, if it differs from the mailing address.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "registration_date": { "description": "The registration date of the entity.", "type": "string" }, "tax_identifier": { "description": "The tax identifier for the legal entity.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "LegalEntity", "type": "object" }, "legal_entity_id": { "description": "The worker's associated legal entity.", "type": "string" }, "level": { "description": "The level of the worker.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "description": { "description": "The description of the level.", "type": "string" }, "experience_requirements": { "description": "The experience requirements for the level.", "type": "string" }, "global_level": { "anyOf": [ { "description": "Global level is used to track the seniority of levels. The higher up a level is placed on the page, the more senior and higher-ranked the level. Global level is used in workflows, policies, and reports that use the level attribute (e.g., you can use Level Lookup to set up a workflow that notifies the nearest person in an worker's management chain at or above the specified level).", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the level. Must be unique within the company or organization.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLevel", "description": "The parent level.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent level.", "type": "string" }, "rank": { "anyOf": [ { "description": "The rank of the level within its track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "scope_of_responsibilities": { "description": "The scope of responsibilities for the level.", "type": "string" }, "track": { "description": "The track associated with the level, if it's not a global level.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_default": { "description": "Whether this is the company's default track.", "type": "boolean" }, "name": { "description": "The name of the track. Must be unique within the company or organization.", "type": "string" }, "order": { "anyOf": [ { "description": "The one-based horizontal display order of the track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "start_global_level": { "anyOf": [ { "description": "The highest global level occupied by this track. Empty tracks return null.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Track", "type": "object" }, "track_id": { "description": "The track associated with the level. Required during creation. Include global_level when changing it.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Level", "type": "object" }, "level_id": { "description": "The level of the worker.", "type": "string" }, "location": { "description": "The location that the worker is mapped to for tax purposes. In the case that a worker is remote, the location's type is remote.", "properties": { "type": { "description": "The type of location.", "type": "string" }, "work_location_id": { "description": "The work location, if the worker isn't remote.", "type": "string" } }, "required": [ "type", "work_location_id" ], "title": "WorkerLocation", "type": "object" }, "manager": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's manager.\n\nExpandable field", "type": "object" }, "manager_id": { "description": "The worker's manager.", "type": "string" }, "number": { "anyOf": [ { "description": "The worker's number within the organization.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "original_start_date": { "description": "The worker's earliest start date across their employment history, excluding INIT roles.", "type": "string" }, "overtime_exemption": { "description": "The worker's overtime exemption status.", "type": "string" }, "pay_schedule_id": { "description": "The ID of the pay schedule currently associated with the worker.", "type": "string" }, "personal_email": { "description": "The worker's associated personal email address.", "type": "string" }, "race": { "description": "The identified race of the worker, if specified.", "type": "string" }, "start_date": { "description": "The start date of the worker.", "type": "string" }, "status": { "description": "The worker's status within the organization.", "type": "string" }, "teams": { "description": "The worker's assigned teams.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiTeamcb26bc28f32f" }, "type": "array" }, "teams_id": { "description": "The worker's assigned teams.", "items": { "type": "string" }, "type": "array" }, "termination_details": { "description": "The details of the worker's termination, if applicable.", "properties": { "reason": { "description": "This is a description that will be custom to each Rippling company.", "type": "string" }, "type": { "description": "The termination type indicates whether the termination was voluntary or involuntary.", "type": "string" } }, "title": "TerminationDetails", "type": "object" }, "title": { "description": "The worker's title.", "type": "string" }, "title_effective_date": { "description": "Title effective date", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "user": { "description": "The worker's associated user.\n\nExpandable field", "properties": { "active": { "description": "Whether the user is able to access company resources, typically when they are in actively engaged with the company and not after off-boarding.", "type": "boolean" }, "addresses": { "description": "The user's addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiUserAddressedd59b9ba9a1" }, "type": "array" }, "created_at": { "description": "Record creation date", "type": "string" }, "display_name": { "description": "The display name of the user using either the concatenated preferred given and family name or username depending on availability.", "type": "string" }, "emails": { "description": "The user's email addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiEmail5284c8258dc3" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "locale": { "description": "The User's default location for purposes of localization of currency, date time format, or numerical representations pursuant to RFC5646.", "type": "string" }, "name": { "description": "The user's name.", "properties": { "family_name": { "description": "The legal family name of the user, or last name in most Western languages.", "type": "string" }, "formatted": { "description": "The user's full name.", "type": "string" }, "given_name": { "description": "The given legal name of the user, or first name in most Western languages.", "type": "string" }, "middle_name": { "description": "The middle name(s) of the user.", "type": "string" }, "preferred_family_name": { "description": "The preferred family name, or last name in most Western languages, by the user.", "type": "string" }, "preferred_given_name": { "description": "The preferred given name, or first name in most Western languages, by the user.", "type": "string" } }, "title": "UserName", "type": "object" }, "number": { "description": "The permanent profile number of the user.", "type": "string" }, "phone_numbers": { "description": "The user's phone numbers.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoneNumber12060c61ecf5" }, "type": "array" }, "photos": { "description": "The user's photos.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoto2be7c3ae3f39" }, "type": "array" }, "preferred_language": { "description": "The User's preferred written or spoken language in the same format of the HTTP Accept-Language header, pursuant to Section 5.3.5 of RFC7231.", "type": "string" }, "timezone": { "description": "The User's current time zone in IANA database Olson format", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "username": { "description": "The unique identifier across Rippling used by the User for direct authentication into their associated company. Globally unique.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "User", "type": "object" }, "user_id": { "description": "The worker's associated user.", "type": "string" }, "work_email": { "description": "The worker's associated work email address.", "type": "string" }, "work_schedule": { "additionalProperties": { "$ref": "#/components/schemas/OutputRestApiWorkScheduleDay938f88d94f20" }, "description": "The worker's scheduled working hours for each day of the week.", "type": "object" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Worker", "type": "object" }, "worker_id": { "description": "Identifier of the worker whose time split configuration this represents.", "type": "string" } }, "required": [ "created_at", "id", "updated_at", "worker_id" ], "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Retrieve a specific worker time split", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "worker-time-splits.read" ] }, "patch": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/update-worker-time-splits" }, "operationId": "rippling.rest_api.update_worker_time_splits", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "id", "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiWorkerTimeSplitRequest9e21ee5b724e" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "Worker time split configuration resource.", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_enabled": { "description": "Whether hard-coded time splits are active for this worker.", "type": "boolean" }, "job_codes": { "description": "The job codes referenced in this time split configuration. Use ?expand=job_codes to populate.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiJobCodeeda25ec6c9a8" }, "type": "array" }, "job_codes_id": { "description": "IDs of all unique job codes referenced across all split rows.", "items": { "type": "string" }, "type": "array" }, "splits": { "description": "The split rows defining time allocation percentages across job codes. Empty when is_enabled is false.", "items": { "$ref": "#/components/schemas/OutputRestApiSplit283f489e3a65" }, "type": "array" }, "updated_at": { "description": "Record update date", "type": "string" }, "worker": { "description": "The worker associated with this time split configuration.\n\nExpandable field", "properties": { "business_partners": { "description": "Worker's assigned business partners. This field is only populated when explicitly requested via the expand parameter (e.g., ?expand=business_partners). When expanded, returns an empty list ([]) if the worker has no business partners.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiBusinessPartner77b00a069c32" }, "type": "array" }, "business_partners_id": { "description": "Worker's assigned business partners unique identifiers. Returns an empty list ([]) if the worker has no business partners.", "items": { "type": "string" }, "type": "array" }, "citizenship": { "description": "The countries that the worker has citizenship in.", "type": "string" }, "compensation": { "description": "The compensation package for the worker.\n\nExpandable field", "properties": { "annual_compensation": { "description": "The worker's annual compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "annual_salary_equivalent": { "description": "The worker's annual salary equivalent, for insurance purposes. It will be equal to the worker's annual compensation, except for owners that are receiving no cashcompensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "bonus_schedule": { "description": "The worker's bonus schedule.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "hourly_wage": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "id": { "description": "Identifier field", "type": "string" }, "monthly_compensation": { "description": "The worker's monthly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "on_target_commission": { "description": "The worker's on-target commission.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "payment_terms": { "description": "The payment terms for an worker's compensation.", "type": "string" }, "payment_type": { "description": "The payment type for an worker's compensation.", "type": "string" }, "relocation_reimbursement": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "salary_effective_date": { "description": "Salary effective date", "type": "string" }, "signing_bonus": { "description": "The worker's signing bonus.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus": { "description": "The worker's target annual bonus amount.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus_percent": { "anyOf": [ { "description": "The worker's target annual bonus as a percent of annual compensation.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" }, "weekly_compensation": { "description": "The worker's weekly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "worker": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's details.\n\nExpandable field", "type": "object" }, "worker_id": { "description": "The worker's ID.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Compensation", "type": "object" }, "compensation_grade": { "description": "The compensation grade assigned to the worker, if any.", "properties": { "id": { "description": "The compensation grade's unique identifier.", "type": "string" }, "label": { "description": "The compensation grade's label.", "type": "string" } }, "title": "WorkerCompensationGrade", "type": "object" }, "compensation_id": { "description": "The compensation package for the worker.", "type": "string" }, "country": { "description": "The worker's country.", "type": "string" }, "country_fields": { "description": "Country level fields for the worker.", "properties": { "ca": { "description": "Country-wise regional fields for Canada", "properties": { "sin": { "description": "Social Insurance Number (SIN) for Canada employees.", "type": "string" } }, "title": "CanadaFields", "type": "object" }, "nz": { "description": "Country-wise regional fields for New Zealand", "properties": { "ird_number": { "description": "Inland Revenue Department (IRD) number for New Zealand employees.", "type": "string" } }, "title": "NewZealandFields", "type": "object" }, "us": { "description": "Country-wise regional fields for USA", "properties": { "ssn": { "description": "Social Security Number (SSN) for US employees.", "type": "string" } }, "title": "USFields", "type": "object" } }, "title": "CountryFields", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "custom_fields": { "description": "Custom field values defined on the Employee object for this worker\n\nExpandable field", "items": { "additionalProperties": {} }, "type": "array" }, "date_of_birth": { "description": "The worker's date of birth.", "type": "string" }, "department": { "description": "The worker's assigned department.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "department_hierarchy": { "description": "List of departments in the department hierarchy. Refer department_hierarchy_ids for department hierarchy order.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestDepartment" }, "type": "array" }, "department_hierarchy_id": { "description": "The identifier of departments in the department hierarchy ordered from parent department to child department.", "items": { "type": "string" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the department.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestDepartment", "description": "The parent department.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent department.", "type": "string" }, "reference_code": { "description": "Reference code of the department.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Department", "type": "object" }, "department_id": { "description": "The worker's assigned department.", "type": "string" }, "employment_type": { "description": "The worker's employment type.\n\nExpandable field", "properties": { "amount_worked": { "description": "The amount worked for the employment type. * `FULL-TIME`: Full-time is at least 30 hours per week. Full-time workers will typically be eligible for benefits. * `PART-TIME`: Part-time is less than 30 hours per week. These workers may be eligible for benefits, depending on company settings and hours worked. * `TEMPORARY`: These workers are hired on a temporary basis. You can specify how each worker with this employment type will be paid individually.", "type": "string" }, "compensation_time_period": { "description": "The compensation period for the employment type. * `SALARIED`: Employees that are paid a fixed amount per year. * `HOURLY`: Employees that are paid a wage per hour worked.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "label": { "description": "The display label of the employment type.", "type": "string" }, "name": { "description": "The name of the employment type for non-custom employment types.", "type": "string" }, "type": { "description": "The classification of the worker by the company. * `CONTRACTOR`: Contractors are self-employed workers who provide services on a short-term or per-project basis and are not eligible for tax-withholding or benefits. * `EMPLOYEE`: Employees are hired and managed by an employer, work under the employer's direct supervision and control, and are protected by law for wages and employment rights.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "label", "updated_at" ], "title": "CompanyEmploymentType", "type": "object" }, "employment_type_id": { "description": "The worker's employment type.", "type": "string" }, "end_date": { "description": "The end date of the worker.", "type": "string" }, "ethnicity": { "description": "The identified ethnicity of the worker, if specified.", "type": "string" }, "gender": { "description": "The gender of the worker, if specified.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_manager": { "description": "Whether the worker is a manager", "type": "boolean" }, "job_function": { "description": "The worker's job function. When expanded, this field requires `job-functions.read`.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "Displayed name of the job function", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "JobFunction", "type": "object" }, "job_function_id": { "description": "ID of the worker's job function.", "type": "string" }, "legal_entity": { "description": "The worker's associated legal entity.\n\nExpandable field", "properties": { "company": { "description": "The company or organization associated with the legal entity\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "doing_business_as_name": { "description": "The doing business as name for the company.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_entities": { "description": "A list of the company's entities.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestLegalEntity" }, "type": "array" }, "legal_entities_id": { "description": "A list of the company's entities.", "items": { "type": "string" }, "type": "array" }, "legal_name": { "description": "The legal name of the company.", "type": "string" }, "name": { "description": "The name of the company.", "type": "string" }, "parent_legal_entity": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The company's ultimate holding entity.\n\nExpandable field", "type": "object" }, "parent_legal_entity_id": { "description": "The company's ultimate holding entity.", "type": "string" }, "phone": { "description": "The phone number for the company.", "type": "string" }, "physical_address": { "description": "The physical address of the holding entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "primary_email": { "description": "The email address used when registering this company.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "legal_entities", "legal_entities_id", "name", "updated_at" ], "title": "Company", "type": "object" }, "company_id": { "description": "The company or organization associated with the legal entity", "type": "string" }, "country": { "description": "The country the legal entity is based in.", "properties": { "code": { "description": "The code of the country.", "type": "string" } }, "required": [ "code" ], "title": "Country", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "entity_level": { "description": "The legal entity's level in a hierarchy. * `PARENT`: The legal entity is considered the ultimate holding entity. * `SUBSIDIARY`: The legal entity is considered a subsidiary, fully or partially held by another. * `BRANCH`: The legal entity is considered a branch, associated with a parent legal entity.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_name": { "description": "The legal name of the legal entity.", "type": "string" }, "mailing_address": { "description": "The mailing address of the legal entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "management_type": { "description": "The legal entity management type in the case of an employer of record (EOR) or professional employment organization (PEO). * `PEO`: The legal entity is considered a Professional Employment Organization (PEO). * `EOR`: The legal entity is considered an Employer of Record (EOR).", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The parent legal entity.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent legal entity.", "type": "string" }, "physical_address": { "description": "The physical address of the legal entity, if it differs from the mailing address.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "registration_date": { "description": "The registration date of the entity.", "type": "string" }, "tax_identifier": { "description": "The tax identifier for the legal entity.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "LegalEntity", "type": "object" }, "legal_entity_id": { "description": "The worker's associated legal entity.", "type": "string" }, "level": { "description": "The level of the worker.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "description": { "description": "The description of the level.", "type": "string" }, "experience_requirements": { "description": "The experience requirements for the level.", "type": "string" }, "global_level": { "anyOf": [ { "description": "Global level is used to track the seniority of levels. The higher up a level is placed on the page, the more senior and higher-ranked the level. Global level is used in workflows, policies, and reports that use the level attribute (e.g., you can use Level Lookup to set up a workflow that notifies the nearest person in an worker's management chain at or above the specified level).", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the level. Must be unique within the company or organization.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLevel", "description": "The parent level.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent level.", "type": "string" }, "rank": { "anyOf": [ { "description": "The rank of the level within its track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "scope_of_responsibilities": { "description": "The scope of responsibilities for the level.", "type": "string" }, "track": { "description": "The track associated with the level, if it's not a global level.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_default": { "description": "Whether this is the company's default track.", "type": "boolean" }, "name": { "description": "The name of the track. Must be unique within the company or organization.", "type": "string" }, "order": { "anyOf": [ { "description": "The one-based horizontal display order of the track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "start_global_level": { "anyOf": [ { "description": "The highest global level occupied by this track. Empty tracks return null.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Track", "type": "object" }, "track_id": { "description": "The track associated with the level. Required during creation. Include global_level when changing it.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Level", "type": "object" }, "level_id": { "description": "The level of the worker.", "type": "string" }, "location": { "description": "The location that the worker is mapped to for tax purposes. In the case that a worker is remote, the location's type is remote.", "properties": { "type": { "description": "The type of location.", "type": "string" }, "work_location_id": { "description": "The work location, if the worker isn't remote.", "type": "string" } }, "required": [ "type", "work_location_id" ], "title": "WorkerLocation", "type": "object" }, "manager": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's manager.\n\nExpandable field", "type": "object" }, "manager_id": { "description": "The worker's manager.", "type": "string" }, "number": { "anyOf": [ { "description": "The worker's number within the organization.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "original_start_date": { "description": "The worker's earliest start date across their employment history, excluding INIT roles.", "type": "string" }, "overtime_exemption": { "description": "The worker's overtime exemption status.", "type": "string" }, "pay_schedule_id": { "description": "The ID of the pay schedule currently associated with the worker.", "type": "string" }, "personal_email": { "description": "The worker's associated personal email address.", "type": "string" }, "race": { "description": "The identified race of the worker, if specified.", "type": "string" }, "start_date": { "description": "The start date of the worker.", "type": "string" }, "status": { "description": "The worker's status within the organization.", "type": "string" }, "teams": { "description": "The worker's assigned teams.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiTeamcb26bc28f32f" }, "type": "array" }, "teams_id": { "description": "The worker's assigned teams.", "items": { "type": "string" }, "type": "array" }, "termination_details": { "description": "The details of the worker's termination, if applicable.", "properties": { "reason": { "description": "This is a description that will be custom to each Rippling company.", "type": "string" }, "type": { "description": "The termination type indicates whether the termination was voluntary or involuntary.", "type": "string" } }, "title": "TerminationDetails", "type": "object" }, "title": { "description": "The worker's title.", "type": "string" }, "title_effective_date": { "description": "Title effective date", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "user": { "description": "The worker's associated user.\n\nExpandable field", "properties": { "active": { "description": "Whether the user is able to access company resources, typically when they are in actively engaged with the company and not after off-boarding.", "type": "boolean" }, "addresses": { "description": "The user's addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiUserAddressedd59b9ba9a1" }, "type": "array" }, "created_at": { "description": "Record creation date", "type": "string" }, "display_name": { "description": "The display name of the user using either the concatenated preferred given and family name or username depending on availability.", "type": "string" }, "emails": { "description": "The user's email addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiEmail5284c8258dc3" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "locale": { "description": "The User's default location for purposes of localization of currency, date time format, or numerical representations pursuant to RFC5646.", "type": "string" }, "name": { "description": "The user's name.", "properties": { "family_name": { "description": "The legal family name of the user, or last name in most Western languages.", "type": "string" }, "formatted": { "description": "The user's full name.", "type": "string" }, "given_name": { "description": "The given legal name of the user, or first name in most Western languages.", "type": "string" }, "middle_name": { "description": "The middle name(s) of the user.", "type": "string" }, "preferred_family_name": { "description": "The preferred family name, or last name in most Western languages, by the user.", "type": "string" }, "preferred_given_name": { "description": "The preferred given name, or first name in most Western languages, by the user.", "type": "string" } }, "title": "UserName", "type": "object" }, "number": { "description": "The permanent profile number of the user.", "type": "string" }, "phone_numbers": { "description": "The user's phone numbers.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoneNumber12060c61ecf5" }, "type": "array" }, "photos": { "description": "The user's photos.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoto2be7c3ae3f39" }, "type": "array" }, "preferred_language": { "description": "The User's preferred written or spoken language in the same format of the HTTP Accept-Language header, pursuant to Section 5.3.5 of RFC7231.", "type": "string" }, "timezone": { "description": "The User's current time zone in IANA database Olson format", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "username": { "description": "The unique identifier across Rippling used by the User for direct authentication into their associated company. Globally unique.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "User", "type": "object" }, "user_id": { "description": "The worker's associated user.", "type": "string" }, "work_email": { "description": "The worker's associated work email address.", "type": "string" }, "work_schedule": { "additionalProperties": { "$ref": "#/components/schemas/OutputRestApiWorkScheduleDay938f88d94f20" }, "description": "The worker's scheduled working hours for each day of the week.", "type": "object" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Worker", "type": "object" }, "worker_id": { "description": "Identifier of the worker whose time split configuration this represents.", "type": "string" } }, "required": [ "created_at", "id", "updated_at", "worker_id" ], "title": "WorkerTimeSplit", "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Update a worker time split", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "worker-time-splits.read-write" ] } }, "/workers/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/list-workers" }, "operationId": "rippling.rest_api.list_workers", "parameters": [ { "in": "query", "name": "filter", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "expand", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 100, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "__meta": { "$ref": "#/components/schemas/OutputRestApiRedactedFields9f7657dc2a2f" }, "next_link": { "description": "A link to the next page of responses.", "format": "uri", "type": "string" }, "results": { "items": { "$ref": "#/components/schemas/OutputRestApiWorker75ef4092b644" }, "type": "array" } }, "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "List workers", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "workers.read" ] } }, "/workers/{id}/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/get-workers" }, "operationId": "rippling.rest_api.get_workers", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "id", "type": "string" } }, { "in": "query", "name": "expand", "required": false, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "__meta": { "properties": { "redacted_fields": { "items": { "$ref": "#/components/schemas/OutputRestApiRedactedField21788a25ef22" }, "type": "array" } }, "type": "object" }, "business_partners": { "description": "Worker's assigned business partners. This field is only populated when explicitly requested via the expand parameter (e.g., ?expand=business_partners). When expanded, returns an empty list ([]) if the worker has no business partners.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiBusinessPartner77b00a069c32" }, "type": "array" }, "business_partners_id": { "description": "Worker's assigned business partners unique identifiers. Returns an empty list ([]) if the worker has no business partners.", "items": { "type": "string" }, "type": "array" }, "citizenship": { "description": "The countries that the worker has citizenship in.", "type": "string" }, "compensation": { "description": "The compensation package for the worker.\n\nExpandable field", "properties": { "annual_compensation": { "description": "The worker's annual compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "annual_salary_equivalent": { "description": "The worker's annual salary equivalent, for insurance purposes. It will be equal to the worker's annual compensation, except for owners that are receiving no cashcompensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "bonus_schedule": { "description": "The worker's bonus schedule.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "hourly_wage": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "id": { "description": "Identifier field", "type": "string" }, "monthly_compensation": { "description": "The worker's monthly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "on_target_commission": { "description": "The worker's on-target commission.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "payment_terms": { "description": "The payment terms for an worker's compensation.", "type": "string" }, "payment_type": { "description": "The payment type for an worker's compensation.", "type": "string" }, "relocation_reimbursement": { "description": "The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "salary_effective_date": { "description": "Salary effective date", "type": "string" }, "signing_bonus": { "description": "The worker's signing bonus.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus": { "description": "The worker's target annual bonus amount.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "target_annual_bonus_percent": { "anyOf": [ { "description": "The worker's target annual bonus as a percent of annual compensation.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" }, "weekly_compensation": { "description": "The worker's weekly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.", "properties": { "currency_type": { "description": "The currency type, ex: USD, EUR, etc.", "type": "string" }, "value": { "anyOf": [ { "description": "The decimal amount for the currency.", "type": "number" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] } }, "title": "Currency", "type": "object" }, "worker": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's details.\n\nExpandable field", "type": "object" }, "worker_id": { "description": "The worker's ID.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "Compensation", "type": "object" }, "compensation_grade": { "description": "The compensation grade assigned to the worker, if any.", "properties": { "id": { "description": "The compensation grade's unique identifier.", "type": "string" }, "label": { "description": "The compensation grade's label.", "type": "string" } }, "title": "WorkerCompensationGrade", "type": "object" }, "compensation_id": { "description": "The compensation package for the worker.", "type": "string" }, "country": { "description": "The worker's country.", "type": "string" }, "country_fields": { "description": "Country level fields for the worker.", "properties": { "ca": { "description": "Country-wise regional fields for Canada", "properties": { "sin": { "description": "Social Insurance Number (SIN) for Canada employees.", "type": "string" } }, "title": "CanadaFields", "type": "object" }, "nz": { "description": "Country-wise regional fields for New Zealand", "properties": { "ird_number": { "description": "Inland Revenue Department (IRD) number for New Zealand employees.", "type": "string" } }, "title": "NewZealandFields", "type": "object" }, "us": { "description": "Country-wise regional fields for USA", "properties": { "ssn": { "description": "Social Security Number (SSN) for US employees.", "type": "string" } }, "title": "USFields", "type": "object" } }, "title": "CountryFields", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "custom_fields": { "description": "Custom field values defined on the Employee object for this worker\n\nExpandable field", "items": { "additionalProperties": {} }, "type": "array" }, "date_of_birth": { "description": "The worker's date of birth.", "type": "string" }, "department": { "description": "The worker's assigned department.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "department_hierarchy": { "description": "List of departments in the department hierarchy. Refer department_hierarchy_ids for department hierarchy order.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestDepartment" }, "type": "array" }, "department_hierarchy_id": { "description": "The identifier of departments in the department hierarchy ordered from parent department to child department.", "items": { "type": "string" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the department.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestDepartment", "description": "The parent department.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent department.", "type": "string" }, "reference_code": { "description": "Reference code of the department.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Department", "type": "object" }, "department_id": { "description": "The worker's assigned department.", "type": "string" }, "employment_type": { "description": "The worker's employment type.\n\nExpandable field", "properties": { "amount_worked": { "description": "The amount worked for the employment type. * `FULL-TIME`: Full-time is at least 30 hours per week. Full-time workers will typically be eligible for benefits. * `PART-TIME`: Part-time is less than 30 hours per week. These workers may be eligible for benefits, depending on company settings and hours worked. * `TEMPORARY`: These workers are hired on a temporary basis. You can specify how each worker with this employment type will be paid individually.", "type": "string" }, "compensation_time_period": { "description": "The compensation period for the employment type. * `SALARIED`: Employees that are paid a fixed amount per year. * `HOURLY`: Employees that are paid a wage per hour worked.", "type": "string" }, "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "label": { "description": "The display label of the employment type.", "type": "string" }, "name": { "description": "The name of the employment type for non-custom employment types.", "type": "string" }, "type": { "description": "The classification of the worker by the company. * `CONTRACTOR`: Contractors are self-employed workers who provide services on a short-term or per-project basis and are not eligible for tax-withholding or benefits. * `EMPLOYEE`: Employees are hired and managed by an employer, work under the employer's direct supervision and control, and are protected by law for wages and employment rights.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "label", "updated_at" ], "title": "CompanyEmploymentType", "type": "object" }, "employment_type_id": { "description": "The worker's employment type.", "type": "string" }, "end_date": { "description": "The end date of the worker.", "type": "string" }, "ethnicity": { "description": "The identified ethnicity of the worker, if specified.", "type": "string" }, "gender": { "description": "The gender of the worker, if specified.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_manager": { "description": "Whether the worker is a manager", "type": "boolean" }, "job_function": { "description": "The worker's job function. When expanded, this field requires `job-functions.read`.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "Displayed name of the job function", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "JobFunction", "type": "object" }, "job_function_id": { "description": "ID of the worker's job function.", "type": "string" }, "legal_entity": { "description": "The worker's associated legal entity.\n\nExpandable field", "properties": { "company": { "description": "The company or organization associated with the legal entity\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "doing_business_as_name": { "description": "The doing business as name for the company.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_entities": { "description": "A list of the company's entities.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestLegalEntity" }, "type": "array" }, "legal_entities_id": { "description": "A list of the company's entities.", "items": { "type": "string" }, "type": "array" }, "legal_name": { "description": "The legal name of the company.", "type": "string" }, "name": { "description": "The name of the company.", "type": "string" }, "parent_legal_entity": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The company's ultimate holding entity.\n\nExpandable field", "type": "object" }, "parent_legal_entity_id": { "description": "The company's ultimate holding entity.", "type": "string" }, "phone": { "description": "The phone number for the company.", "type": "string" }, "physical_address": { "description": "The physical address of the holding entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "primary_email": { "description": "The email address used when registering this company.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "legal_entities", "legal_entities_id", "name", "updated_at" ], "title": "Company", "type": "object" }, "company_id": { "description": "The company or organization associated with the legal entity", "type": "string" }, "country": { "description": "The country the legal entity is based in.", "properties": { "code": { "description": "The code of the country.", "type": "string" } }, "required": [ "code" ], "title": "Country", "type": "object" }, "created_at": { "description": "Record creation date", "type": "string" }, "entity_level": { "description": "The legal entity's level in a hierarchy. * `PARENT`: The legal entity is considered the ultimate holding entity. * `SUBSIDIARY`: The legal entity is considered a subsidiary, fully or partially held by another. * `BRANCH`: The legal entity is considered a branch, associated with a parent legal entity.", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "legal_name": { "description": "The legal name of the legal entity.", "type": "string" }, "mailing_address": { "description": "The mailing address of the legal entity.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "management_type": { "description": "The legal entity management type in the case of an employer of record (EOR) or professional employment organization (PEO). * `PEO`: The legal entity is considered a Professional Employment Organization (PEO). * `EOR`: The legal entity is considered an Employer of Record (EOR).", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLegalEntity", "description": "The parent legal entity.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent legal entity.", "type": "string" }, "physical_address": { "description": "The physical address of the legal entity, if it differs from the mailing address.", "properties": { "country": { "description": "The country component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "formatted": { "description": "The formatted mailing address.", "type": "string" }, "locality": { "description": "The city or locality component.", "type": "string" }, "postal_code": { "description": "The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "region": { "description": "The state or region component, pursuant to SCIM RFC 7643 4.1.2.", "type": "string" }, "street_address": { "description": "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..", "type": "string" }, "type": { "description": "The classification of the address.", "type": "string" } }, "title": "Address", "type": "object" }, "registration_date": { "description": "The registration date of the entity.", "type": "string" }, "tax_identifier": { "description": "The tax identifier for the legal entity.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "LegalEntity", "type": "object" }, "legal_entity_id": { "description": "The worker's associated legal entity.", "type": "string" }, "level": { "description": "The level of the worker.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "description": { "description": "The description of the level.", "type": "string" }, "experience_requirements": { "description": "The experience requirements for the level.", "type": "string" }, "global_level": { "anyOf": [ { "description": "Global level is used to track the seniority of levels. The higher up a level is placed on the page, the more senior and higher-ranked the level. Global level is used in workflows, policies, and reports that use the level attribute (e.g., you can use Level Lookup to set up a workflow that notifies the nearest person in an worker's management chain at or above the specified level).", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "id": { "description": "Identifier field", "type": "string" }, "name": { "description": "The name of the level. Must be unique within the company or organization.", "type": "string" }, "parent": { "$ref": "#/components/schemas/OutputRestLevel", "description": "The parent level.\n\nExpandable field", "type": "object" }, "parent_id": { "description": "The parent level.", "type": "string" }, "rank": { "anyOf": [ { "description": "The rank of the level within its track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "scope_of_responsibilities": { "description": "The scope of responsibilities for the level.", "type": "string" }, "track": { "description": "The track associated with the level, if it's not a global level.\n\nExpandable field", "properties": { "created_at": { "description": "Record creation date", "type": "string" }, "id": { "description": "Identifier field", "type": "string" }, "is_default": { "description": "Whether this is the company's default track.", "type": "boolean" }, "name": { "description": "The name of the track. Must be unique within the company or organization.", "type": "string" }, "order": { "anyOf": [ { "description": "The one-based horizontal display order of the track.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "start_global_level": { "anyOf": [ { "description": "The highest global level occupied by this track. Empty tracks return null.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Track", "type": "object" }, "track_id": { "description": "The track associated with the level. Required during creation. Include global_level when changing it.", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" } }, "required": [ "created_at", "id", "name", "updated_at" ], "title": "Level", "type": "object" }, "level_id": { "description": "The level of the worker.", "type": "string" }, "location": { "description": "The location that the worker is mapped to for tax purposes. In the case that a worker is remote, the location's type is remote.", "properties": { "type": { "description": "The type of location.", "type": "string" }, "work_location_id": { "description": "The work location, if the worker isn't remote.", "type": "string" } }, "required": [ "type", "work_location_id" ], "title": "WorkerLocation", "type": "object" }, "manager": { "$ref": "#/components/schemas/OutputRestWorker", "description": "The worker's manager.\n\nExpandable field", "type": "object" }, "manager_id": { "description": "The worker's manager.", "type": "string" }, "number": { "anyOf": [ { "description": "The worker's number within the organization.", "type": "integer" }, { "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$", "type": "string" } ] }, "original_start_date": { "description": "The worker's earliest start date across their employment history, excluding INIT roles.", "type": "string" }, "overtime_exemption": { "description": "The worker's overtime exemption status.", "type": "string" }, "pay_schedule_id": { "description": "The ID of the pay schedule currently associated with the worker.", "type": "string" }, "personal_email": { "description": "The worker's associated personal email address.", "type": "string" }, "race": { "description": "The identified race of the worker, if specified.", "type": "string" }, "start_date": { "description": "The start date of the worker.", "type": "string" }, "status": { "description": "The worker's status within the organization.", "type": "string" }, "teams": { "description": "The worker's assigned teams.\n\nExpandable field", "items": { "$ref": "#/components/schemas/OutputRestApiTeamcb26bc28f32f" }, "type": "array" }, "teams_id": { "description": "The worker's assigned teams.", "items": { "type": "string" }, "type": "array" }, "termination_details": { "description": "The details of the worker's termination, if applicable.", "properties": { "reason": { "description": "This is a description that will be custom to each Rippling company.", "type": "string" }, "type": { "description": "The termination type indicates whether the termination was voluntary or involuntary.", "type": "string" } }, "title": "TerminationDetails", "type": "object" }, "title": { "description": "The worker's title.", "type": "string" }, "title_effective_date": { "description": "Title effective date", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "user": { "description": "The worker's associated user.\n\nExpandable field", "properties": { "active": { "description": "Whether the user is able to access company resources, typically when they are in actively engaged with the company and not after off-boarding.", "type": "boolean" }, "addresses": { "description": "The user's addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiUserAddressedd59b9ba9a1" }, "type": "array" }, "created_at": { "description": "Record creation date", "type": "string" }, "display_name": { "description": "The display name of the user using either the concatenated preferred given and family name or username depending on availability.", "type": "string" }, "emails": { "description": "The user's email addresses.", "items": { "$ref": "#/components/schemas/OutputRestApiEmail5284c8258dc3" }, "type": "array" }, "id": { "description": "Identifier field", "type": "string" }, "locale": { "description": "The User's default location for purposes of localization of currency, date time format, or numerical representations pursuant to RFC5646.", "type": "string" }, "name": { "description": "The user's name.", "properties": { "family_name": { "description": "The legal family name of the user, or last name in most Western languages.", "type": "string" }, "formatted": { "description": "The user's full name.", "type": "string" }, "given_name": { "description": "The given legal name of the user, or first name in most Western languages.", "type": "string" }, "middle_name": { "description": "The middle name(s) of the user.", "type": "string" }, "preferred_family_name": { "description": "The preferred family name, or last name in most Western languages, by the user.", "type": "string" }, "preferred_given_name": { "description": "The preferred given name, or first name in most Western languages, by the user.", "type": "string" } }, "title": "UserName", "type": "object" }, "number": { "description": "The permanent profile number of the user.", "type": "string" }, "phone_numbers": { "description": "The user's phone numbers.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoneNumber12060c61ecf5" }, "type": "array" }, "photos": { "description": "The user's photos.", "items": { "$ref": "#/components/schemas/OutputRestApiUserPhoto2be7c3ae3f39" }, "type": "array" }, "preferred_language": { "description": "The User's preferred written or spoken language in the same format of the HTTP Accept-Language header, pursuant to Section 5.3.5 of RFC7231.", "type": "string" }, "timezone": { "description": "The User's current time zone in IANA database Olson format", "type": "string" }, "updated_at": { "description": "Record update date", "type": "string" }, "username": { "description": "The unique identifier across Rippling used by the User for direct authentication into their associated company. Globally unique.", "type": "string" } }, "required": [ "created_at", "id", "updated_at" ], "title": "User", "type": "object" }, "user_id": { "description": "The worker's associated user.", "type": "string" }, "work_email": { "description": "The worker's associated work email address.", "type": "string" }, "work_schedule": { "additionalProperties": { "$ref": "#/components/schemas/OutputRestApiWorkScheduleDay938f88d94f20" }, "description": "The worker's scheduled working hours for each day of the week.", "type": "object" } }, "required": [ "created_at", "id", "updated_at" ], "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Retrieve a specific worker", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "workers.read" ] } }, "/workflow-action-executions/": { "post": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/workflow-action-executions" }, "operationId": "rippling.rest_api.workflow_action_executions", "parameters": [ { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiCreateWorkflowActionExecutionRequest61e182d33ac7" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "description": "", "properties": { "result": { "description": "Result of the workflow action execution", "type": "object" } }, "required": [ "result" ], "title": "WorkflowActionExecutionResult", "type": "object" } } }, "description": "Successful response" } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Execute a workflow action from Rippling Functions", "x-rippling-entitlements": [], "x-rippling-required-scopes": [ "workflow-action-executions.read-write" ] } }, "/workflows/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/list-workflows" }, "operationId": "rippling.rest_api.list_workflows", "parameters": [ { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 100, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OutputRestApiWorkflowListResponse1248d6c05c53" } } }, "description": "Successful response" }, "400": { "description": "The workflow request failed.", "x-rippling-source-response": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "code": { "enum": [ "VALIDATION_ERROR", "INVALID_CURSOR", "WORKFLOW_NOT_FOUND", "WORKFLOW_FORBIDDEN", "WORKFLOW_VERSION_CONFLICT", "WORKFLOW_NOT_EDITABLE", "WORKFLOW_STATE_CONFLICT" ], "type": "string" }, "field_errors": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "field", "message" ], "title": "WorkflowFieldError", "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "title": "WorkflowError", "type": "object" } } }, "description": "The workflow request failed." } }, "403": { "description": "The workflow request failed.", "x-rippling-source-response": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "code": { "enum": [ "VALIDATION_ERROR", "INVALID_CURSOR", "WORKFLOW_NOT_FOUND", "WORKFLOW_FORBIDDEN", "WORKFLOW_VERSION_CONFLICT", "WORKFLOW_NOT_EDITABLE", "WORKFLOW_STATE_CONFLICT" ], "type": "string" }, "field_errors": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "field", "message" ], "title": "WorkflowFieldError", "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "title": "WorkflowError", "type": "object" } } }, "description": "The workflow request failed." } } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "List workflows", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "workflows.read" ] }, "post": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/create-workflows" }, "operationId": "rippling.rest_api.create_workflows", "parameters": [ { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiWorkflowCreateInput6426e7b47896" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OutputRestApiWorkflowResourceb390faffbef6" } } }, "description": "Workflow created" }, "400": { "description": "The workflow request failed.", "x-rippling-source-response": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "code": { "enum": [ "VALIDATION_ERROR", "INVALID_CURSOR", "WORKFLOW_NOT_FOUND", "WORKFLOW_FORBIDDEN", "WORKFLOW_VERSION_CONFLICT", "WORKFLOW_NOT_EDITABLE", "WORKFLOW_STATE_CONFLICT" ], "type": "string" }, "field_errors": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "field", "message" ], "title": "WorkflowFieldError", "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "title": "WorkflowError", "type": "object" } } }, "description": "The workflow request failed." } }, "403": { "description": "The workflow request failed.", "x-rippling-source-response": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "code": { "enum": [ "VALIDATION_ERROR", "INVALID_CURSOR", "WORKFLOW_NOT_FOUND", "WORKFLOW_FORBIDDEN", "WORKFLOW_VERSION_CONFLICT", "WORKFLOW_NOT_EDITABLE", "WORKFLOW_STATE_CONFLICT" ], "type": "string" }, "field_errors": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "field", "message" ], "title": "WorkflowFieldError", "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "title": "WorkflowError", "type": "object" } } }, "description": "The workflow request failed." } }, "409": { "description": "The workflow request failed.", "x-rippling-source-response": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "code": { "enum": [ "VALIDATION_ERROR", "INVALID_CURSOR", "WORKFLOW_NOT_FOUND", "WORKFLOW_FORBIDDEN", "WORKFLOW_VERSION_CONFLICT", "WORKFLOW_NOT_EDITABLE", "WORKFLOW_STATE_CONFLICT" ], "type": "string" }, "field_errors": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "field", "message" ], "title": "WorkflowFieldError", "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "title": "WorkflowError", "type": "object" } } }, "description": "The workflow request failed." } } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Create a workflow", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "workflows.read-write" ] } }, "/workflows/{id}/": { "delete": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/delete-workflows" }, "operationId": "rippling.rest_api.delete_workflows", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "204": { "description": "Workflow deleted" }, "400": { "description": "The workflow request failed.", "x-rippling-source-response": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "code": { "enum": [ "VALIDATION_ERROR", "INVALID_CURSOR", "WORKFLOW_NOT_FOUND", "WORKFLOW_FORBIDDEN", "WORKFLOW_VERSION_CONFLICT", "WORKFLOW_NOT_EDITABLE", "WORKFLOW_STATE_CONFLICT" ], "type": "string" }, "field_errors": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "field", "message" ], "title": "WorkflowFieldError", "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "title": "WorkflowError", "type": "object" } } }, "description": "The workflow request failed." } }, "403": { "description": "The workflow request failed.", "x-rippling-source-response": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "code": { "enum": [ "VALIDATION_ERROR", "INVALID_CURSOR", "WORKFLOW_NOT_FOUND", "WORKFLOW_FORBIDDEN", "WORKFLOW_VERSION_CONFLICT", "WORKFLOW_NOT_EDITABLE", "WORKFLOW_STATE_CONFLICT" ], "type": "string" }, "field_errors": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "field", "message" ], "title": "WorkflowFieldError", "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "title": "WorkflowError", "type": "object" } } }, "description": "The workflow request failed." } }, "404": { "description": "The workflow request failed.", "x-rippling-source-response": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "code": { "enum": [ "VALIDATION_ERROR", "INVALID_CURSOR", "WORKFLOW_NOT_FOUND", "WORKFLOW_FORBIDDEN", "WORKFLOW_VERSION_CONFLICT", "WORKFLOW_NOT_EDITABLE", "WORKFLOW_STATE_CONFLICT" ], "type": "string" }, "field_errors": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "field", "message" ], "title": "WorkflowFieldError", "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "title": "WorkflowError", "type": "object" } } }, "description": "The workflow request failed." } }, "409": { "description": "The workflow request failed.", "x-rippling-source-response": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "code": { "enum": [ "VALIDATION_ERROR", "INVALID_CURSOR", "WORKFLOW_NOT_FOUND", "WORKFLOW_FORBIDDEN", "WORKFLOW_VERSION_CONFLICT", "WORKFLOW_NOT_EDITABLE", "WORKFLOW_STATE_CONFLICT" ], "type": "string" }, "field_errors": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "field", "message" ], "title": "WorkflowFieldError", "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "title": "WorkflowError", "type": "object" } } }, "description": "The workflow request failed." } } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Delete a workflow", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "workflows.read-write" ] }, "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/get-workflows" }, "operationId": "rippling.rest_api.get_workflows", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "version_id", "required": false, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OutputRestApiWorkflowResourceb390faffbef6" } } }, "description": "Successful response" }, "403": { "description": "The workflow request failed.", "x-rippling-source-response": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "code": { "enum": [ "VALIDATION_ERROR", "INVALID_CURSOR", "WORKFLOW_NOT_FOUND", "WORKFLOW_FORBIDDEN", "WORKFLOW_VERSION_CONFLICT", "WORKFLOW_NOT_EDITABLE", "WORKFLOW_STATE_CONFLICT" ], "type": "string" }, "field_errors": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "field", "message" ], "title": "WorkflowFieldError", "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "title": "WorkflowError", "type": "object" } } }, "description": "The workflow request failed." } }, "404": { "description": "The workflow request failed.", "x-rippling-source-response": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "code": { "enum": [ "VALIDATION_ERROR", "INVALID_CURSOR", "WORKFLOW_NOT_FOUND", "WORKFLOW_FORBIDDEN", "WORKFLOW_VERSION_CONFLICT", "WORKFLOW_NOT_EDITABLE", "WORKFLOW_STATE_CONFLICT" ], "type": "string" }, "field_errors": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "field", "message" ], "title": "WorkflowFieldError", "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "title": "WorkflowError", "type": "object" } } }, "description": "The workflow request failed." } } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Retrieve a workflow", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "workflows.read" ] }, "patch": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/update-workflows" }, "operationId": "rippling.rest_api.update_workflows", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiWorkflowPatchInputebb57b89de10" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OutputRestApiWorkflowResourceb390faffbef6" } } }, "description": "Successful response" }, "400": { "description": "The workflow request failed.", "x-rippling-source-response": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "code": { "enum": [ "VALIDATION_ERROR", "INVALID_CURSOR", "WORKFLOW_NOT_FOUND", "WORKFLOW_FORBIDDEN", "WORKFLOW_VERSION_CONFLICT", "WORKFLOW_NOT_EDITABLE", "WORKFLOW_STATE_CONFLICT" ], "type": "string" }, "field_errors": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "field", "message" ], "title": "WorkflowFieldError", "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "title": "WorkflowError", "type": "object" } } }, "description": "The workflow request failed." } }, "403": { "description": "The workflow request failed.", "x-rippling-source-response": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "code": { "enum": [ "VALIDATION_ERROR", "INVALID_CURSOR", "WORKFLOW_NOT_FOUND", "WORKFLOW_FORBIDDEN", "WORKFLOW_VERSION_CONFLICT", "WORKFLOW_NOT_EDITABLE", "WORKFLOW_STATE_CONFLICT" ], "type": "string" }, "field_errors": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "field", "message" ], "title": "WorkflowFieldError", "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "title": "WorkflowError", "type": "object" } } }, "description": "The workflow request failed." } }, "404": { "description": "The workflow request failed.", "x-rippling-source-response": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "code": { "enum": [ "VALIDATION_ERROR", "INVALID_CURSOR", "WORKFLOW_NOT_FOUND", "WORKFLOW_FORBIDDEN", "WORKFLOW_VERSION_CONFLICT", "WORKFLOW_NOT_EDITABLE", "WORKFLOW_STATE_CONFLICT" ], "type": "string" }, "field_errors": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "field", "message" ], "title": "WorkflowFieldError", "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "title": "WorkflowError", "type": "object" } } }, "description": "The workflow request failed." } }, "409": { "description": "The workflow request failed.", "x-rippling-source-response": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "code": { "enum": [ "VALIDATION_ERROR", "INVALID_CURSOR", "WORKFLOW_NOT_FOUND", "WORKFLOW_FORBIDDEN", "WORKFLOW_VERSION_CONFLICT", "WORKFLOW_NOT_EDITABLE", "WORKFLOW_STATE_CONFLICT" ], "type": "string" }, "field_errors": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "field", "message" ], "title": "WorkflowFieldError", "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "title": "WorkflowError", "type": "object" } } }, "description": "The workflow request failed." } } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Update a workflow", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "workflows.read-write" ] } }, "/workflows/{id}/executions/": { "post": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/create-workflow-execution" }, "operationId": "rippling.rest_api.create_workflow_execution", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OutputRestApiWorkflowExecutionResource5317d9bed647" } } }, "description": "Successful response" }, "400": { "description": "The workflow execution request failed.", "x-rippling-source-response": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "code": { "enum": [ "VALIDATION_ERROR", "WORKFLOW_NOT_FOUND", "WORKFLOW_STATE_CONFLICT", "WORKFLOW_EXECUTION_UNSUPPORTED_TRIGGER", "WORKFLOW_EXECUTION_NOT_FOUND" ], "type": "string" }, "field_errors": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "field", "message" ], "title": "WorkflowFieldError", "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "title": "WorkflowExecutionError", "type": "object" } } }, "description": "The workflow execution request failed." } }, "403": { "description": "The workflow execution request failed.", "x-rippling-source-response": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "code": { "enum": [ "VALIDATION_ERROR", "WORKFLOW_NOT_FOUND", "WORKFLOW_STATE_CONFLICT", "WORKFLOW_EXECUTION_UNSUPPORTED_TRIGGER", "WORKFLOW_EXECUTION_NOT_FOUND" ], "type": "string" }, "field_errors": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "field", "message" ], "title": "WorkflowFieldError", "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "title": "WorkflowExecutionError", "type": "object" } } }, "description": "The workflow execution request failed." } }, "404": { "description": "The workflow execution request failed.", "x-rippling-source-response": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "code": { "enum": [ "VALIDATION_ERROR", "WORKFLOW_NOT_FOUND", "WORKFLOW_STATE_CONFLICT", "WORKFLOW_EXECUTION_UNSUPPORTED_TRIGGER", "WORKFLOW_EXECUTION_NOT_FOUND" ], "type": "string" }, "field_errors": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "field", "message" ], "title": "WorkflowFieldError", "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "title": "WorkflowExecutionError", "type": "object" } } }, "description": "The workflow execution request failed." } }, "409": { "description": "The workflow execution request failed.", "x-rippling-source-response": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "code": { "enum": [ "VALIDATION_ERROR", "WORKFLOW_NOT_FOUND", "WORKFLOW_STATE_CONFLICT", "WORKFLOW_EXECUTION_UNSUPPORTED_TRIGGER", "WORKFLOW_EXECUTION_NOT_FOUND" ], "type": "string" }, "field_errors": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "field", "message" ], "title": "WorkflowFieldError", "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "title": "WorkflowExecutionError", "type": "object" } } }, "description": "The workflow execution request failed." } } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Execute a workflow", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "workflow-executions.read-write" ] } }, "/workflows/{id}/executions/{execution_id}/": { "get": { "externalDocs": { "url": "https://developer.rippling.com/documentation/rest-api/reference/get-workflow-execution" }, "operationId": "rippling.rest_api.get_workflow_execution", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "execution_id", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Rippling-Api-Version", "required": true, "schema": { "const": "2024-08-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OutputRestApiWorkflowExecutionResource5317d9bed647" } } }, "description": "Successful response" }, "403": { "description": "The workflow execution request failed.", "x-rippling-source-response": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "code": { "enum": [ "VALIDATION_ERROR", "WORKFLOW_NOT_FOUND", "WORKFLOW_STATE_CONFLICT", "WORKFLOW_EXECUTION_UNSUPPORTED_TRIGGER", "WORKFLOW_EXECUTION_NOT_FOUND" ], "type": "string" }, "field_errors": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "field", "message" ], "title": "WorkflowFieldError", "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "title": "WorkflowExecutionError", "type": "object" } } }, "description": "The workflow execution request failed." } }, "404": { "description": "The workflow execution request failed.", "x-rippling-source-response": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "code": { "enum": [ "VALIDATION_ERROR", "WORKFLOW_NOT_FOUND", "WORKFLOW_STATE_CONFLICT", "WORKFLOW_EXECUTION_UNSUPPORTED_TRIGGER", "WORKFLOW_EXECUTION_NOT_FOUND" ], "type": "string" }, "field_errors": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "field", "message" ], "title": "WorkflowFieldError", "type": "object" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "title": "WorkflowExecutionError", "type": "object" } } }, "description": "The workflow execution request failed." } } }, "servers": [ { "description": "production", "url": "https://rest.ripplingapis.com" }, { "description": "sandbox", "url": "https://rest.ripplingpreviewapis.com" } ], "summary": "Retrieve a workflow execution", "x-rippling-entitlements": [ "API_Tier_1" ], "x-rippling-required-scopes": [ "workflow-executions.read", "workflow-executions.read-write" ] } } } }